编码指南

以下条目由OpenERP质量团队维护并且作为质量审查的一部分。 包含了OpenERP的推荐的/不推荐的实现方式，以及通用的Python编程建议。

这两部分是每一个OpenERP的开发、贡献者都必须阅读的。

请谨记以下几条通用的规则：

你写的每一行代码将会多次被别人（包括你自己）阅读

At the risk of stating the obvious, this means that while following the other guidelines, you should always use your best judgment in order to achieve the best readability. And if writing readable code requires an additional effort, it’s worth it a thousand times.

• 1 Python代码风格指南
  • 1.1 魔术方法
  • 1.2 .clone()
  • 1.3 “clone 和 update”
  • 1.4 “手动 update”
  • 1.5 Java 的字典创建方式
  • 1.6 “临时的 kwargs”
  • 1.7 （正式和非正式）过时的方法
  • 1.8 没必要的中间变量
  • 1.9 让冗余代码三振出局
  • 1.10 简单的多个返回值是可以接受的
  • 1.11 尽量避免类型测试
  • 1.12 除非你知道要的是什么类型，否则不要使用 type
  • 1.13 如果真的想用，那就用python提供的类型测试
  • 1.14 不要只是为了调用函数而创造新函数
  • 1.15 了解内建函数
  • 1.16 学习列表推导式
  • 1.17 学习你的标准库
  • 1.18 Collections 也是布尔类型
  • 1.19 你可以把一个对象添加到列表中
  • 1.20 列表相加
  • 1.21 学习你的标准库 (2)
  • 1.22 遍历可迭代对象
  • 1.23 链接调用是可以的，只要你不要滥用
  • 1.24 使用 dict.setdefault
  • 1.25 使用默认值，远离“神奇数字”
• 2 OpenERP 特别指引
  • 2.1 Bazaar 是你的历史档案
  • 2.2 命名要言之有物
  • 2.3 别绕过ORM
  • 2.4 请不要SQL注入
  • 2.5 合理抽象
  • 2.6 警惕context
  • 2.7 有时候这比 lambda 好
  • 2.8 保持您的方法尽量简洁/简单
  • 2.9 不要提交事务
  • 2.10 正确使用 gettext 方法
• 3 YAML 自动测试指南
  • 3.1 语法
  • 3.2 运行在服务端的测试
  • 3.3 精确的测试目标
  • 3.4 尽量避免依赖那些会被用户修改的数据
  • 3.5 把测试信息写得详细有助于Yaml测试系统进行测试
  • 3.6 避免依赖现有的数据以防用户修改它们
  • 3.7 不用深究测试的具体出错信息
  • 3.8 说明用户要做什么比在哪里点击要好
  • 3.9 你可以在测试里使用”onchange”以此来模拟客户端