Skip to content

OdooModule and OdooModuleManifest API

odoo_project.OdooModule(path: Path)

Represents an Odoo module directory.

Designed to work with module files, including the manifest, data, and translations. The implementation is independent of the Odoo version, does not import odoo, and does not rely on Odoo code.

path: Path = path instance-attribute

Module dir path

name: str = path.name instance-attribute

Module dir name aka Technical name

manifest: OdooModuleManifest cached property

Returns parsed manifest object

readme_path: Path | None cached property

Returns first of existing files or None:

  1. README.rst
  2. README.md
  3. README.txt
  4. README

icon_path: str cached property

Returns first available option:

  1. Manifest icon value if it is specified.
  2. /<module>/static/description/icon.png if file exists.
  3. Fallback to /base/static/description/icon.png.

dependencies: frozenset[str] cached property

Returns manifest depends wrapped into frozenset. Adds base if it's empty.

is_auto_install: bool cached property

Returns True if manifest auto_install is True or Iterable.

auto_install_depends: frozenset[str] cached property

Return frozenset depends on manifest auto_install value. If it's True returns self.dependencies. If it's False returns empty set. If it's list returns frozenset of its values.

__truediv__(path: Path | str) -> Path

Returns the path relative to the module directory.

odoo_project.OdooModuleManifest

A wrapper around the values of an Odoo module manifest file.

Designed for convenient access to manifest values without computing certain fields as Odoo does. It exposes all known manifest fields as class attributes. Missing values are automatically populated with defaults, empty lists, empty dicts, or None.

name: str instance-attribute

version: str = '1.0' class-attribute instance-attribute

summary: str | None = None class-attribute instance-attribute

description: str | None = None class-attribute instance-attribute

website: str | None = None class-attribute instance-attribute

license: str = 'LGPL-3' class-attribute instance-attribute

category: str = 'Uncategorized' class-attribute instance-attribute

sequence: int = 100 class-attribute instance-attribute

icon: str | None = None class-attribute instance-attribute

author: str | None = None class-attribute instance-attribute

contributors: str | None = None class-attribute instance-attribute

maintainer: str | None = None class-attribute instance-attribute

installable: bool = True class-attribute instance-attribute

application: bool = False class-attribute instance-attribute

depends: list[str] = Factory(list) class-attribute instance-attribute

auto_install: bool | list[str] = False class-attribute instance-attribute

external_dependencies: dict | None = Factory(dict) class-attribute instance-attribute

data: list[str] = Factory(list) class-attribute instance-attribute

demo: list[str] = Factory(list) class-attribute instance-attribute

assets: dict[str, list[str]] = Factory(dict) class-attribute instance-attribute

pre_init_hook: str | None = None class-attribute instance-attribute

post_init_hook: str | None = None class-attribute instance-attribute

uninstall_hook: str | None = None class-attribute instance-attribute

post_load: str | None = None class-attribute instance-attribute

iap_paid_service: bool = False class-attribute instance-attribute

countries: list[str] = Factory(list) class-attribute instance-attribute

images: list[str] = Factory(list) class-attribute instance-attribute

configurator_snippets: dict[str, list[str]] = Factory(dict) class-attribute instance-attribute

configurator_snippets_addons: dict[str, dict] = Factory(dict) class-attribute instance-attribute

theme_customizations: dict[str, dict] = Factory(dict) class-attribute instance-attribute

url: str | None = None class-attribute instance-attribute

other_files: list[str] = Factory(list) class-attribute instance-attribute

kpi_providers: list[str] = Factory(list) class-attribute instance-attribute

bootstrap: bool = False class-attribute instance-attribute

new_page_templates: dict[str, dict] = Factory(dict) class-attribute instance-attribute

from_path(path: Path) classmethod

Read values from directory __manifest__.py file.