モジュールマニフェスト数¶

マニフェスト¶

マニフェストファイルは、PythonパッケージをOdooモジュールとして宣言し、モジュールメタデータを指定するのに役立ちます。

これは `__manifest__.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': [
        'views/mymodule_view.xml',
    ],
    # data files containing optionally loaded demonstration data
    'demo': [
        'demo/demo_data.xml',
    ],
}

利用可能なマニフェストフィールドは次のとおりです。

name (str, required)

人が読めるモジュール名

version (str)

このモジュールのバージョンは semantic versioning 規則に従う必要があります

description (str)

reStructuredText モジュールの拡張説明

author (str)

モジュール作成者の名前

website (str)

ウェブサイトURL for the module author

license (str, defaults: LGPL-3)

モジュールのディストリビューションライセンス。可能な値:

GPL-2
GPL-2 以降のバージョン
GPL-3
GPL-3 またはそれ以降のバージョン
AGPL-3
LGPL-3
その他のOSI承認ライセンス
OEEL-1 (Odoo Enterprise Edition License v1.0)
OPL-1 (Odoo Proprietary License v1.0)
その他の所有

category (str, default: Uncategorized)

Odoo内の分類カテゴリ、モジュールのラフなビジネスドメイン。

existing categories を使用することをお勧めしますが、このフィールドは自由形式で、未知のカテゴリはオンザフライで作成されます。セパレーター / eを使用してカテゴリ階層を作成できます。をクリックします。 Foo / Bar は、Foo カテゴリ、Bar を子カテゴリとして作成し、Bar をモジュールのカテゴリとして設定します。

depends (list(str))

Odoo モジュールは、このモジュールより前にロードする必要があります。このモジュールは、作成された機能を使用するか、定義されたリソースを変更するためです。

モジュールがインストールされると、その前にすべての依存関係がインストールされます。モジュールがロードされる前に同様の依存関係がロードされます。

注釈

モジュール`base`は常にOdooインスタンスにインストールされています。しかし、base が更新されたときにモジュールが更新されていることを確認するために、依存関係として指定する必要があります。

data (list(str))

常にモジュールを使用してインストールまたは更新する必要があるデータファイルのリストです。モジュールのルートディレクトリからのパスのリスト

demo (list(str))

デモモード でのみインストールまたは更新されたデータファイルの一覧

auto_install (bool または list(str), default: False)

True の場合、全ての依存関係がインストールされている場合、このモジュールは自動的にインストールされます。

一般的には、2つの独立したモジュール間の相乗効果を実現する「リンクモジュール」に使用されます。

例えば、sale_crm は sale と crm の両方に依存し、auto_install に設定されます。 sale と crm の両方がインストールされている場合 sale または crm のいずれかを認識せずに、CRMキャンペーンを販売注文に自動的に追加します。

リストの場合は、依存関係のサブセットを含める必要があります。このモジュールは、サブセット内のすべての依存関係がインストールされるとすぐに自動的にインストールされます。残りの依存関係も自動的にインストールされます。リストが空の場合、このモジュールは依存関係なく常に自動的にインストールされ、これらも同様にインストールされます。

external_dependencies (dict(key=list(str)))

Python やバイナリの依存関係を含む辞書。

Python の依存関係のために。この辞書には``python`` キーが定義されており、インポートするPythonモジュールのリストが割り当てられている必要があります。

バイナリ依存の場合は、この辞書に bin キーを定義し、バイナリ実行ファイル名のリストを割り当てる必要があります。

Python モジュールがホストマシンにインストールされていないか、ホストマシンの PATH 環境変数内にバイナリ実行可能ファイルが見つからない場合、モジュールはインストールされません。

application (bool, default: False)

モジュールを本格的なアプリケーション (True ) とみなすか、既存のアプリケーションモジュールに追加機能を提供する単なるテクニカルモジュール (False ) であるかどうか。

assets (dict)

すべての静的ファイルがさまざまなアセットバンドルにロードされる方法の定義。バンドルの説明方法については、 assets を参照してください。

installable (bool default: True )

ユーザがWeb UIからモジュールをインストールできるかどうか。

maintainer (str)

このモジュールのメンテナンスを担当する担当者またはエンティティは、デフォルトでは、作成者がメンテナであると想定されます。

{pre_init, post_init, uninstall}_hook (str)

モジュールのインストール/アンインストールのためのフックは、その値はモジュールの __init__.py` 内で定義された関数の名前を表す文字列でなければなりません。

pre_init_hook はカーソルを唯一の引数として取ります。この関数はモジュールのインストール前に実行されます。

post_init_hook はカーソルとレジストリを引数として取り、この関数はモジュールのインストール直後に実行されます。

uninstall_hook はカーソルとレジストリを引数として取り、この関数はモジュールのアンインストール後に実行されます。

これらのフックは、このモジュールの setup/cleanup が要求される場合にのみ、 API を通して極めて困難であるか、不可能であるかのどちらかで使用すべきです。

active (bool)

非推奨です。auto_install に置き換えられます。