Python开发规范(FastAPI项目)_fastapi仓储管理

一、概述

​ 出于整个团队代码可读性、可维护性考量，有必要约定一套Python开发基本规范，从而提升项目可持续性开发，提升代码开发效率等。鉴于此，制订以下Python开发规范文档，本规范文档一经确认，Python开发人员需按照此文档规范进行项目Python后端的开发，对本文档不合理或不对之处请及时提出，在讨论统一意见后进行修改。

• 提高代码质量
• 统一项目代码风格
• 方便代码自审、他审依据参考
• 提升协作开发效率
• 促进个人成长

二、开发环境

• 如无特殊需要，选择 Python 3.7+ 版本解释器
• 开发环境尽量保持和服务器环境一致，以免开发完成后上线时发生意外的环境兼容问题

三、项目目录结构

|- 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 (启停或其他脚本)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

具体结构可根据具体项目略做调整和修改

四：命名规范

• 不要使用中文拼音，尽量不要使用数字

• 尽量命名语义化

• 应该避免的名称

  单字符名称, 除了计数器和迭代器.
  包/模块名中的连字符(-)
  双下划线开头并结尾的名称(Python保留, 例如__init__)

• 命名约定

  所谓”内部(Internal)”表示仅模块内可用, 或者, 在类内是保护或私有的.
  用单下划线(_)开头表示模块变量或函数是protected的(使用from module import *时不会包含).
  用双下划线(__)开头的实例变量或方法表示类内私有.
  将相关的类和顶级函数放在同一个模块里. 不像Java, 没必要限制一个类一个模块.
  对类名使用大写字母开头的单词(如CapWords, 即Pascal风格), 但是模块名应该用小写加下划线的方式(如lower_with_under.py).

五、编码风格规范

主要参考

PEP8

谷歌Python风格指南

行长度

• 每行不超过 120 个字符

  例外:

  • 长的导入模块语句
  • 注释里的URL

• 不要使用反斜杠连接行.

  Python会将 圆括号, 中括号和花括号中的行隐式的连接起来 , 你可以利用这个特点. 如果需要, 你可以在表达式外围增加一对额外的圆括号.

  如果一个文本字符串在一行放不下, 可以使用圆括号来实现隐式行连接.

  在注释中，如果必要，将长的URL放在一行上.

括号

宁缺毋滥的使用括号

除非是用于实现行连接, 否则不要在返回语句或条件语句中使用括号. 不过在元组两边使用括号是可以的.

缩进

用4个空格来缩进代码

绝对不要用tab, 也不要tab和空格混用. 对于行连接的情况, 你应该要么垂直对齐换行的元素(见 行长度 部分的示例), 或者使用4空格的悬挂式缩进(这时第一行不应该有参数):

空行

顶级定义之间空两行, 方法定义之间空一行

顶级定义之间空两行, 比如函数或者类定义. 方法定义, 类定义与第一个方法之间, 都应该空一行. 函数或方法中, 某些地方要是你觉得合适, 就空一行.

空格

按照标准的排版规范来使用标点两边的空格

• 括号内不要有空格.

• 不要在逗号, 分号, 冒号前面加空格, 但应该在它们后面加(除了在行尾).

• 参数列表, 索引或切片的左括号前不应加空格.

• 在二元操作符两边都加上一个空格, 比如赋值(=), 比较(==, <, >, !=, <>, <=, >=, in, not in, is, is not), 布尔(and, or, not). 至于算术操作符两边的空格该如何使用, 需要你自己好好判断. 不过两侧务必要保持一致.

• 当’=’用于指示关键字参数或默认参数值时, 不要在其两侧使用空格.

• 不要用空格来垂直对齐多行间的标记, 因为这会成为维护的负担(适用于:, #, =等):

注释

确保对模块, 函数, 方法和行内注释使用正确的风格.

• 文档字符串

  Python有一种独一无二的的注释方式: 使用文档字符串. 文档字符串是包, 模块, 类或函数里的第一个语句. 这些字符串可以通过对象的__doc__成员被自动提取, 并且被pydoc所用. (你可以在你的模块上运行pydoc试一把, 看看它长什么样). 我们对文档字符串的惯例是使用三重双引号”“”( PEP-257 ). 一个文档字符串应该这样组织: 首先是一行以句号, 问号或惊叹号结尾的概述(或者该文档字符串单纯只有一行). 接着是一个空行. 接着是文档字符串剩下的部分, 它应该与文档字符串的第一行的第一个引号对齐. 下面有更多文档字符串的格式化规范.

  由于很难界定是否需要注释，尽量都写上文档字符串，复杂的代码块加上代码块注释。

• 函数和方法

  下文所指的函数,包括函数, 方法, 以及生成器.

  一个函数必须要有文档字符串, 除非它满足以下条件:

  • 外部不可见
  • 非常短小
  • 简单明了

  文档字符串应该包含函数做什么, 以及输入和输出的详细描述. 通常, 不应该描述”怎么做”, 除非是一些复杂的算法. 文档字符串应该提供足够的信息, 当别人编写代码调用该函数时, 他不需要看一行代码, 只要看文档字符串就可以了. 对于复杂的代码, 在代码旁边加注释会比使用文档字符串更有意义.

  统一 使用 reStructedText 格式文档字符串，Pycharm配置参考

• 类

  类应该在其定义下有一个用于描述该类的文档字符串. 如果你的类有公共属性(Attributes), 那么文档中应该有一个属性(Attributes)段. 并且应该遵守和函数参数相同的格式.

• 块注释和行注释

  最需要写注释的是代码中那些技巧性的部分. 如果你在下次 代码审查 的时候必须解释一下, 那么你应该现在就给它写注释. 对于复杂的操作, 应该在其操作开始前写上若干行注释. 对于不是一目了然的代码, 应在其行尾添加注释. 为了提高可读性, 注释应该至少离开代码2个空格.

  另一方面, 绝不要描述代码. 假设阅读代码的人比你更懂Python, 他只是不知道你的代码要做什么.

类

如果一个类不继承自其它类, 就显式的从object继承. 嵌套类也一样.

字符串

• 使用 f-strings方法对字符串进行拼接.

• 避免在循环中用+和+=操作符来累加字符串. 由于字符串是不可变的, 这样做会创建不必要的临时对象, 并且导致二次方而不是线性的运行时间. 作为替代方案, 你可以将每个子串加入列表, 然后在循环结束后用 .join 连接列表. (也可以将每个子串写入一个 cStringIO.StringIO 缓存中.)

• 在同一个文件中, 保持使用字符串引号的一致性. 使用单引号’或者双引号”之一用以引用字符串, 并在同一文件中沿用. 在字符串内可以使用另外一种引号, 以避免在字符串中使用.

• 为多行字符串使用三重双引号”“”而非三重单引号’‘’. 当且仅当项目中使用单引号’来引用字符串时, 才可能会使用三重’‘’为非文档字符串的多行字符串来标识引用. 文档字符串必须使用三重双引号”“”. 不过要注意, 通常用隐式行连接更清晰, 因为多行字符串与程序其他部分的缩进方式不一致.

文件和sockets

除文件外, sockets或其他类似文件的对象在没有必要的情况下打开, 会有许多副作用, 例如:

1. 它们可能会消耗有限的系统资源, 如文件描述符. 如果这些资源在使用后没有及时归还系统, 那么用于处理这些对象的代码会将资源消耗殆尽.
2. 持有文件将会阻止对于文件的其他诸如移动、删除之类的操作.
3. 仅仅是从逻辑上关闭文件和sockets, 那么它们仍然可能会被其共享的程序在无意中进行读或者写操作. 只有当它们真正被关闭后, 对于它们尝试进行读或者写操作将会抛出异常, 并使得问题快速显现出来.

而且, 幻想当文件对象析构时, 文件和sockets会自动关闭, 试图将文件对象的生命周期和文件的状态绑定在一起的想法, 都是不现实的. 因为有如下原因:

1. 没有任何方法可以确保运行环境会真正的执行文件的析构. 不同的Python实现采用不同的内存管理技术, 比如延时垃圾处理机制. 延时垃圾处理机制可能会导致对象生命周期被任意无限制的延长.
2. 对于文件意外的引用,会导致对于文件的持有时间超出预期(比如对于异常的跟踪, 包含有全局变量等).

推荐使用 “with”语句 以管理文件

with open("hello.txt") as hello_file:
    for line in hello_file:
        print line
1
2
3

对于不支持使用”with”语句的类似文件的对象,使用 contextlib.closing()

import contextlib

with contextlib.closing(urllib.urlopen("http://www.python.org/")) as front_page:
    for line in front_page:
        print line
1
2
3
4
5

TODO注释

为临时代码使用TODO注释, 它是一种短期解决方案. 不算完美, 但够好了.

导入格式

每个导入应该独占一行
导入总应该放在文件顶部, 位于模块注释和文档字符串之后, 模块全局变量和常量之前. 导入应该按照从最通用到最不通用的顺序分组:

1. 标准库导入
2. 第三方库导入
3. 应用程序指定导入

每种分组中, 应该根据每个模块的完整包路径按字典序排序, 忽略大小写.

语句

通常每个语句应该独占一行.

访问控制

在Python中, 对于琐碎又不太重要的访问函数, 你应该直接使用公有变量来取代它们, 这样可以避免额外的函数调用开销. 当添加更多功能时, 你可以用属性(property)来保持语法的一致性.

另一方面, 如果访问更复杂, 或者变量的访问开销很显著, 那么你应该使用像 get_foo() 和 set_foo() 这样的函数调用. 如果之前的代码行为允许通过属性(property)访问 , 那么就不要将新的访问函数与属性绑定. 这样, 任何试图通过老方法访问变量的代码就没法运行, 使用者也就会意识到复杂性发生了变化.

Main

即使是一个打算被用作脚本的文件, 也应该是可导入的. 并且简单的导入不应该导致这个脚本的主功能(main functionality)被执行, 这是一种副作用. 主功能应该放在一个main()函数中.

文档

善于使用自动生成文档功能，提高对接接口效率.

硬编码

禁止硬编码，提高修改、配置灵活性.

代码模块化

项目代码接口要按业务逻辑层、内部控制层区分开，内部控制层稳定基本不变、业务逻辑层随业务的变动灵活配置扩展.

六、代码审查

• 自审

  • 不相关的修改不要 commit
  • 本地 debug 留下的痕迹不要提交，一些打印信息等

• 静态检查

  使用Pylint 或 Flake8 进行代码常规语法、风格等检查，可灵活配置检查条件.

• 人工检查

  由项目负责人或代码审阅人对代码规范、逻辑等进行 review.

七、代码仓库管理

Git 分支管理

方便团队高效协作开发及发布，采用 GitFlow 流程

1. master
   主分支，这个分支最近发布到生产环境的代码， 这个分支只能从其他分支合并，不能在这个分支直接修改
2. develop
   开发分支，功能最新最全的分支，只能从其他分支合并，不能直接修改
3. feature
   功能分支，开发特定新功能的临时分支，完成后合并到 develop，命名feature-x
   功能分支应该是为了某个单一功能创建的分支，不要把多个功能放到同一分支里
4. hotfix
   修复分支，用来临时修复一些 bug 的分支，完成后合并到 develop，命名 hotfix-x
5. release
   预发布分支，正式发布之前如果需要预发布则需要从 develop 分出来, 命名 release-xxx
6. test
   测试分支，用于测试人员测试, 命名test-xxx

一般流程：

长期存在的就是 master 和 develop 分支，

开发人员根据自己的需要建立对应的临时分支(feature/hotfix), 开发完成后合并到 test 分支，

测试完成后没有问题 则合并到 develop 分支, 临时分支即可删除,

新功能发布需要从 develop 或 release 分支合并相应功能到 master 分支，再进行部署发布.

提交规范

• 原子化提交

  每一个提交尽量只包含最小单位的修改或功能

• 提交或PR之前先 Rebase 最新代码, 防止冲突

• 提交之前必需格式化代码

  • 格式化代码块 Pycharm: 菜单 -> Code -> Reformat Code
  • 格式化导入 Pycharm: 菜单 -> Code -> Optimize Imports

• 提交之前必须先进行本地静态检查, 消除静态检查提示的不规范信息

  • Pycharm 自带检查： 菜单 -> Code -> Inspect Code
  • Pylint: 插件安装Pylint

• 代码提交，要写清楚代码变动涉及的具体内容
  参考格式:

  <type>: <subject><BLANK LINE><body><BLANK LINE>
  1

  大体分两行：

  • 标题行

    必填, 描述主要修改类型和内容

  • 主题内容

    描述为什么修改, 做了什么样的修改, 以及这么做的思路等等

  其中 type 是 Commit 的类型，可以有以下取值：

  • feature：新特性
  • fix：修改 bug
  • refactor：代码重构
  • docs：文档更新
  • style：代码格式修改
  • test：测试用例修改
  • other：其他修改, 比如构建流程, 依赖管理

八、Restful API 接口

接口风格规范

• HTTP Header 信息

  包含认证信息等其他公共信息

• HTTP Response

  HTTP Code 只返回 200， 不返回 404、500等影响客户体验的状态，具体有误信息以 code/message 的格式返回.

  格式如下:

  {
      code: int,			# 内部返回码
      msg: string,		# 返回描述
      data: object/arrary	# 返回数据(对象、数组)
  }
  1
  2
  3
  4
  5

• URL 路由格式

  • 带有功能说明： 如 /knowledge_graph/api/
  • 带有接口版本： 如某服务接口的 v1 版本 /api/v1/
  • 使用/表示层级关系
  • 不能包含空格
  • 不能以文件后缀结尾
  • 小写加下划线
  • 不要添加CRUD关键字

• HTTP请求

  请求资源格式:

  /knowledge_graph/api/collection_id/resource_id/sub_collection_id/sub_resource_id
  1

  • GET（SELECT）：从服务器取出资源

    /knowledge_graph/api/v1/order/{order_id} 	<!-- 获取单个资源 -->
    /knowledge_graph/api/v1/orders?parameters 	<!-- 获取多个资源 -->
    1
    2

  • POST（CREATE）：在服务器新建资源

    /knowledge_graph/api/v1/order 		<!-- 创建单个资源 -->
    /knowledge_graph/api/v1/orders 		<!-- 创建多个资源 -->
    1
    2

  • PUT（UPDATE）：在服务器更新完整的资源（客户端提供改变后的完整资源）

    /knowledge_graph/api/v1/order/{order_id} 	<!-- 更新单个资源 -->
    /knowledge_graph/api/v1/orders 				<!-- 更新多个资源 -->
    1
    2

  • PATCH（UPDATE）：在服务器更新部分资源（客户端提供改变后的部分资源）

    /knowledge_graph/api/v1/order/{order_id} 	<!-- 更新单个资源 -->
    /knowledge_graph/api/v1/orders 				<!-- 更新多个资源 -->
    1
    2

  • DELETE（DELETE）：从服务器删除资源

    /knowledge_graph/api/v1/order/{order_id} 	<!-- 删除单个资源 -->
    /knowledge_graph/api/v1/orders 				<!-- 删除多个资源 -->
    1
    2

  其他类型请求

  • 使用 动词 或 动词 + 宾语 的 格式

    /api/check ;
    /api/check_money
    1
    2

  • 对单个资源执行CRUD以外的操作

    /knowledge_graph/api/v1/order/{order_id}/operate
    1

  • 对单资源执行嵌套的CRUD操作

    /knowledge_graph/api/v1/order/{order_id}/order_good/{order_good_id}		<!-- 订单下单个订单商品操作 -->
    /knowledge_graph/api/v1/order/{order_id}/order_goods					<!-- 订单下多个订单商品操作 -->
    1
    2

接口文档

使用 FastAPI 自动生成文档功能，接口请求及应答参数都要写明注释或描述，以便生成完善的接口文档.

九、配置信息

密钥等私密数据不要硬编码到代码中，而是放入环境变量.