参考
分号
- 不要在行尾加分号, 也不要用分号将两条命令放在同一行
行长度
- 每行不超过80 个字符
<pre><code>Python 会将圆括号, 中括号和花括号中的行隐式的连接起来, 你可以利用这个特点. 如
果需要, 你可以在表达式外围增加一对额外的圆括号.
Yes:
foo_bar(self, width, height, color='black', design=None, x='foo',
emphasis=None, highlight=0)
if (width == 0 and height == 0 and
color == 'red' and emphasis == 'strong'):
如果一个文本字符串在一行放不下, 可以使用圆括号来实现隐式行连接:
x = ('This will build a very long long '
'long long long long long long string')
对于注释，如果有必要，尽可能的将整个路径放在一行
Yes:
See details at #http://www.example.com/us/developer/documentation/api/content/v2.0/csv_file_name_extension_full_specification.html
No:
See details at
http://www.example.com/us/developer/documentation/api/content/\
v2.0/csv_file_name_extension_full_specification.html</code></pre>
括号
- 宁缺毋滥的使用括号
<pre><code>除非是用于实现行连接, 否则不要在返回语句或条件语句中使用括号. 不过在元组两边使用
括号是可以的.
Yes:
if foo:
bar()
while x:
x = bar()
if x and y:
bar()
if not x:
bar()
return foo
for (x, y) in dict.items(): ...
No:
if (x):
bar()
if not(x):
bar()
return (foo)
4
bar()
return foo
for (x, y) in dict.items(): ...
No: if (x):
bar()
if not(x):
bar()
return (foo)</code></pre>
缩进
- 用 4 个空格来缩进代码
<pre><code>绝对不要用tab, 也不要tab 和空格混用. 对于行连接的情况, 你应该要么垂直对齐换行的
元素(见 行长度 部分的示例), 或者使用4 空格的悬挂式缩进(这时第一行不应该有参数):
Yes:
Aligned with opening delimiter
foo = long_function_name(var_one, var_two,
var_three, var_four)
4-space hanging indent; nothing on first line
foo = long_function_name(
var_one, var_two, var_three,
var_four)
No:
Stuff on first line forbidden
foo = long_function_name(var_one, var_two,
var_three, var_four)
2-space hanging indent forbidden
foo = long_function_name(
var_one, var_two, var_three,
var_four)</code></pre>
空行
- 顶级定义之间空两行, 方法定义之间空一行
<pre><code>顶级定义之间空两行, 比如函数或者类定义. 方法定义, 类定义与第一个方法之间, 都应该
空一行. 函数或方法中, 某些地方要是你觉得合适, 就空一行.</code></pre>
空格
- 按照标准的排版规范来使用标点两边的空格
<pre><code>1 括号内不要有空格.
Yes:
spam(ham[1], {eggs: 2}, [])
No:
spam( ham[ 1 ], { eggs: 2 }, [ ] )
2 不要在逗号, 分号, 冒号前面加空格, 但应该在它们后面加(除了在行尾).
Yes:
if x == 4:
print x, y
x, y = y, x
No:
if x == 4 :
print x , y
x , y = y , x
3 参数列表, 索引或切片的左括号前不应加空格.
Yes:
spam(1)
Yes:
spam (1)
Yes:
dict['key'] = list[index]
No:
dict ['key'] = list [index]
4 在二元操作符两边都加上一个空格, 比如赋值(=), 比较(==, <, >, !=, <>, <=, >=, in, not
in, is, is not), 布尔(and, or, not). 至于算术操作符两边的空格该如何使用, 需要你自己
好好判断. 不过两侧务必要保持一致.
Yes:
x == 1
No:
x<1
5 当’=’用于指示关键字参数或默认参数值时, 不要在其两侧使用空格.
Yes:
def complex(real, imag=0.0): return magic(r=real, i=imag)
No: def complex(real, imag = 0.0): return magic(r = real, i = imag)
6 不要用空格来垂直对齐多行间的标记, 因为这会成为维护的负担(适用于:, #, =等):
Yes:
foo = 1000 # comment
long_name = 2 # comment that should not be aligned
dictionary = {
"foo": 1,
"long_name": 2,
}
No:
foo = 1000 # comment
long_name = 2 # comment that should not be aligned
dictionary = {
"foo" : 1,
"long_name": 2,
}</code></pre>
Python 解释器
- 每个模块都应该以#!/usr/bin/env python<version>开头
<pre><code>模块应该以一个构造行开始, 以指定执行这个程序用到的Python 解释器:
!/usr/bin/env python2.4
总是使用最特化的版本, 例如, 使用/usr/bin/python2.4, 而不是 /usr/bin/python2. 这样,
当升级到不同的Python 版本时, 能轻松找到依赖关系, 同时也避免了使用时的迷惑. 例如,
/usr/bin/python2 是表示/usr/bin/python2.0.1 还是/usr/bin/python2.3.0</code></pre>
注释
- 确保对模块, 函数, 方法和行内注释使用正确的风格
<pre><code>文档字符串
Python 有一种独一无二的的注释方式: 使用文档字符串. 文档字符串是包, 模块, 类或函数
里的第一个语句. 这些字符串可以通过对象的doc成员被自动提取, 并且被pydoc 所
用. (你可以在你的模块上运行pydoc 试一把, 看看它长什么样). 我们对文档字符串的惯例
是使用三重双引号. 一个文档字符串应该这样组织: 首先是一行以句号, 问号或惊叹号结尾
的概述. 接着是一个空行. 接着是文档字符串剩下的部分, 它应该与文档字符串的第一行的
第一个引号对齐. 下面有更多文档字符串的格式化规范.
模块
每个文件应该包含下列项, 依次是:
1 版权声明(例如, Copyright 2008 Google Inc.)
2 一个许可样板. 根据项目使用的许可(例如, Apache 2.0, BSD, LGPL, GPL), 选择合适
的样板
3 作者声明, 标识文件的原作者</code></pre>
函数和方法
<pre><code>如果不是既显然又简短, 任何函数或方法都需要一个文档字符串. 而且, 任何外部可访问的
函数或方法, 不管多短多简单, 都需要文档字符串. 文档字符串应该包含函数做什么, 以及
输入和输出的详细描述. 通常, 不应该描述”怎么做”, 除非是一些复杂的算法. 对于技巧
性的代码, 块注释或者行内注释是最重要的. 文档字符串应该提供足够的信息, 当别人编写
代码调用该函数时, 他不需要看一行代码, 只要看文档字符串就可以了. 应该给参数单独写
文档. 在冒号后跟上解释, 而且应该用统一的悬挂式2 或4空格缩进. 文档字符串应该在需要
特定类型的地方指定期望的类型. “Raise:”部分应该列出该函数可能触发的所有异常. 生
成器函数的文档字符串应该用”Yields:”而非”Returns:”.
def fetch_bigtable_rows(big_table, keys, other_silly_variable=None):
"""Fetches rows from a Bigtable.
Retrieves rows pertaining to the given keys from the Table instance
represented by big_table. Silly things may happen if
other_silly_variable is not None.
Args:
big_table: An open Bigtable Table instance.
keys: A sequence of strings representing the key of each table row
to fetch.
other_silly_variable: Another optional variable, that has a much
longer name than the other args, and which does nothing.
Returns：
A dict mapping keys to the corresponding table row data
fetched. Each row is represented as a tuple of strings. For
example:
{'Serak': ('Rigel VII', 'Preparer'),
'Zim': ('Irk', 'Invader'),
'Lrrr': ('Omicron Persei 8', 'Emperor')}
If a key from the keys argument is missing from the dictionary,
then that row was not found in the table.
Raises:
IOError: An error occurred accessing the bigtable.Table object.
"""
pass
类(classes)
类应该在其定义下有一个用于描述该类的文档字符串. 如果你的类有公共属性
(Attributes), 那么文档中应该有一个属性(Attributes)段. 并且应该遵守和函数参数相
同的格式.
class SampleClass(object):
"""Summary of class here.
Longer class information....
Longer class information....
Attributes:
likes_spam: A boolean indicating if we like SPAM or not.
eggs: An integer count of the eggs we have laid.
"""
def init(self, likes_spam=False):
"""Inits SampleClass with blah."""
self.likes_spam = likes_spam
self.eggs = 0
def public_method(self):
"""Performs operation blah."""
块注释和行注释(Block and Inline Comments)
最需要写注释的是代码中那些技巧性的部分. 如果你在下次代码走查的时候必须解释一
下, 那么你应该现在就给它写注释. 对于复杂的操作, 应该在其操作开始前写上若干行
注释. 对于不是一目了然的代码, 应在其行尾添加注释.
# We use a weighted dictionary search to find out where i is in
# the array. We extrapolate position based on the largest num
# in the array and the array size and then do binary search to
# get the exact number.
if i & (i-1) == 0: # true iff i is a power of 2
为了提高可读性, 注释应该至少离开代码2 个空格.
另一方面, 绝不要描述代码. 假设阅读代码的人比你更懂Python, 他只是不知道你的代码要
做什么.
BAD COMMENT: Now go through the b array and make sure whenever i occurs
the next element is i+1</code></pre>
类
- 如果一个类不继承自其它类, 就显式的从object 继承. 嵌套类也一样.
<pre><code>No:
class SampleClass:
pass
class OuterClass:
class InnerClass:
pass
Yes:
class SampleClass(object):
pass
class OuterClass(object):
class InnerClass(object):
pass
class ChildClass(ParentClass):
"""Explicitly inherits from another class already."""
继承自 object 是为了使属性(properties)正常工作, 并且这样可以保护你的代码, 使其不
受Python 3000 的一个特殊的潜在不兼容性影响. 这样做也定义了一些特殊的方法, 这些方
法实现了对象的默认语义, 包括 new, init, delattr, getattribute,
setattr, hash, repr, and str .</code></pre>
字符串
- 用%操作符格式化字符串, 即使参数都是字符串. 不过也不能一概而论, 你需要在+和%
之间好好判定.
<pre><code>No:
x = '%s%s' % (a, b) # use + in this case
x = imperative + ', ' + expletive + '!'
x = 'name: ' + name + '; score: ' + str(n)
Yes:
x = a + b
x = '%s, %s!' % (imperative, expletive)
x = 'name: %s; score: %d' % (name, n)
避免在循环中用+和+=操作符来累加字符串. 由于字符串是不可变的, 这样做会创建不必要
的临时对象, 并且导致二次方而不是线性的运行时间. 作为替代方案, 你可以将每个子串加
入列表, 然后在循环结束后用 .join 连接列表. (也可以将每个子串写入一个
cStringIO.StringIO 缓存中.)
No:
employee_table = ' '
for last_name, first_name in employee_list:
employee_table += '%s, %s'% (last_name, first_name)
employee_table += ' '
Yes:
items = [' ']
for last_name, first_name in employee_list:
items.append('%s, %s' % (last_name, first_name))
items.append(' ')
employee_table = ''.join(items)
为多行字符串使用三重双引号而非三重单引号. 不过要注意, 通常用隐式行连接更清晰, 因
为多行字符串与程序其他部分的缩进方式不一致.
No:
print """This is pretty ugly.
Don't do this.
"""
Yes:
print ("This is much nicer.\n"
"Do it this way.\n")</code></pre>
TODO 注释
- 为临时代码使用TODO 注释, 它是一种短期解决方案. 不算完美, 但够好了.
<pre><code>TODO 注释应该在所有开头处包含”TODO”字符串, 紧跟着是用括号括起来的你的名字,
email 地址或其它标识符. 然后是一个可选的冒号. 接着必须有一行注释, 解释要做什么. 主
要目的是为了有一个统一的TODO 格式, 这样添加注释的人就可以搜索到(并可以按需提供
更多细节). 写了TODO 注释并不保证写的人会亲自解决问题.
TODO(kl@gmail.com): Drop the use of "has_key".
TODO(Zeke) change this to use relations.
如果你的TODO 是”将来做某事”的形式, 那么请确保你包含了一个指定的日期(“2009 年
11 月解决”)或者一个特定的事件(“等到所有的客户都可以处理XML 请求就移除这些代
码”).</code></pre>
导入格式
- 每个导入应该独占一行
<pre><code>Yes:
import os
import sys
No:
import os, sys
导入总应该放在文件顶部, 位于模块注释和文档字符串之后, 模块全局变量和常量之前. 导
入应该按照从最通用到最不通用的顺序分组:
1 标准库导入
2 第三方库导入
3 应用程序指定导入
4 每种分组中, 应该根据每个模块的完整包路径按字典序排序, 忽略大小写.
import foo
from foo import bar
from foo.bar import baz
from foo.bar import Quux
from Foob import ar</code></pre>
语句
- 通常每个语句应该独占一行
<pre><code>不过, 如果测试结果与测试语句在一行放得下, 你也可以将它们放在同一行. 如果是if 语句,
只有在没有else 时才能这样做. 特别地, 绝不要对 try/except 这样做, 因为try 和except
不能放在同一行.
Yes:
if foo: bar(foo)
No:
if foo: bar(foo)
else: baz(foo)
try: bar(foo)
except ValueError: baz(foo)
try:
bar(foo)
except ValueError: baz(foo)</code></pre>
访问控制
- 在 Python 中, 对于琐碎又不太重要的访问函数, 你应该直接使用公有变量来取代它们,
这样可以避免额外的函数调用开销. 当添加更多功能时, 你可以用属性(property)来保
持语法的一致性.
<pre><code>(译者注: 重视封装的面向对象程序员看到这个可能会很反感, 因为他们一直被教育: 所有成员变量都必须是私有的! 其实, 那真的是有点麻烦啊. 试着去
接受Pythonic 哲学吧)另一方面, 如果访问更复杂, 或者变量的访问开销很显著, 那么你应该使用像 get_foo() 和set_foo() 这样的函数调用. 如果
之前的代码行为允许通过属性(property)访问 , 那么就不要将新的访问函数与属性绑定. 这样, 任何试图通过老方法访问变量的代码就没法运行, 使用者
也就会意识到复杂性发生了变化.</code></pre>
命名
<pre><code>module_name, package_name,
ClassName, method_name, ExceptionName, function_name,
GLOBAL_VAR_NAME,
instance_var_name, function_parameter_name, local_var_name.
应该避免的名称
- 单字母名称, 除了计数器和迭代器.
- 包/模块名中的连字符(-)
- 双下划线开头并结尾的名称(Python 保留, 例如init)
命名约定 - 所谓”内部(Internal)”表示仅模块内可用, 或者, 在类内是保护或私有的.
- 用单下划线(_)开头表示模块变量或函数是protected 的(使用import * from
时不会包含). - 用双下划线(__)开头的实例变量或方法表示类内私有.
- 将相关的类和顶级函数放在同一个模块里. 不像Java, 没必要限制一个类一
个模块. - 对类名使用大写字母开头的单词(如CapWords, 即Pascal 风格), 但是模块
名应该用小写加下划线的方式(如lower_with_under.py). 尽管已经有很多
现存的模块使用类似于CapWords.py 这样的命名, 但现在已经不鼓励这样
做, 因为如果模块名碰巧和类名一致, 这会让人困扰.
Python 之父Guido 推荐的规范
Type Public Internal
Modules lower_with_under _lower_with_under
Packages lower_with_under
Classes CapWords _CapWords
Exceptions CapWords
Functions lower_with_under() _lower_with_under()
Global/Class Constants CAPS_WITH_UNDER _CAPS_WITH_UNDER
Global/Class Variables lower_with_under _lower_with_under
Instance Variables lower_with_under _lower_with_under (protected) or __lower_with_under (private)
Method Names lower_with_under() _lower_with_under() (protected) or __lower_with_under()(private)
Function/Method Parameters lower_with_under
Local Variables lower_with_under
Main
即使是一个打算被用作脚本的文件, 也应该是可导入的. 并且简单的导入不应该导致这
个脚本的主功能(main functionality)被执行, 这是一种副作用. 主功能应该放在一个
main()函数中.
在Python 中, pychecker, pydoc 以及单元测试要求模块必须是可导入的. 你的代码应该
在执行主程序前总是检查 if name == 'main' , 这样当模块被导入时主程序就不会
被执行.
def main():
...
if name == 'main':
main()
所有的顶级代码在模块导入时都会被执行. 要小心不要去调用函数, 创建对象, 或者执行那
些不应该在使用pychecker 或pydoc 时执行的操作.</code></pre>
