标准规范-Python代码规范和命名规范

前言

Python代码应严格遵循一定编码编写规范，自己需有个代码标准规范意识，养成习惯。
代码书写规范对以后工作交接及debug有很大的帮助。

一、代码基础规范

1、编码格式

如无特殊情况, 文件一律使用 UTF-8 编码

如无特殊情况, 文件头部必须加入#--coding:utf-8--标识

2、代码格式

2.1、缩进

统一使用 4 个空格进行缩进

2.2、行宽

每行代码尽量不超过 80 个字符(在特殊情况下可以略微超过 80 ，但最长不得超过 120)

理由：

• 这在查看 side-by-side 的 diff 时很有帮助
• 方便在控制台下查看代码
• 太长可能是设计有缺陷

2.3、引号

简单说，自然语言使用双引号，机器标示使用单引号，因此 代码里 多数应该使用 单引号

• 自然语言 使用双引号 “…”
  
  例如错误信息；很多情况还是 unicode，使用u"你好世界"
• 机器标识 使用单引号 ‘…’
  
  例如 dict 里的 key
• 正则表达式 使用原生的双引号 r"…"
  
  文档字符串 (docstring) 使用三个双引号 “”"…"""

2.4、空行

• 模块级函数和类定义之间空两行；
• 类成员函数之间空一行；

class A:
 
    def __init__(self):
        pass
 
    def hello(self):
        pass
 
def main():
    pass   

• 可以使用多个空行分隔多组相关的函数
• 函数中可以使用空行分隔出逻辑相关的代码

3、模块导入语句规范

• import 语句应该分行书写

# 正确的写法
import os
import sys
 
# 不推荐的写法
import sys,os
 
# 正确的写法
from subprocess import Popen, PIPE

• import语句应该使用 absolute import

# 正确的写法
from foo.bar import Bar
 
# 不推荐的写法
from ..bar import Bar

• import语句应该放在文件头部，置于模块说明及docstring之后，于全局变量之前；
  
• import语句应该按照顺序排列，每组之间用一个空行分隔
  

import os
import sys
 
import msgpack
import zmq
 
import foo

• 导入其他模块的类定义时，可以使用相对导入

from myclass import MyClass

• 如果发生命名冲突，则可使用命名空间

import bar
import foo.bar
 
bar.Bar()
foo.bar.Bar()

4、空格

• 在二元运算符两边各空一格[=,-,+=,==,>,in,is not, and]:

# 正确的写法
i = i + 1
submitted += 1
x = x * 2 - 1
hypot2 = x * x + y * y
c = (a + b