• Файл манифеста

Оригинал на GitHub

Файл манифеста

Файл манифеста служит для объявления пакета python в качестве модуля Odoo и для указания метаданных модуля.

Это файл под названием __openerp__.py и содержит один словарь Python, в котором каждый ключ определяет метаданные модуля.

{
    'name': "A Module",
    'version': '1.0',
    'depends': ['base'],
    'author': "Author Name",
    'category': 'Category',
    'description': """
    Description text
    """,
    # data files always loaded at installation
    'data': [
        'mymodule_view.xml',
    ],
    # data files containing optionally loaded demonstration data
    'demo': [
        'demo_data.xml',
    ],
}

Доступные поля манифеста:

name (str, обязательное)

удобочитаемое имя модуля

version (str)

Версия этого модуля должна соответствовать правилам semantic versioning

description (str)

Расширенное описание модуля, в формате reStructuredText

author (str)

Имя автора модуля

website (str)

URL веб-сайта автора модуля

license (str, по-умолчанию: AGPL-3)

Лицензия на распространение для модуля

category (str, по умолчанию: Uncategorized)

Категория классификации в Odoo, примерная область применения модуля.

Рекомендуется использовать existing categories. Если введена произвольная категория, которой не существует, она создастся «на лету». Иерархия категорий может быть создана с использованием разделителя /, например Foo / Bar создаст категорию Foo, категорию Bar в качестве дочерней категории Foo, и установит Bar, как категорию модуля.

depends (list(str))

Модули Odoo, которые должны быть загружены для работы данного модуля, либо потому, что этот модуль использует их функции, либо потому, что он изменяет ресурсы, которые они определяют.

Когда модуль установлен, все его зависимости устанавливаются перед ним. Аналогично, зависимости загружаются до загрузки модуля.

data (list(str))

Список файлов данных, которые необходимо всегда устанавливать или обновлять с помощью модуля. Список путей из корневого каталога модуля.

demo (list(str))

Список файлов данных, которые устанавливаются или обновляется только в демонстрационном режиме.

auto_install (bool, по умолчанию: False)

Если значение True, этот модуль будет автоматически установлен, если все его зависимости установлены.

Он обычно используется для «связующих модулей», реализующих синергетическую интеграцию между двумя независимыми друг от друга модулями.

Например, sale_crm зависит от sale и crm и имеет значение auto_install. Когда установлены как sale, так и crm, он автоматически добавляет к заказам на продажу отслеживание кампаний CRM.