PEP8

对于 Python,PEP 8 已经呈现了大多数项目遵循的风格; 它宣传了一种十分可读而悦目的代码风格。每个 Python 开发者都应当在某个时刻阅读它; 这里为你萃取了最重要的几点:

  • 使用 4-空格 缩进,且没有制表符。4 空格是在小缩进 (允许更多嵌套) 和大缩进 (更易读) 之间的好的妥协。制表符会带来混乱,最好不要使用。
  • 设定自动换行,使它们不超过 79 个字符。这会帮助小屏幕的用户,而且使得可以在大屏幕上同时显示几个代码文件成为可能。
  • 使用空行分隔函式和类,以及函式中的大的代码块。
  • 尽可能令注释独占一行。
  • 使用文档字串。
  • 在操作符两边,逗号后面使用空格,但是括号内部与括号之间直接相连的部分不要空格: a = f(1,2) + g(3,4)
  • 保持类名和函式名的一致性:类名使用 CamelCase 格式,方法名和函式名使用 lower_case_with_underscres 形式。永远使用 self 作为方法的第一个参数名。
  • 若代码打算用在国际化的环境中,那么不要使用奇特的编码。Python 默认的 UTF-8,或者甚至是简单的 ASCII 在任何情况下工作得最好。
  • 同样地,如果代码的读者或维护者只有很小的概率使用不同的语言,那么不要在标识符里使用非ASCII字符。

命名规范

Type Public Internal
模块 lower_with_under _lower_with_under
lower_with_under
CapWords _CapWords
异常 CapWords
函数 lower_with_under() _lower_with_under()
全局/类 常量 CAPS_WITH_UNDER _CAPS_WITH_UNDER
全局/类 变量 lower_with_under _lower_with_under
实例化对象 lower_with_under _lower_with_under (protected) or __lower_with_under (private)
方法名 lower_with_under() _lower_with_under() (protected) or __lower_with_under() (private)
函数/方法 参数 lower_with_under
局部变量 lower_with_under

深入阅读

  1. PEP8
  2. PEP287
  3. Google Python 风格指南