开发模块

介绍

Here you will find information about the organisation of the community in OpenERP project. It includes a description of the different tools used, the role of the different actors, and the different process for improvement management.

The whole organisation is managed through our launchpad projects: http://launchpad.net Our projects on launchpad are currently organised like this:

Project name URL Description
openobject https://launchpad.net/openobject the main super-project (group) where all bugs, features and faq are managed
openobject-addons https://launchpad.net/openobject-addons the project for core OpenERP modules
openobject-server https://launchpad.net/openobject-server the OpenERP server
openerp-web https://launchpad.net/openerp-web the web client for OpenERP 6.1 and newer versions
openobject-client https://launchpad.net/openobject-client the native client (gtk) for OpenERP 6.1 and earlier
openobject-client-web https://launchpad.net/openobject-client-web the web client for OpenERP 6.0 and earlier versions

获取源码

Please refer to 怎么获取最新的代码 in the Bazaar section

If you don’t know the Bazaar version control system, please read the documentation on Bazaar

社区模块

OpenERP modules developed by the community were historically published in a shared source code branch on Launchpad, nicknamed extra-addons: https://code.launchpad.net/~openerp-commiter/openobject-addons/trunk-extra-addons

As of 2012 and the release of OpenERP 6.1, this shared branch is being phased out, due to several downsides to this organization, such as:

  • difficult to enforce access control on the modules (commit right is all or nothing)
  • difficult to enforce quality (therefore impossible to rely on it for customer projects)
  • commit history mixes all modules
  • download/checkout of the branch requires to fetch all modules at once

A better organization was discussed on the OpenERP mailing-lists, with the following goals:

  • To get rid of the big extra-addons branch
  • To join efforts on the same topic in order to avoid too many modules for a same feature
  • To become more aware of the developments that have been done by others
  • To start working with merge proposal between us
  • To improve the quality of our code

The community modules have therefore been split into separate Launchpad project and their respective branches. When possible, existing ones were reused. All listed projects provide a short description of the kind of modules you can find/merge into.

The community welcomes everyone on board to join efforts! In order to add your own modules in the appropriate project, you should use merge proposals. Depending on the volume, some time might be needed at the beginning to review everything. So thank you all in advance for your patience during this transition period.

For all of these projects, the rules we expect you to adhere to and respect are:

  • No company-related prefix or suffix in the module names (like c2c-account-something);
  • Always make merge proposal for any bugfix or improvement so that everyone can take note of it and eventually ask for a different approach;
  • Nobody merge his/her own work into the branch. Another member of the team must do it. Exceptions may be accepted if the merge proposal has been strongly approved by the rest of the team;
  • If your module doesn’t fit into any of the available projects, or you found no related team, please post a request on the framework expert mailing list so that we can create a specific one for you;
  • When at least one of your modules has been approved in the branch, you may ask to be part of the team. If you are not part of the team, you can still contribute to the project through merge proposals;
  • Use the available teams (see 社区贡献团队 section) according to their topics (it means that you always need to attribute a new project to these teams, so as to avoid having hundreds of them).

Should you have any suggestions related to the above rules, please feel free to post them on the framework expert mailing list.

Community Projects

The list of the official community projects/topics can be found under this project group: https://launchpad.net/openobject, and is summarized below.

Some of them are waiting on their owner to bring some modifications so they can fit into other projects (changing team, series,...). Should you be one of these owners, please inform the others on the mailing-list when ready. If some refuse to open the projects to the community, it is always possibel to create another project.

其他规则

模块

模块中的文件组织

The structure of a module should be:

/module_name/
/module_name/__init__.py
/module_name/__openerp__.py
/module_name/i18n
/module_name/i18n/module_name.pot
/module_name/images/
/module_name/images/screenshot.png
/module_name/migrations
/module_name/module.py
/module_name/module_view.xml
/module_name/module_wizard.xml
/module_name/module_report.xml
/module_name/module_data.xml
/module_name/module_demo.xml
/module_name/module_security.xml
/module_name/wizard/
/module_name/wizard/__init__.py
/module_name/wizard/wizard_name.py
/module_name/wizard/wizard_name_view.xml
/module_name/wizard/wizard_name_workflow.xml
/module_name/report/
/module_name/report/__init__.py
/module_name/report/report_name.sxw
/module_name/report/report_name.rml
/module_name/report/report_name.py
/module_name/security
/module_name/security/ir.model.access.csv
/module_name/static/src/img/icon.png
/module_name/tests

权限

模块中定义的每个模块必须有至少一条安全规则，使得它可被访问

编码指南

Follow Python PEP 8: http://www.python.org/dev/peps/pep-0008/

Reporting

总体风格

  • 每个地方使用 Helvetica 字体
  • 边缘 (用毫米表示):
    • top: 14
    • bottom: 16
    • left: between 12 and 13 to allow punching holes without punching in the text area
    • right: between 12 and 13

Note

the line separator between the header and the body can overlap slightly in the left and right margins: up to 9 millimeters on the left and up to 12 millimeters on the right

  • for Titles use font Helvetica-Bold with size 14.5
  • put the context on each report: example, for the report account_balance: the context is the fiscal year and periods
  • for the name of cells: use Capital Letter if the name contains more than one word (ex: Date Ordered)
  • content and name of cells should have the same indentation
  • for report, we can define two kinds of arrays:
    • array with general information, like reference, date..., use:
      • Bold-Helvetica and size=8 for cells name
      • Helvetica size=”8” for content
    • array with detailed information, use:
      • Helvetica-Bold size 9 for cells names
      • Helvetica size 8 for content
Headers and footers for internal reports:
  • Internal report = all accounting reports and other that have only internal use (not sent to customers)
  • height of headers should be shorter
  • take off corporate header and footer for internal report (Use a simplified header for internal reports: Company’s name, report title, printing date and page number)
  • header:
    • company’s name: in the middle of each page
    • report’s name: is printed centered after the header
    • printing date: not in the middle of the report, but on the left in the header
    • page number: on each page, is printed on the right. This page number should contain the current page number and the total of pages. Ex: page 3/15
  • footer:
    • to avoid wasting paper, we have taken off the footer
table line separator:
  • it’s prettier if each line in a table has a light grey line as separator
  • use a grey column separator only for array containing general information
table breaking
  • a table header should at least have two data rows (no table header alone at the bottom of the page)
  • when a big table is broken, the table header is repeated on every page
how to differentiate parents and children ?
  • When you have more than one level, use these styles:
  • for the levels 1 and 2:fontSize=”8.0” fontName=”Helvetica-Bold”
  • from the third level, use:fontName=”Helvetica” fontSize=”8.0” and increase the indentation with 13 (pixels) for each level
  • underline sums when the element is a parent
模块

命名惯例

模块的名称全部小写，每个单词用下划线分割。 总是用最重要、最相关的单词开头，区别其它模块的最好的名称

例如：

  • account_invoice_layout

必要信息

每个模块至少包括：

  • name 模块名称
  • description 模块说明

模块描述

描述

每个模块必须包含：

  • 一个与其它模块的依赖关系的列表： [‘account’,’sale’]
  • 只需提供最高的需求级别，不需要设置 [‘account’,’base’,’product’,’sale’]

模块内容

每个模块必须为 模块中定义的对象包含演示数据

如果你要在模块中实现工作流，创建 传递你工作流的多数分支的演示数据 。 你能使用模块记录器（ module recorder）来帮助你建立这样的演示数据

菜单

菜单命名

  • 使用复数形式: Customer Invoice, 命名为 Customer Invoices
  • 如果可能，在菜单中避免缩略语. 例如: BoMs -> Bills of Materials

菜单的顺序

The Reporting menu is at the bottom of the list, use a sequence=50.

常见错误

  • Edit Categories -> Categories
  • List of Categories -> Categories

搜索条件

搜索条件: 搜索可用在列表视图的所有列

默认语言

每个开发的默认语言必须是 U.S. English.

对菜单和字段，第一个字母使用大写, 除非是 连词:

  • Chart of Accounts

字段命名惯例

  • many2one fields should respect this regex: ‘.*_id’
  • one2many fields should respect this regex: ‘.*_ids’
  • one2many relation table should respect this regex: ‘.*_rel’
  • many2many fields should respect this regex: ‘.*_ids’
  • 使用下划线 分割单词
  • 避免使用大写
  • 如果一个字段有几个单词组成，用最重要的单词开头

模块命名惯例

  • 所有对象必须用定义他们的模块的名称开头.
  • 如果一个对象名称由几个单词组成，用 小数点 分割单词

术语

  • 记录的树形列表应该被称为“XXX的结构”，除非有个特定的称谓已经存在
    • 推荐: 库位结构，科目表，类型结构
    • 不推荐: 分类树，物料清单树