python编码规范整理

一. 为什么要进行Python编码规范

• 统一美
• 方便自己与他人阅读
• 方便后续管理

二. 有哪些需要注意的地方

1. 名称
    创建文件夹/文件/变量等，编写代码要遵循pep8规范(一些潜规则)
- 文件夹， 小写 & 小写下划线 例如：data_utils、commands等
- 文件，小写 & 小写加下划线 例如： page.py、db_convert.py等
- 变量，
    全局变量， 大写 & 大写加下划线 例如： NAME = "wanglisha"、BASE_NAME = 18等
    局部变量， 小写 & 小写加下划线 例如： data = [11, 12, 13]、user_parent_id = 9等

2. 注释
- 文件夹注释
例如：在模块的__init__.py文件中描述整个模块（文件夹，这里是模块）的作用：
"""
文件夹xxx的作用是xxxx，或起到了xxxx的作用，详细为：
xxxxx
"""

- 文件注释
可直接在文件头部进行注释，备注说明这个文件起到的作用，举例说明：

- 代码注释
使用行注释与块注释对必要的代码步骤进行说明即可

3. TODO
基于注释可以实现TODO效果，举例说明：

 

 

 在Pycharm中注释后的文字显示的灰色，一旦加上TODO之后，显示黄色，如上所示，提示性更强

4. 条件的嵌套
过多的条件嵌套会导致不必要的代码冗余，产生过多时间复杂度等

条件语句一定要想办法减少嵌套的层级（最好不要超过3层）

万一超过 那是没有办法的事情 最好不要

5. 简单逻辑先处理

6. 循环（*）

尽量少循环多干事，提高代码效率
举例：使用字典key value分别复制来进行说明，方法一中使用for循环进行复制相对比方法二中循环的次数要少，相对效率高

key_list = []
value_list = []

info = {'k1': 'v1',
        'k2': 'v2',
        'k3': 'v3'}

# 方法一：使用for循环进行赋值  相对效率高
for key, value in info.items():
    key_list.append(key)
    value_list.append(value)

# 方法二：直接循环赋值  相对效率低
key_list = list(info.keys())
value_list = list(info.values())

7. 变量和值
    等号左右间
    Pycharm的菜单栏/快捷键：Code->Reformat Code/ctrl+alt+L