4.8 插曲: 编程风格

你准备写更长的代码，更复杂的 Python 代码片段，所以现在是一个谈论 编程风格 的好时机。大部分语言都可以写成多种风格 (更简洁，更具有格式化)。一些语言比另一些可读性更好。让其他人能更容易读懂你的代码是一个不错的注意。采用一个漂亮的代码风格帮助非常大。

大多数项目都坚持使用这样的风格，PEP 8 为了 Python 应运而生。它发扬了一种可读性非常高的，养眼的编程风格。每一个 Python 的开发者或多或少都应该读一读。下面提炼出来了最重要的几点：

  • 使用 4 个空格缩进，不要用 tab

    4 个空格在很小的缩进 (允许多层嵌套) 和很大的缩进 (容易阅读) 之间是一种很好的折中妥协。Tab 会引入混淆，最好不要用。

  • 换行，以免超出 79 个字符。

    这对使用小屏幕的用户帮助很大，而且可以在更大屏幕上并列显示多个代码文件

  • 使用空行来分隔函数和类，以及函数内部更大的代码块

  • 注释尽可能放在单独的一行

  • 使用文档字符串

  • 在操作符两侧以及冒号之后使用空格，但是在括号包围的结构内部不要直接用：a = f(1, 2) + g(3, 4)

  • 你命名的类名和函数名应该保持一致。一般的约定是，使用 CamelCase (驼峰式) 来命名类，使用 lower_case_with_underscores (小写字母加下划线) 来命名函数和方法。总是使用 self 作为第一个方法参数的名字 (更多关于类和方法，参阅 初见类)

  • 如果你的代码要用在国际环境中，不要使用花哨复杂的编码格式。Python 默认的格式，UTF-8，甚至最普通的 ASCII 在任何情况都能很好的工作

  • 如果有说其他不同语言的人会阅读或维护你的代码，即便可能性非常小，也不要在标识符中使用非 ASCII 的字符。