Python代码风格总结

冷不防 2022-12-25 01:00 207阅读 0赞

学了一点Python，感觉对代码风格不大了解，读了一遍[PEP 8 – Style Guide for Python Code | Python.org][PEP 8 _ Style Guide for Python Code _ Python.org]

*  用四个空格做缩进。不要用制表符
 *  代码行限制在 79 个字符以内，文档注释一行限制在72个字符以内。ps：中文，字符宽度一般是英文的两倍。
 *  在二元操作符的前面断行
 *  函数和类定义前面要有两个空行与其它结构分开
 *  类中方法要用一个空行分开
 *  方法/函数中，可以用空行划分逻辑代码段
 *  Python3源文件编码一律使用UTF-8，文件开头不加编码声明
 *  标准库中不要使用非默认编码
 *  模块导入，一条语句只导入一个模块
 *  导入语句应当位于文件顶部（仅在模块注释和文档字符串之后，在模块全局符号和常量之前）
 *  但首尾都是双下划线的名称定义（`__all__`, `__author__`, `__version__`等），要放在导入语句之前，文档字符串之后
 *  对于单个引号的字符串，单引号和双引号完全一样，但要保持一直
 *  对于三引号字符串，都是使用双引号括起，从而和文档字符串保持一致（PEP 257）。
 *  函数调用语句，函数名和开括号之间不要加空格
 *  if/while/for 和其后的圆括号（如果有）留一个空格`while (True):`。ps：语法上是不需要圆括号的。
 *  二元运算符两侧各留一个空格`a = 1 + 2`
 *  函数调用中，关键字实参，等号两侧不要空格 `fun(a=12, b=13)`
 *  改写代码的时候一定要同时更新注释，因为和代码不对应的注释比没有注释更糟糕
 *  公有函数、方法、类、模块要加文档注释
 *  非公有的不用写文档注释，但同样要注释描述它们的功能。（用块注释）
 *  不要用小写的l，大写的O，大写的I做单字符标识符名，因为在某些字体中这些字符无法和数字0、1区分开。
 *  模块名，要短，要全用小写，必要时可以使用下划线。包名，也是如此，而且尽量别用下划线
 *  类名通常使用 CapWords 风格
 *  函数名、全局变量名、方法名、局部变量、方法形参名都使用小写单词加下划线的风格
 *  常量：全大写，单词之间用下划线分隔。ps：Python中没有常量语法，这种风格更多是一种提示
 *  类中，不希望外部代码访问的属性和方法，用单个下划线开头。ps：这也是一种提示，
 *  类中，不希望被子类和外部访问的属性和方法，使用双下划线开头（但不要同时用双下划线结尾）  
    ps：Python会对这种标识符做名称改写，具体的规则是透明的
 *  对诸如 None 之类的单例对象的比较应当使用 is 和 is not，而不要用等于
 *  不要把lambda赋值给变量，因为lambda的本意是直接用在表达式中。

[PEP 8 _ Style Guide for Python Code _ Python.org]: https://www.python.org/dev/peps/pep-0008/