与命名有关的建议

PEP 8 建议采用不同的方式来给 Python 代码中的各个部分命名,这样在阅读代码时,就可以根据这些名称看出它们在 Python 语言中的角色。遵循以下与命名相关的建议。

  • 函数、变量及属性用小写字母来拼写,各单词之间用下划线相连,例如:lowercase_underscore
  • 受保护的实例属性,用一个下划线开头,例如:_leading_underscore
  • 私有的实例属性,用两个下划线开头,例如:__double_leading_underscore
  • 类(包括异常)命名时,每个单词的首字母均大写,例如:CapitalizedWord
  • 模块级别的常量,所有字母都大写,各单词之间用下划线相连,例如:ALL_CAPS
  • 类中的实例方法,应该把第一个参数命名为 self,用来表示该对象本身。
  • 类方法的第一个参数,应该命名为 cls,用来表示这个类本身。

与表达式和语句有关的建议

  • 多行的表达式,应该用括号括起来,而不要用\符号续行。