Odoo安裝教程3-創建新的插件模塊第二講

創建模塊目錄和聲明文件

現在就準備好了~/odoo-dev/custom-addons 目錄,已正確添加至 addons 路徑,Odoo 也就可以找到這裏的模塊。Odoo 自帶一個 scaffold 命令可自動創建新模塊目錄,其中會包含基礎
結構。此處並不會使用該命令,而是手動創建。通過以下命令可以瞭解 scaffold 用法:
~/odoo-dev/odoo/odoo-bin scaffold --help
Odoo 模塊目錄需包含一個__manifest__.py 描述性文件,同時還需要是可導入的包,所以還應包含__init__.py 文件。
“ 小貼士:在老版本中,該描述性文件爲__openerp__.py 或__odoo__.py,這些名稱已過時但仍可使用。”

模塊目錄名是其技術名稱,我們使用 library_app,技術名稱應是有效 Python 標識符,即以字母開頭且僅能包含字母、數字和下劃線。執行如下步驟來初始化新模塊:
1、通過命令行,我們可以添加一個空的__init__.py 文件來初始化模塊:
mkdir -p ~/odoo-dev/custom-addons/library_app
touch ~/odoo-dev/custom-addons/library_app/__init__.py
2、下面添加聲明文件,其中應包含一個 Python 字典,有幾十個可用屬性。其中僅 name 屬性爲必填,但推薦同時添加 description 和 author 屬性。在__init__.py 同級創建
__manifest__.py 文件,添加以下內容:
{
'name': 'Library Management',
'description': 'Manage library book catalogue and lending.',
'author': 'www.oscg.cn',
'depends': ['base'],
'application': True,
}
depends 屬性可以是一個包含所用到的模塊列表。Odoo 會在模塊安裝時自動安裝這些模塊,這不是強制屬性,但建議使用。如果沒有特別的依賴,可以添加內核 base 模塊。應注意將所有依賴都在此處列明,否則,模塊會因缺少依賴而報錯或出現加載錯誤(如果碰巧依賴模塊在隨後被加載了)。
我們的應用無需依賴其它模塊,所以本處使用了 base。爲保持簡潔,這裏僅使用了幾個基本描述符鍵:
⚫ name:插件模塊標題字符串
⚫ description:功能描述長文件,通常爲 RST 格式
⚫ author:作者姓名,本處爲一個字符串,可以是逗號分隔的一系列姓名
⚫ depends:一個依賴插件模塊列表,在模塊安裝時會先安裝這些插件
⚫ application:一個布爾型標記,代表模塊是否在應用列表中以 app 展現
description 可由模塊頂層目錄中的 README.rst 或 README.md 代替,如果兩者都不存在,將使用聲明文件中的 description。在真實場景中,建議也同時使用其它屬性名,因它們與 Odoo 的應用商店有關:
⚫ summary:顯示爲模塊副標題的字符串
⚫ version::默認爲 1.0,應遵守版本號規則。建議在模塊版本號前加上 Odoo 版本,如
12.0.1.0
⚫ license::默認爲 LGPL-3
⚫ website:瞭解模塊更多信息的 URL,可以幫助人們查看更多文檔或提供文件 bug 和建議的
跟蹤
⚫ category::帶有模塊功能性分類字符串,缺省爲 Uncategorized。已有分類可通過安全組表
單(位於 Settings > Users & Companies > Groups)的 Application 字段下拉列表查看
(需開啓調試模式)
還有以下描述符鍵:
⚫ installable:默認爲 True,但可以通過設置爲 False 來禁用模塊
⚫ auto_install:若設置爲 True,在其依賴已安裝時會自動安裝,用於膠水模塊,用於同一實例上兩個模塊安裝後功能的連接。

更多教程:https://www.erpdaxue.cn/odoo/odoo-teach/

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章