CLI Types

Type definitions for the CLI application.

class oduit.cli_types.OutputFormat(*values)

Bases: str, Enum

Output format options.

TEXT = 'text'

JSON = 'json'

class oduit.cli_types.AddonTemplate(*values)

Bases: str, Enum

Available addon templates.

BASIC = 'basic'

WEBSITE = 'website'

class oduit.cli_types.ShellInterface(*values)

Bases: str, Enum

Available shell interfaces.

IPYTHON = 'ipython'

PTPYTHON = 'ptpython'

BPYTHON = 'bpython'

PYTHON = 'python'

class oduit.cli_types.SortingChoice(*values)

Bases: str, Enum

Sorting options for addon lists.

ALPHABETICAL = 'alphabetical'

TOPOLOGICAL = 'topological'

class oduit.cli_types.DevFeature(*values)

Bases: str, Enum

Development features for –dev option.

For development purposes only. Do not use in production.

ALL = 'all'

XML = 'xml'

RELOAD = 'reload'

QWEB = 'qweb'

IPDB = 'ipdb'

PDB = 'pdb'

PUDB = 'pudb'

WERKZEUG = 'werkzeug'

class oduit.cli_types.LogLevel(*values)

Bases: str, Enum

Odoo log levels.

INFO = 'info'

DEBUG = 'debug'

WARN = 'warn'

ERROR = 'error'

CRITICAL = 'critical'

class oduit.cli_types.GlobalConfig(env: str | None = None, non_interactive: bool = False, format: OutputFormat = OutputFormat.TEXT, verbose: bool = False, no_http: bool = False, env_config: dict[str, Any] | None = None, env_name: str | None = None, odoo_series: OdooSeries | None = None, config_source: str | None = None, config_path: str | None = None)

Bases: object

Global configuration context for commands.

env: str | None = None

non_interactive: bool = False

format: OutputFormat = 'text'

verbose: bool = False

no_http: bool = False

env_config: dict[str, Any] | None = None

env_name: str | None = None

odoo_series: OdooSeries | None = None

config_source: str | None = None

config_path: str | None = None

__init__(env: str | None = None, non_interactive: bool = False, format: OutputFormat = OutputFormat.TEXT, verbose: bool = False, no_http: bool = False, env_config: dict[str, Any] | None = None, env_name: str | None = None, odoo_series: OdooSeries | None = None, config_source: str | None = None, config_path: str | None = None) → None

class oduit.cli_types.CommandResult(success: bool, message: str | None = None, exit_code: int = 0, data: dict[str, Any] | None = None)

Bases: object

Result of a command execution.

success: bool

message: str | None = None

exit_code: int = 0

data: dict[str, Any] | None = None

__init__(success: bool, message: str | None = None, exit_code: int = 0, data: dict[str, Any] | None = None) → None

Enumerations

class oduit.cli_types.OutputFormat(*values)

Bases: str, Enum

Output format options.

TEXT = 'text'

JSON = 'json'

class oduit.cli_types.AddonTemplate(*values)

Bases: str, Enum

Available addon templates.

BASIC = 'basic'

WEBSITE = 'website'

class oduit.cli_types.ShellInterface(*values)

Bases: str, Enum

Available shell interfaces.

IPYTHON = 'ipython'

PTPYTHON = 'ptpython'

BPYTHON = 'bpython'

PYTHON = 'python'

Data Classes

class oduit.cli_types.GlobalConfig(env: str | None = None, non_interactive: bool = False, format: OutputFormat = OutputFormat.TEXT, verbose: bool = False, no_http: bool = False, env_config: dict[str, Any] | None = None, env_name: str | None = None, odoo_series: OdooSeries | None = None, config_source: str | None = None, config_path: str | None = None)

Bases: object

Global configuration context for commands.

env: str | None = None

non_interactive: bool = False

format: OutputFormat = 'text'

verbose: bool = False

no_http: bool = False

env_config: dict[str, Any] | None = None

env_name: str | None = None

odoo_series: OdooSeries | None = None

config_source: str | None = None

config_path: str | None = None

__init__(env: str | None = None, non_interactive: bool = False, format: OutputFormat = OutputFormat.TEXT, verbose: bool = False, no_http: bool = False, env_config: dict[str, Any] | None = None, env_name: str | None = None, odoo_series: OdooSeries | None = None, config_source: str | None = None, config_path: str | None = None) → None

class oduit.cli_types.CommandResult(success: bool, message: str | None = None, exit_code: int = 0, data: dict[str, Any] | None = None)

Bases: object

Result of a command execution.

success: bool

message: str | None = None

exit_code: int = 0

data: dict[str, Any] | None = None

__init__(success: bool, message: str | None = None, exit_code: int = 0, data: dict[str, Any] | None = None) → None