Builders

The builders module contains the structured command builders used by OdooOperations and ProcessManager.

New builder pattern implementation for command construction. Provides proper separation of concerns and fluent interfaces.

class oduit.builders.CommandOperation(command: list[str], operation_type: str, database: str | None = None, modules: list[str] = <factory>, test_tags: str | None = None, extra_args: list[str] = <factory>, is_odoo_command: bool = True, expected_result_fields: dict[str, ~typing.Any] = <factory>, result_parsers: list[str] = <factory>)

Bases: object

Structured command operation containing both command and metadata.

command: list[str]

operation_type: str

database: str | None = None

modules: list[str]

test_tags: str | None = None

extra_args: list[str]

is_odoo_command: bool = True

expected_result_fields: dict[str, Any]

result_parsers: list[str]

__init__(command: list[str], operation_type: str, database: str | None = None, modules: list[str] = <factory>, test_tags: str | None = None, extra_args: list[str] = <factory>, is_odoo_command: bool = True, expected_result_fields: dict[str, ~typing.Any] = <factory>, result_parsers: list[str] = <factory>) → None

class oduit.builders.AbstractCommandBuilder(config_provider: ConfigProvider)

Bases: ABC

Abstract base class for command builders following the Builder pattern

__init__(config_provider: ConfigProvider)

abstractmethod build() → list[str]

Build and return the final command as a list of strings

abstractmethod build_operation() → CommandOperation

Build and return a structured CommandOperation with metadata

abstractmethod reset() → None

Reset the builder to initial state for reuse

class oduit.builders.BaseOdooCommandBuilder(config_provider: ConfigProvider)

Bases: AbstractCommandBuilder

Base Odoo command builder with common functionality

__init__(config_provider: ConfigProvider)

disable_http() → BaseOdooCommandBuilder

Disable all HTTP-related options and enable –no-http.

database(db_name: str) → BaseOdooCommandBuilder

Set database name

addons_path(path: str) → BaseOdooCommandBuilder

Set addons path

load(modules: str) → BaseOdooCommandBuilder

Set list of server-wide modules to load.

log_level(level: str) → BaseOdooCommandBuilder

Set log level (info, warn, error, debug)

log_handler(handler: str) → BaseOdooCommandBuilder

Set LOGGER:LEVEL, enables LOGGER at the provided LEVEL

log_web(enabled: bool = True) → BaseOdooCommandBuilder

enables DEBUG logging of HTTP requests and responses

log_sql(enabled: bool = True) → BaseOdooCommandBuilder

enables DEBUG logging of SQL querying

syslog(enabled: bool = True) → BaseOdooCommandBuilder

Enable: logs to the system’s event logger

db_maxconn(maxconn: int) → BaseOdooCommandBuilder

Set maximum number of database connections

db_maxconn_gevent(maxconn: int) → BaseOdooCommandBuilder

Set maximum number of database connections

db_user(user: str) → BaseOdooCommandBuilder

Set database user

db_password(password: str) → BaseOdooCommandBuilder

Set database password

db_host(hostname: str) → BaseOdooCommandBuilder

Set database host

db_filter(filter: str) → BaseOdooCommandBuilder

Set database filter

db_template(template: str) → BaseOdooCommandBuilder

Set database template

http_port(port: int) → BaseOdooCommandBuilder

Set HTTP port

gevent_port(port: int) → BaseOdooCommandBuilder

Set GEVENT port

workers(workers: int) → BaseOdooCommandBuilder

Set workers

limit_request(limit: int) → BaseOdooCommandBuilder

Set limit-request

limit_memory_soft(limit: int) → BaseOdooCommandBuilder

Set limit-memory-soft

limit_memory_hard(limit: int) → BaseOdooCommandBuilder

Set limit-memory-hard

limit_time_cpu(limit: int) → BaseOdooCommandBuilder

Set limit-time-cpu

limit_time_real(limit: int) → BaseOdooCommandBuilder

Set limit-time-real

max_cron_threads(threads: int) → BaseOdooCommandBuilder

Set max-cron-threads

limit_time_worker_cron(limit: int) → BaseOdooCommandBuilder

Set limit-time-worker-cron

http_interface(interface: str) → BaseOdooCommandBuilder

Set http interface

data_dir(path: str) → BaseOdooCommandBuilder

Set data directory

config_file(path: str) → BaseOdooCommandBuilder

Set config file path

dev(features: str = 'all') → BaseOdooCommandBuilder

Enable dev mode with specified features

load_language(languages: str) → BaseOdooCommandBuilder

specifies the languages (separated by commas) for the translations

language(language: str) → BaseOdooCommandBuilder

Set the language of the translation file use it with i18n-export or i18n-import

i18n_export(filename: str) → BaseOdooCommandBuilder

Set i18n export filename

i18n_import(filename: str) → BaseOdooCommandBuilder

Set i18n import filename

i18n_overwrite(enabled: bool = True) → BaseOdooCommandBuilder

Enable i18n overwrite

modules(modules: str) → BaseOdooCommandBuilder

Set list of modules to export

no_http(enabled: bool = True) → BaseOdooCommandBuilder

Disable HTTP server

proxy_mode(enabled: bool = True) → BaseOdooCommandBuilder

Enables HTTP proxy

stop_after_init(enabled: bool = True) → BaseOdooCommandBuilder

Stop after module initialization

install_module(module: str) → BaseOdooCommandBuilder

Install a module

update_module(module: str) → BaseOdooCommandBuilder

Update a module

shell_interface(interface: str) → BaseOdooCommandBuilder

Set shell interface (ipython, ptpython, bpython, python)

without_demo(modules: str) → BaseOdooCommandBuilder

Disable demo data for specified modules

with_demo(enabled: bool = True) → BaseOdooCommandBuilder

Install module with demo data

reset() → None

Reset builder to initial state

build() → list[str]

Build the final command list

build_operation() → CommandOperation

Build a CommandOperation with base metadata. Subclasses should override.

class oduit.builders.RunCommandBuilder(config_provider: ConfigProvider)

Bases: BaseOdooCommandBuilder

Specialized builder for run commands

__init__(config_provider: ConfigProvider)

build_operation() → CommandOperation

Build a CommandOperation with base metadata. Subclasses should override.

class oduit.builders.OdooTestCoverageCommandBuilder(config_provider: ConfigProvider, module: str)

Bases: BaseOdooCommandBuilder

Specialized builder for test commands with coverage

__init__(config_provider: ConfigProvider, module: str)

test_module(module: str, install: bool = False) → OdooTestCoverageCommandBuilder

Configure module testing

test_file(file_path: str) → OdooTestCoverageCommandBuilder

Set specific test file

test_tags(tags: str) → OdooTestCoverageCommandBuilder

Set test tags filter

build_operation() → CommandOperation

Build a CommandOperation with base metadata. Subclasses should override.

class oduit.builders.OdooTestCommandBuilder(config_provider: ConfigProvider)

Bases: BaseOdooCommandBuilder

Specialized builder for test commands

__init__(config_provider: ConfigProvider)

test_module(module: str, install: bool = False) → OdooTestCommandBuilder

Configure module testing

test_file(file_path: str) → OdooTestCommandBuilder

Set specific test file

test_tags(tags: str) → OdooTestCommandBuilder

Set test tags filter

build_operation() → CommandOperation

Build a CommandOperation with base metadata. Subclasses should override.

class oduit.builders.ShellCommandBuilder(config_provider: ConfigProvider)

Bases: BaseOdooCommandBuilder

Specialized builder for shell commands

__init__(config_provider: ConfigProvider)

build_operation() → CommandOperation

Build a CommandOperation with base metadata. Subclasses should override.

class oduit.builders.UpdateCommandBuilder(config_provider: ConfigProvider, module: str)

Bases: BaseOdooCommandBuilder

Specialized builder for update commands

__init__(config_provider: ConfigProvider, module: str)

build_operation() → CommandOperation

Build a CommandOperation with base metadata. Subclasses should override.

class oduit.builders.InstallCommandBuilder(config_provider: ConfigProvider, module: str)

Bases: BaseOdooCommandBuilder

Specialized builder for install commands

__init__(config_provider: ConfigProvider, module: str)

build_operation() → CommandOperation

Build a CommandOperation with base metadata. Subclasses should override.

class oduit.builders.LanguageCommandBuilder(config_provider: ConfigProvider, module: str, filename: str, language: str)

Bases: BaseOdooCommandBuilder

Specialized builder for language export commands

__init__(config_provider: ConfigProvider, module: str, filename: str, language: str)

build_operation() → CommandOperation

Build a CommandOperation with base metadata. Subclasses should override.

class oduit.builders.VersionCommandBuilder(config_provider: ConfigProvider)

Bases: BaseOdooCommandBuilder

Specialized builder for version command

__init__(config_provider: ConfigProvider)

build_operation() → CommandOperation

Build a CommandOperation with base metadata. Subclasses should override.

class oduit.builders.DatabaseCommandBuilder(config_provider: ConfigProvider, with_sudo: bool = True)

Bases: AbstractCommandBuilder

Builder for database-related commands

__init__(config_provider: ConfigProvider, with_sudo: bool = True)

drop_command() → DatabaseCommandBuilder

Build database drop command

create_role_command(db_user: str | None = None) → DatabaseCommandBuilder

Build database create role command

create_extension_command(extension: str) → DatabaseCommandBuilder

Build database create role command

alter_role_command(db_user: str | None = None) → DatabaseCommandBuilder

Build database alter role command to add login and createdb privileges

create_command(db_user: str | None = None) → DatabaseCommandBuilder

Build database create command

legacy_init_base_command(*, with_demo: bool = False, without_demo: bool = False, language: str | None = None) → DatabaseCommandBuilder

Build legacy-compatible Odoo server init command for base installation.

native_db_init_command(*, with_demo: bool = False, without_demo: bool = False, country: str | None = None, language: str | None = None, username: str = 'admin', password: str = 'admin', force: bool = False) → DatabaseCommandBuilder

Build native Odoo 19+ db init command.

init_command(*, with_demo: bool = False, without_demo: bool = False, country: str | None = None, language: str | None = None) → DatabaseCommandBuilder

Backward-compatible wrapper for legacy base initialization.

list_db_command(db_user: str | None = None) → DatabaseCommandBuilder

Build database list command

exists_db_command(db_user: str | None = None) → DatabaseCommandBuilder

Build database exists check command

reset() → None

Reset builder to initial state

build() → list[str]

Build the final command list

build_operation() → CommandOperation

Build and return a structured CommandOperation with metadata

Usage Examples

from oduit import ConfigLoader, ProcessManager
from oduit.builders import InstallCommandBuilder, OdooTestCommandBuilder

loader = ConfigLoader()
config = loader.load_config("dev")
manager = ProcessManager()

install_operation = InstallCommandBuilder(config, "sale").build_operation()
install_result = manager.run_operation(install_operation, verbose=True)

test_operation = OdooTestCommandBuilder(config).test_tags("/sale").build_operation()
test_result = manager.run_operation(test_operation)

Key Concepts

• build() returns a plain command list for compatibility

• build_operation() returns a structured CommandOperation

• the structured form carries metadata such as operation type, modules, and parser hints for downstream result processing