一、概述
出于整个团队代码可读性、可维护性考量，有必要约定一套Python开发基本规范，从而提升项目可持续性开发，提升代码开发效率等。鉴于此，制订以下Python开发规范文档，本规范文档一经确认，Python开发人员需按照此文档规范进行项目Python后端的开发，对本文档不合理或不对之处请及时提出，在讨论统一意见后进行修改。
二、开发环境 三、项目目录结构
|- main (存放启动项目入口文件)
|- control(存放和数据库交互的控制器文件)
|- item / model (存放数据结构文件)
|- api
|- internal (存放内部api处理文件)
- routers.py (路由模块)
- dependencies.py (依赖项模块)
|- external (存放外部api处理文件)
- routers.py (路由模块)
- dependencies.py (依赖项模块)
| - ...（其他分类api）
|- docs (存放相关文档)
|- setting (存放配置文件)
|- static (存放静态资源文件)
|- templates (存放模板文件)
|- utils (存放三方、工具、常量、异常等公用模块)
|- log (存放临时日志文件)
|- task (存放异步任务文件 Celery 等)
- gunicorn.conf.py
- README.md
- requirements.txt
- xx.sh (启停或其他脚本)
具体结构可根据具体项目略做调整和修改
四：命名规范 TypePublicInternal
项目
lower_with_under
模块
lower_with_under
lower_with_under
包
lower_with_under
类
CapWords
CapWords
异常
CapWords
函数
lower_with_under()
_lower_with_under()
全局/类 常量
CAPS_WITH_UNDER
_CAPS_WITH_UNDER
全局/类 变量
lower_with_under
_lower_with_under
实例变量
lower_with_under
_lower_with_under (protected) or __lower_with_under (private)
方法名
lower_with_under()
_lower_with_under() (protected) or __lower_with_under() (private)
函数/方法 参数
lower_with_under
局部变量
lower_with_under
五、编码风格规范
主要参考
PEP8
谷歌Python风格指南
行长度
不要使用反斜杠连接行.
Python会将 圆括号, 中括号和花括号中的行隐式的连接起来 , 你可以利用这个特点. 如果需要, 你可以在表达式外围增加一对额外的圆括号.
如果一个文本字符串在一行放不下, 可以使用圆括号来实现隐式行连接.
在注释中，如果必要，将长的URL放在一行上.
括号
宁缺毋滥的使用括号
除非是用于实现行连接, 否则不要在返回语句或条件语句中使用括号. 不过在元组两边使用括号是可以的.
缩进
用4个空格来缩进代码
绝对不要用tab, 也不要tab和空格混用. 对于行连接的情况, 你应该要么垂直对齐换行的元素(见 行长度 部分的示例), 或者使用4空格的悬挂式缩进(这时第一行不应该有参数):
空行
顶级定义之间空两行, 方法定义之间空一行
顶级定义之间空两行, 比如函数或者类定义. 方法定义, 类定义与第一个方法之间, 都应该空一行. 函数或方法中, 某些地方要是你觉得合适, 就空一行.
空格
按照标准的排版规范来使用标点两边的空格
注释
确保对模块, 函数, 方法和行内注释使用正确的风格.
文档字符串应该包含函数做什么, 以及输入和输出的详细描述. 通常, 不应该描述”怎么做”, 除非是一些复杂的算法. 文档字符串应该提供足够的信息, 当别人编写代码调用该函数时, 他不需要看一行代码, 只要看文档字符串就可以了. 对于复杂的代码, 在代码旁边加注释会比使用文档字符串更有意义.
统一 使用 reStructedText 格式文档字符串，Pycharm配置参考
类
类应该在其定义下有一个用于描述该类的文档字符串. 如果你的类有公共属性(Attributes), 那么文档中应该有一个属性(Attributes)段. 并且应该遵守和函数参数相同的格式.
块注释和行注释
最需要写注释的是代码中那些技巧性的部分. 如果你在下次 代码审查 的时候必须解释一下, 那么你应该现在就给它写注释. 对于复杂的操作, 应该在其操作开始前写上若干行注释. 对于不是一目了然的代码, 应在其行尾添加注释. 为了提高可读性, 注释应该至少离开代码2个空格.
另一方面, 绝不要描述代码. 假设阅读代码的人比你更懂Python, 他只是不知道你的代码要做什么.
类
如果一个类不继承自其它类, 就显式的从object继承. 嵌套类也一样.
字符串 文件和sockets
除文件外, sockets或其他类似文件的对象在没有必要的情况下打开, 会有许多副作用, 例如:
它们可能会消耗有限的系统资源, 如文件描述符. 如果这些资源在使用后没有及时归还系统, 那么用于处理这些对象的代码会将资源消耗殆尽.持有文件将会阻止对于文件的其他诸如移动、删除之类的操作.仅仅是从逻辑上关闭文件和sockets, 那么它们仍然可能会被其共享的程序在无意中进行读或者写操作. 只有当它们真正被关闭后, 对于它们尝试进行读或者写操作将会抛出异常, 并使得问题快速显现出来.
而且, 幻想当文件对象析构时, 文件和sockets会自动关闭, 试图将文件对象的生命周期和文件的状态绑定在一起的想法, 都是不现实的. 因为有如下原因:
没有任何方法可以确保运行环境会真正的执行文件的析构. 不同的Python实现采用不同的内存管理技术, 比如延时垃圾处理机制. 延时垃圾处理机制可能会导致对象生命周期被任意无限制的延长.对于文件意外的引用,会导致对于文件的持有时间超出预期(比如对于异常的跟踪, 包含有全局变量等).
推荐使用 “with”语句 以管理文件
with open("hello.txt") as hello_file:
for line in hello_file:
print line
对于不支持使用”with”语句的类似文件的对象,使用 contextlib.closing()
import contextlib
with contextlib.closing(urllib.urlopen("http://www.python.org/")) as front_page:
for line in front_page:
print line
TODO注释
为临时代码使用TODO注释, 它是一种短期解决方案. 不算完美, 但够好了.
导入格式
每个导入应该独占一行
导入总应该放在文件顶部, 位于模块注释和文档字符串之后, 模块全局变量和常量之前. 导入应该按照从最通用到最不通用的顺序分组:
标准库导入第三方库导入应用程序指定导入
每种分组中, 应该根据每个模块的完整包路径按字典序排序, 忽略大小写.
语句
通常每个语句应该独占一行.
访问控制
在Python中, 对于琐碎又不太重要的访问函数, 你应该直接使用公有变量来取代它们, 这样可以避免额外的函数调用开销. 当添加更多功能时, 你可以用属性(property)来保持语法的一致性.
另一方面, 如果访问更复杂, 或者变量的访问开销很显著, 那么你应该使用像 get_foo() 和 set_foo() 这样的函数调用. 如果之前的代码行为允许通过属性(property)访问 , 那么就不要将新的访问函数与属性绑定. 这样, 任何试图通过老方法访问变量的代码就没法运行, 使用者也就会意识到复杂性发生了变化.
Main
即使是一个打算被用作脚本的文件, 也应该是可导入的. 并且简单的导入不应该导致这个脚本的主功能(main functionality)被执行, 这是一种副作用. 主功能应该放在一个main()函数中.
文档
善于使用自动生成文档功能，提高对接接口效率.
硬编码
禁止硬编码，提高修改、配置灵活性.
代码模块化
项目代码接口要按业务逻辑层、内部控制层区分开，内部控制层稳定基本不变、业务逻辑层随业务的变动灵活配置扩展.
六、代码审查
静态检查
使用Pylint 或 Flake8 进行代码常规语法、风格等检查，可灵活配置检查条件.
人工检查
由项目负责人或代码审阅人对代码规范、逻辑等进行 review.
七、代码仓库管理 Git 分支管理
方便团队高效协作开发及发布，采用 GitFlow 流程
master
主分支，这个分支最近发布到生产环境的代码， 这个分支只能从其他分支合并，不能在这个分支直接修改develop
开发分支，功能最新最全的分支，只能从其他分支合并，不能直接修改feature
功能分支，开发特定新功能的临时分支，完成后合并到 develop，命名feature-x
功能分支应该是为了某个单一功能创建的分支，不要把多个功能放到同一分支里hotfix
修复分支，用来临时修复一些 bug 的分支，完成后合并到 develop，命名 hotfix-xrelease
预发布分支，正式发布之前如果需要预发布则需要从 develop 分出来, 命名 release-xxxtest
测试分支，用于测试人员测试, 命名test-xxx
一般流程：
长期存在的就是 master 和 develop 分支，
开发人员根据自己的需要建立对应的临时分支(feature/hotfix), 开发完成后合并到 test 分支，
测试完成后没有问题 则合并到 develop 分支, 临时分支即可删除,
新功能发布需要从 develop 或 release 分支合并相应功能到 master 分支，再进行部署发布.
提交规范
提交之前必须先进行本地静态检查, 消除静态检查提示的不规范信息
代码提交，要写清楚代码变动涉及的具体内容
参考格式:
:
大体分两行：
其中 type 是 Commit 的类型，可以有以下取值：
八、Restful API 接口 接口风格规范
