【Python】代码规范【原创】

参考

https://blog.csdn.net/ratsniper/article/details/78954852

https://www.cnblogs.com/wangcp-2014/p/4608265.html

https://www.jianshu.com/p/c7455c178059

缩进

• 统一使用4个空格进行缩进
• 续行应该与其包裹元素对齐，要么使用圆括号、方括号和花括号内的隐式行连接来垂直对齐，要么使用挂行缩进对齐。当使用挂行缩进时，应该考虑到第一行不应该有参数，以及使用缩进以区分自己是续行。

推荐：

# 与左括号对齐
foo = long_function_name(var_one, var_two,
                         var_three, var_four)

# 用更多的缩进来与其他行区分
def long_function_name(
        var_one, var_two, var_three,
        var_four):
    print(var_one)

# 挂行缩进应该再换一行
foo = long_function_name(
    var_one, var_two,
    var_three, var_four)

不推荐

# 没有使用垂直对齐时，禁止把参数放在第一行
foo = long_function_name(var_one, var_two,
    var_three, var_four)

# 当缩进没有与其他行区分时，要增加缩进
def long_function_name(
    var_one, var_two, var_three,
    var_four):
    print(var_one)

行长度

• 所有行限制的最大字符数为79(在特殊情况下可以略微超过80，但最长不得超过120)
• 没有结构化限制的大块文本（文档字符或者注释），每行的最大字符数限制在72。

引号

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

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

空行

• 顶层函数和类的定义，前后用两个空行隔开。
• 类里的方法定义用一个空行隔开。

比如：

class A:

    def __init__(self):
        pass

    def hello(self):
        pass


    def main():
        pass

编码

• 文件使用UTF-8编码
• 文件头部加入#--conding:utf-8--标识 (Python 3 以上版本不需要)

Import导入

• 导入通常在分开的行
• 导入总是位于文件的顶部，在模块注释和文档字符串之后，在模块的全局变量与常量之前
• 导入的顺序分组（顺序为：标准库导入、相关第三方库导入、本地库导入，每一组导入之间有空行）
• 推荐使用绝对路径导入

比如：

# 推荐
import os

import sys

# 不推荐
import sys, os

Comments注释

• 与代码相矛盾的注释比没有注释还糟，当代码更改时，优先更新对应的注释！
• 注释应该是完整的句子。如果一个注释是一个短语或句子，它的第一个单词应该大写，除非它是以小写字母开头的标识符(永远不要改变标识符的大小写！)。
• 如果注释很短，结尾的句号可以省略。块注释一般由完整句子的一个或多个段落组成，并且每句话结束有个句号。
• 在句尾结束的时候应该使用两个空格。
• 当用英文书写时，遵循Strunk and White的书写风格。
• 在非英语国家的Python程序员，请使用英文写注释，除非你120%的确信你的代码不会被使用其他语言的人阅读。

块注释

• “#”号后空一格，段落件用空行分开（同样需要“#”号）

比如：

 # 块注释
 # 块注释
 #
 # 块注释
 # 块注释

行内注释

• 有节制地使用行内注释。
• 行内注释是与代码语句同行的注释。行内注释和代码至少要有两个空格分隔。注释由#和一个空格开始。
• 事实上，如果状态明显的话，行内注释是不必要的，反而会分散注意力。

文档字符串

• 要为所有的公共模块，函数，类以及方法编写文档说明。
• 非公共的方法没有必要，但是应该有一个描述方法具体作用的注释。这个注释应该在def那一行之后。
• PEP 257描述了写出好的文档说明相关的约定。特别需要注意的是，多行文档说明使用的结尾三引号应该自成一行
• 对于单行的文档说明，尾部的三引号应该和文档在同一行。

比如：

"""Return a foobang

Optional plotz says to frobnicate the bizbaz first.

"""

文件名

• 全小写,可使用下划线

包名

• 应该是简短的、小写的名字。如果下划线可以改善可读性可以加入

类名

• 类名一般使用首字母大写的约定，比如MyClass
• 在接口被文档化并且主要被用于调用的情况下，可以使用函数的命名风格代替。
• 注意，对于内置的变量命名有一个单独的约定：大部分内置变量是单个单词（或者两个单词连接在一起），首字母大写的命名法只用于异常名或者内部的常量。

函数名

• 函数名应该小写，如果想提高可读性可以用下划线分隔。
• 大小写混合仅在为了兼容原来主要以大小写混合风格的情况下使用（比如 threading.py），保持向后兼容性。

方法参数

• 始终要将 self 作为实例方法的的第一个参数。
• 始终要将 cls 作为类静态方法的第一个参数。
• 如果函数的参数名和已有的关键词冲突，在最后加单一下划线比缩写或随意拼写更好。因此 class_ 比 clss 更好。（也许最好用同义词来避免这种冲突）

变量名

• 变量名全部小写，由下划线连接各个单词
• 私有类成员使用单一下划线前缀标识，多定义公开成员，少定义私有成员

常量名

• 常量名所有字母大写，由下划线连接各个单词

编程建议

• 代码应该用不损害其他Python实现的方式去编写（PyPy，Jython，IronPython，Cython，Psyco 等）。 

比如，不要依赖于在CPython中高效的内置字符连接语句 a += b 或者 a = a + b。这种优化甚至在CPython中都是脆弱的（它只适用于某些类型）并且没有出现在不使用引用计数的实现中。在性能要求比较高的库中，可以种 ”.join() 代替。这可以确保字符关联在不同的实现中都可以以线性时间发生。

• 和像None这样的单例对象进行比较的时候应该始终用 is 或者 is not，永远不要用等号运算符。

另外，如果你在写 if x 的时候，请注意你是否表达的意思是 if x is not None。举个例子，当测试一个默认值为None的变量或者参数是否被设置为其他值的时候。这个其他值应该是在上下文中能成为bool类型false的值。

• 使用 is not 运算符，而不是 not … is 。虽然这两种表达式在功能上完全相同，但前者更易于阅读，所以优先考虑。