规范

• 尽可能使用变量,好处复用，修改方便

• 名字尽可能见名只其意,不要怕过长的变量

• 使用函数或者对象封装，建议大于 20 行代码

• 函数设计尽量短小，嵌套层次不宜过多，建议三层以内

• 函数申明、合理、简单、易用，一个函数只做一个事情

• 函数考虑向下兼容

• 常量建议

• 常量应存放文件constant.py中

• 使用大写区分

• 代码注释

• 为每个模块、类、函数编写文档字符串

• 为模块编写文档字符串，写在模块头文件中,包含模块的基本功能以及重要函数或者复杂函数用法 demo

• 为类编写文档字符串,阐述类的作用以及重要方法以及子类和超类的实现注意项

• 为每个函数编写文档字符串,复杂函数内部也要注释，函数基本用法或者返回值

• 使用 unittest 测试全部代码

学习路径

• 全面掌握 Python 提供所有特性,最好阅读 language reference 和 library reference

• 公认的 Pythonic 代码 ： Flask，gevent、request

• 持续学习新版本 Python 特性

API 文档

• 系统的概述，包括各个组成部分以及工作流程的介绍

• 每个组成部分的具体介绍，包括必要性、设计原理等等

• 系统的 performance，包括 latency 等等参数

• 主要说明如何对系统的各个部分进行修改，主要给出相应的 code pointer 及对应的测试方案