1. 首页
  2. Python

入门python,你应该知道的Python 风格规范(Google)

“u003Cdivu003Eu003Cpu003E本项目并非 Google 官方项目, 而是由国内程序员凭热情创建和维护。u003Cu002Fpu003Eu003Cdiv class=”pgc-img”u003Eu003Cimg src=”http:u002Fu002Fp9.pstatp.comu002Flargeu002Fdfic-imagehandleru002F85d1e228-9097-4f0b-80e8-f33c8f6a3134″ img_width=”1200″ img_height=”800″ alt=”入门python,你应该知道的Python 风格规范(Google)” inline=”0″u003Eu003Cp class=”pgc-img-caption”u003Eu003Cu002Fpu003Eu003Cu002Fdivu003Eu003Cpu003E以下代码中 u003Cstrongu003EYesu003Cu002Fstrongu003E 表示推荐,u003Cstrongu003ENou003Cu002Fstrongu003E 表示不推荐。u003Cu002Fpu003Eu003Ch1u003Eu003Cstrongu003E分号u003Cu002Fstrongu003Eu003Cu002Fh1u003Eu003Cpu003E不要在行尾加分号, 也不要用分号将两条命令放在同一行。u003Cu002Fpu003Eu003Cpu003E行长度u003Cu002Fpu003Eu003Cpu003E每行不超过80个字符u003Cu002Fpu003Eu003Cpu003E以下情况除外:u003Cu002Fpu003Eu003Colu003Eu003Cliu003E长的导入模块语句u003Cu002Fliu003Eu003Cliu003E注释里的URLu003Cu002Fliu003Eu003Cu002Folu003Eu003Cpu003E不要使用反斜杠连接行。u003Cu002Fpu003Eu003Cpu003EPython会将 圆括号, 中括号和花括号中的行隐式的连接起来 , 你可以利用这个特点. 如果需要, 你可以在表达式外围增加一对额外的圆括号。u003Cu002Fpu003Eu003Cpreu003E推荐: foo_bar(self, width, height, color=’black’, design=None, x=’foo’,u003Cbru003E emphasis=None, highlight=0)u003Cbru003E if (width == 0 and height == 0 andu003Cbru003E color == ‘red’ and emphasis == ‘strong’):u003Cbru003Eu003Cu002Fpreu003Eu003Cpu003E如果一个文本字符串在一行放不下, 可以使用圆括号来实现隐式行连接:u003Cu002Fpu003Eu003Cpreu003Ex = (‘这是一个非常长非常长非常长非常长 ‘u003Cbru003E ‘非常长非常长非常长非常长非常长非常长的字符串’)u003Cbru003Eu003Cu002Fpreu003Eu003Cpu003E在注释中,如果必要,将长的URL放在一行上。u003Cu002Fpu003Eu003Cpreu003EYes: # See details atu003Cbru003E # http:u002Fu002Fwww.example.comu002Fusu002Fdeveloperu002Fdocumentationu002Fapiu002Fcontentu002Fv2.0u002Fcsv_file_name_extension_full_specification.htmlu003Cbru003ENo: # See details atu003Cbru003E # http:u002Fu002Fwww.example.comu002Fusu002Fdeveloperu002Fdocumentationu002Fapiu002Fcontentu002Fu003Cbru003E # v2.0u002Fcsv_file_name_extension_full_specification.htmlu003Cbru003Eu003Cu002Fpreu003Eu003Cpu003E注意上面例子中的元素缩进; 你可以在本文的 :ref:`缩进 <indentation>`部分找到解释.u003Cu002Fpu003Eu003Chru003Eu003Cpu003E括号u003Cu002Fpu003Eu003Cpu003E宁缺毋滥的使用括号u003Cu002Fpu003Eu003Cpu003E除非是用于实现行连接, 否则不要在返回语句或条件语句中使用括号. 不过在元组两边使用括号是可以的.u003Cu002Fpu003Eu003Cpreu003EYes: if foo:u003Cbru003E bar()u003Cbru003E while x:u003Cbru003E x = bar()u003Cbru003E if x and y:u003Cbru003E bar()u003Cbru003E if not x:u003Cbru003E bar()u003Cbru003E return foou003Cbru003E for (x, y) in dict.items(): …u003Cbru003ENo: if (x):u003Cbru003E bar()u003Cbru003E if not(x):u003Cbru003E bar()u003Cbru003E return (foo)u003Cbru003Eu003Cu002Fpreu003Eu003Chru003Eu003Cpu003E缩进u003Cu002Fpu003Eu003Cpu003E用4个空格来缩进代码u003Cu002Fpu003Eu003Cpu003E绝对不要用tab, 也不要tab和空格混用. 对于行连接的情况, 你应该要么垂直对齐换行的元素(见 :ref:`行长度 <line_length>` 部分的示例), 或者使用4空格的悬挂式缩进(这时第一行不应该有参数):u003Cu002Fpu003Eu003Cpreu003EYes: # 与起始变量对齐u003Cbru003E foo = long_function_name(var_one, var_two,u003Cbru003E var_three, var_four)u003Cbru003E # 字典中与起始值对齐u003Cbru003E foo = {u003Cbru003E long_dictionary_key: value1 +u003Cbru003E value2,u003Cbru003E …u003Cbru003E }u003Cbru003E # 4 个空格缩进,第一行不需要u003Cbru003E foo = long_function_name(u003Cbru003E var_one, var_two, var_three,u003Cbru003E var_four)u003Cbru003E # 字典中 4 个空格缩进u003Cbru003E foo = {u003Cbru003E long_dictionary_key:u003Cbru003E long_dictionary_value,u003Cbru003E …u003Cbru003E }u003Cbru003ENo: # 第一行有空格是禁止的u003Cbru003E foo = long_function_name(var_one, var_two,u003Cbru003E var_three, var_four)u003Cbru003E # 2 个空格是禁止的u003Cbru003E foo = long_function_name(u003Cbru003E var_one, var_two, var_three,u003Cbru003E var_four)u003Cbru003E # 字典中没有处理缩进u003Cbru003E foo = {u003Cbru003E long_dictionary_key:u003Cbru003E long_dictionary_value,u003Cbru003E …u003Cbru003E }u003Cbru003Eu003Cu002Fpreu003Eu003Ch1u003Eu003Cstrongu003E空行u003Cu002Fstrongu003Eu003Cu002Fh1u003Eu003Cpu003E顶级定义之间空两行, 方法定义之间空一行u003Cu002Fpu003Eu003Cpu003E顶级定义之间空两行, 比如函数或者类定义. 方法定义, 类定义与第一个方法之间, 都应该空一行. 函数或方法中, 某些地方要是你觉得合适, 就空一行.u003Cu002Fpu003Eu003Ch1u003Eu003Cstrongu003E空格u003Cu002Fstrongu003Eu003Cu002Fh1u003Eu003Cpu003E按照标准的排版规范来使用标点两边的空格u003Cu002Fpu003Eu003Cpu003E括号内不要有空格.u003Cu002Fpu003Eu003Cpu003E按照标准的排版规范来使用标点两边的空格u003Cu002Fpu003Eu003Cpreu003EYes: spam(ham[1], {eggs: 2}, [])u003Cbru003ENo: spam( ham[ 1 ], { eggs: 2 }, [ ] )u003Cbru003Eu003Cu002Fpreu003Eu003Cpu003E不要在逗号, 分号, 冒号前面加空格, 但应该在它们后面加(除了在行尾).u003Cu002Fpu003Eu003Cpreu003EYes: if x == 4:u003Cbru003E print x, yu003Cbru003E x, y = y, xu003Cbru003ENo: if x == 4 :u003Cbru003E print x , yu003Cbru003E x , y = y , xu003Cbru003Eu003Cu002Fpreu003Eu003Cpu003E参数列表, 索引或切片的左括号前不应加空格.u003Cu002Fpu003Eu003Cpreu003EYes: spam(1)u003Cbru003Eno: spam (1)u003Cbru003EYes: dict[‘key’] = list[index]u003Cbru003ENo: dict [‘key’] = list [index]u003Cbru003Eu003Cu002Fpreu003Eu003Cpu003E在二元操作符两边都加上一个空格, 比如赋值(=), 比较(==, <, >, !=, <>, <=, >=, in, not in, is, is not), 布尔(and, or, not). 至于算术操作符两边的空格该如何使用, 需要你自己好好判断. 不过两侧务必要保持一致.u003Cu002Fpu003Eu003Cpreu003EYes: x == 1u003Cbru003ENo: x<1u003Cbru003Eu003Cu002Fpreu003Eu003Cpu003E当’=’用于指示关键字参数或默认参数值时, 不要在其两侧使用空格.u003Cu002Fpu003Eu003Cpreu003EYes: def complex(real, imag=0.0): return magic(r=real, i=imag)u003Cbru003ENo: def complex(real, imag = 0.0): return magic(r = real, i = imag)u003Cbru003Eu003Cu002Fpreu003Eu003Cpu003E不要用空格来垂直对齐多行间的标记, 因为这会成为维护的负担(适用于:, #, =等):u003Cu002Fpu003Eu003Cpreu003EYes:u003Cbru003E foo = 1000 # 注释u003Cbru003E long_name = 2 # 注释不需要对齐u003Cbru003E dictionary = {u003Cbru003E “foo”: 1,u003Cbru003E “long_name”: 2,u003Cbru003E }u003Cbru003ENo:u003Cbru003E foo = 1000 # 注释u003Cbru003E long_name = 2 # 注释不需要对齐u003Cbru003E dictionary = {u003Cbru003E “foo” : 1,u003Cbru003E “long_name”: 2,u003Cbru003E }u003Cbru003Eu003Cu002Fpreu003Eu003Ch1u003Eu003Cstrongu003EShebangu003Cu002Fstrongu003Eu003Cu002Fh1u003Eu003Cpu003E大部分.py文件不必以#!作为文件的开始. 根据 PEP-394 , 程序的main文件应该以 #!u002Fusru002Fbinu002Fpython2或者 #!u002Fusru002Fbinu002Fpython3开始.u003Cu002Fpu003Eu003Cpu003E(译者注: 在计算机科学中, Shebang (也称为Hashbang)是一个由井号和叹号构成的字符串行(#!), 其出现在文本文件的第一行的前两个字符. 在文件中存在Shebang的情况下, 类Unix操作系统的程序载入器会分析Shebang后的内容, 将这些内容作为解释器指令, 并调用该指令, 并将载有Shebang的文件路径作为该解释器的参数. 例如, 以指令#!u002Fbinu002Fsh开头的文件在执行时会实际调用u002Fbinu002Fsh程序.)u003Cu002Fpu003Eu003Cpu003E#!先用于帮助内核找到Python解释器, 但是在导入模块时, 将会被忽略. 因此只有被直接执行的文件中才有必要加入#!.u003Cu002Fpu003Eu003Ch1u003Eu003Cstrongu003E注释u003Cu002Fstrongu003Eu003Cu002Fh1u003Eu003Cpu003E确保对模块, 函数, 方法和行内注释使用正确的风格u003Cu002Fpu003Eu003Cpu003Eu003Cstrongu003E文档字符串u003Cu002Fstrongu003Eu003Cu002Fpu003Eu003Cblockquoteu003Eu003Cpu003EPython有一种独一无二的的注释方式: 使用文档字符串. 文档字符串是包, 模块, 类或函数里的第一个语句. 这些字符串可以通过对象的__doc__成员被自动提取, 并且被pydoc所用. (你可以在你的模块上运行pydoc试一把, 看看它长什么样). 我们对文档字符串的惯例是使用三重双引号”””( PEP-257 ). 一个文档字符串应该这样组织: 首先是一行以句号, 问号或惊叹号结尾的概述(或者该文档字符串单纯只有一行). 接着是一个空行. 接着是文档字符串剩下的部分, 它应该与文档字符串的第一行的第一个引号对齐. 下面有更多文档字符串的格式化规范.u003Cu002Fpu003Eu003Cu002Fblockquoteu003Eu003Cpu003Eu003Cstrongu003E模块u003Cu002Fstrongu003Eu003Cu002Fpu003Eu003Cblockquoteu003Eu003Cpu003E每个文件应该包含一个许可样板. 根据项目使用的许可(例如, Apache 2.0, BSD, LGPL, GPL), 选择合适的样板.u003Cu002Fpu003Eu003Cu002Fblockquoteu003Eu003Cpu003Eu003Cstrongu003E函数和方法u003Cu002Fstrongu003Eu003Cu002Fpu003Eu003Cblockquoteu003Eu003Cpu003E下文所指的函数,包括函数, 方法, 以及生成器.u003Cu002Fpu003Eu003Cpu003E一个函数必须要有文档字符串, 除非它满足以下条件:u003Cu002Fpu003Eu003Cu002Fblockquoteu003Eu003Culu003Eu003Cliu003E外部不可见u003Cu002Fliu003Eu003Cliu003E非常短小u003Cu002Fliu003Eu003Cliu003E简单明了u003Cu002Fliu003Eu003Cu002Fulu003Eu003Cblockquoteu003Eu003Cpu003E文档字符串应该包含函数做什么, 以及输入和输出的详细描述. 通常, 不应该描述”怎么做”, 除非是一些复杂的算法. 文档字符串应该提供足够的信息, 当别人编写代码调用该函数时, 他不需要看一行代码, 只要看文档字符串就可以了. 对于复杂的代码, 在代码旁边加注释会比使用文档字符串更有意义.u003Cu002Fpu003Eu003Cpu003E关于函数的几个方面应该在特定的小节中进行描述记录, 这几个方面如下文所述. 每节应该以一个标题行开始. 标题行以冒号结尾. 除标题行外, 节的其他内容应被缩进2个空格.u003Cu002Fpu003Eu003Cpu003EArgs:u003Cu002Fpu003Eu003Cpu003E列出每个参数的名字, 并在名字后使用一个冒号和一个空格, 分隔对该参数的描述.如果描述太长超过了单行80字符,使用2或者4个空格的悬挂缩进(与文件其他部分保持一致). 描述应该包括所需的类型和含义. 如果一个函数接受*foo(可变长度参数列表)或者**bar (任意关键字参数), 应该详细列出*foo和**bar.u003Cu002Fpu003Eu003Cpu003EReturns: (或者 Yields: 用于生成器)u003Cu002Fpu003Eu003Cpu003E描述返回值的类型和语义. 如果函数返回None, 这一部分可以省略.u003Cu002Fpu003Eu003Cpu003ERaises:u003Cu002Fpu003Eu003Cpu003E列出与接口有关的所有异常.u003Cu002Fpu003Eu003Cu002Fblockquoteu003Eu003Cpreu003Edef fetch_bigtable_rows(big_table, keys, other_silly_variable=None):u003Cbru003E “””Fetches rows from a Bigtable.u003Cbru003E Retrieves rows pertaining to the given keys from the Table instanceu003Cbru003E represented by big_table. Silly things may happen ifu003Cbru003E other_silly_variable is not None.u003Cbru003E Args:u003Cbru003E big_table: An open Bigtable Table instance.u003Cbru003E keys: A sequence of strings representing the key of each table rowu003Cbru003E to fetch.u003Cbru003E other_silly_variable: Another optional variable, that has a muchu003Cbru003E longer name than the other args, and which does nothing.u003Cbru003E Returns:u003Cbru003E A dict mapping keys to the corresponding table row datau003Cbru003E fetched. Each row is represented as a tuple of strings. Foru003Cbru003E example:u003Cbru003E {‘Serak’: (‘Rigel VII’, ‘Preparer’),u003Cbru003E ‘Zim’: (‘Irk’, ‘Invader’),u003Cbru003E ‘Lrrr’: (‘Omicron Persei 8’, ‘Emperor’)}u003Cbru003E If a key from the keys argument is missing from the dictionary,u003Cbru003E then that row was not found in the table.u003Cbru003E Raises:u003Cbru003E IOError: An error occurred accessing the bigtable.Table object.u003Cbru003E “””u003Cbru003E passu003Cbru003Eu003Cu002Fpreu003Eu003Cpu003Eu003Cstrongu003E类u003Cu002Fstrongu003Eu003Cu002Fpu003Eu003Cblockquoteu003Eu003Cpu003E类应该在其定义下有一个用于描述该类的文档字符串. 如果你的类有公共属性(Attributes), 那么文档中应该有一个属性(Attributes)段. 并且应该遵守和函数参数相同的格式.u003Cu002Fpu003Eu003Cu002Fblockquoteu003Eu003Cpreu003Eclass SampleClass(object):u003Cbru003E “””Summary of class here.u003Cbru003E Longer class information….u003Cbru003E Longer class information….u003Cbru003E Attributes:u003Cbru003E likes_spam: A boolean indicating if we like SPAM or not.u003Cbru003E eggs: An integer count of the eggs we have laid.u003Cbru003E “””u003Cbru003E def __init__(self, likes_spam=False):u003Cbru003E “””Inits SampleClass with blah.”””u003Cbru003E self.likes_spam = likes_spamu003Cbru003E self.eggs = 0u003Cbru003E def public_method(self):u003Cbru003E “””Performs operation blah.”””u003Cbru003Eu003Cu002Fpreu003Eu003Cpu003Eu003Cstrongu003E块注释和行注释u003Cu002Fstrongu003Eu003Cu002Fpu003Eu003Cblockquoteu003Eu003Cpu003E最需要写注释的是代码中那些技巧性的部分. 如果你在下次 代码审查 的时候必须解释一下, 那么你应该现在就给它写注释. 对于复杂的操作, 应该在其操作开始前写上若干行注释. 对于不是一目了然的代码, 应在其行尾添加注释.u003Cu002Fpu003Eu003Cu002Fblockquoteu003Eu003Cpreu003E# We use a weighted dictionary search to find out where i is inu003Cbru003E# the array. We extrapolate position based on the largest numu003Cbru003E# in the array and the array size and then do binary search tou003Cbru003E# get the exact number.u003Cbru003Eif i & (i-1) == 0: # true iff i is a power of 2u003Cbru003Eu003Cu002Fpreu003Eu003Cblockquoteu003Eu003Cpu003E为了提高可读性, 注释应该至少离开代码2个空格.u003Cu002Fpu003Eu003Cpu003E另一方面, 绝不要描述代码. 假设阅读代码的人比你更懂Python, 他只是不知道你的代码要做什么.u003Cu002Fpu003Eu003Cu002Fblockquoteu003Eu003Cpreu003E# BAD COMMENT: Now go through the b array and make sure whenever i occursu003Cbru003E# the next element is i+1u003Cbru003Eu003Cu002Fpreu003Eu003Ch1u003Eu003Cstrongu003E类u003Cu002Fstrongu003Eu003Cu002Fh1u003Eu003Cpu003E如果一个类不继承自其它类, 就显式的从object继承. 嵌套类也一样.u003Cu002Fpu003Eu003Cpreu003EYes: class SampleClass(object):u003Cbru003E passu003Cbru003E class OuterClass(object):u003Cbru003E class InnerClass(object):u003Cbru003E passu003Cbru003E class ChildClass(ParentClass):u003Cbru003E “””Explicitly inherits from another class already.”””u003Cbru003ENo: class SampleClass:u003Cbru003E passu003Cbru003E class OuterClass:u003Cbru003E class InnerClass:u003Cbru003E passu003Cbru003Eu003Cu002Fpreu003Eu003Cpu003E继承自 object 是为了使属性(properties)正常工作, 并且这样可以保护你的代码, 使其不受Python 3000的一个特殊的潜在不兼容性影响. 这样做也定义了一些特殊的方法, 这些方法实现了对象的默认语义, 包括 __new__, __init__, __delattr__, __getattribute__, __setattr__, __hash__, __repr__, and __str__ .u003Cu002Fpu003Eu003Ch1u003Eu003Cstrongu003E字符串u003Cu002Fstrongu003Eu003Cu002Fh1u003Eu003Cpreu003EYes: x = a + bu003Cbru003E x = ‘%s, %s!’ % (imperative, expletive)u003Cbru003E x = ‘{}, {}!’.format(imperative, expletive)u003Cbru003E x = ‘name: %s; score: %d’ % (name, n)u003Cbru003E x = ‘name: {}; score: {}’.format(name, n)u003Cbru003ENo: x = ‘%s%s’ % (a, b) # use + in this caseu003Cbru003E x = ‘{}{}’.format(a, b) # use + in this caseu003Cbru003E x = imperative + ‘, ‘ + expletive + ‘!’u003Cbru003E x = ‘name: ‘ + name + ‘; score: ‘ + str(n)u003Cbru003Eu003Cu002Fpreu003Eu003Cpu003E避免在循环中用+和+=操作符来累加字符串. 由于字符串是不可变的, 这样做会创建不必要的临时对象, 并且导致二次方而不是线性的运行时间. 作为替代方案, 你可以将每个子串加入列表, 然后在循环结束后用 .join 连接列表. (也可以将每个子串写入一个 cStringIO.StringIO 缓存中.)u003Cu002Fpu003Eu003Cpreu003EYes: items = [‘<table>’]u003Cbru003E for last_name, first_name in employee_list:u003Cbru003E items.append(‘<tr><td>%s, %s<u002Ftd><u002Ftr>’ % (last_name, first_name))u003Cbru003E items.append(‘<u002Ftable>’)u003Cbru003E employee_table = ”.join(items)u003Cbru003ENo: employee_table = ‘<table>’u003Cbru003E for last_name, first_name in employee_list:u003Cbru003E employee_table += ‘<tr><td>%s, %s<u002Ftd><u002Ftr>’ % (last_name, first_name)u003Cbru003E employee_table += ‘<u002Ftable>’u003Cbru003Eu003Cu002Fpreu003Eu003Cpu003E在同一个文件中, 保持使用字符串引号的一致性. 使用单引号’或者双引号”之一用以引用字符串, 并在同一文件中沿用. 在字符串内可以使用另外一种引号, 以避免在字符串中使用. PyLint已经加入了这一检查.u003Cu002Fpu003Eu003Cpreu003EYes:u003Cbru003E Python(‘Why are you hiding your eyes?’)u003Cbru003E Gollum(“I’m scared of lint errors.”)u003Cbru003E Narrator(‘”Good!” thought a happy Python reviewer.’)u003Cbru003ENo:u003Cbru003E Python(“Why are you hiding your eyes?”)u003Cbru003E Gollum(‘The lint. It burns. It burns us.’)u003Cbru003E Gollum(“Always the great lint. Watching. Watching.”)u003Cbru003Eu003Cu002Fpreu003Eu003Cpu003E为多行字符串使用三重双引号”””而非三重单引号”’. 当且仅当项目中使用单引号’来引用字符串时, 才可能会使用三重”’为非文档字符串的多行字符串来标识引用. 文档字符串必须使用三重双引号”””. 不过要注意, 通常用隐式行连接更清晰, 因为多行字符串与程序其他部分的缩进方式不一致.u003Cu002Fpu003Eu003Cpreu003EYes:u003Cbru003E print (“This is much nicer.u003Cbru003E”u003Cbru003E “Do it this way.u003Cbru003E”)u003Cbru003ENo:u003Cbru003E print “””This is pretty ugly.u003Cbru003E Don’t do this.u003Cbru003E “””u003Cbru003Eu003Cu002Fpreu003Eu003Ch1u003Eu003Cstrongu003E文件和socketsu003Cu002Fstrongu003Eu003Cu002Fh1u003Eu003Cpu003E在文件和sockets结束时, 显式的关闭它.u003Cu002Fpu003Eu003Cpu003E除文件外, sockets或其他类似文件的对象在没有必要的情况下打开, 会有许多副作用, 例如:u003Cu002Fpu003Eu003Colu003Eu003Cliu003E它们可能会消耗有限的系统资源, 如文件描述符. 如果这些资源在使用后没有及时归还系统, 那么用于处理这些对象的代码会将资源消耗殆尽.u003Cu002Fliu003Eu003Cliu003E持有文件将会阻止对于文件的其他诸如移动、删除之类的操作.u003Cu002Fliu003Eu003Cliu003E仅仅是从逻辑上关闭文件和sockets, 那么它们仍然可能会被其共享的程序在无意中进行读或者写操作. 只有当它们真正被关闭后, 对于它们尝试进行读或者写操作将会跑出异常, 并使得问题快速显现出来.u003Cu002Fliu003Eu003Cu002Folu003Eu003Cpu003E而且, 幻想当文件对象析构时, 文件和sockets会自动关闭, 试图将文件对象的生命周期和文件的状态绑定在一起的想法, 都是不现实的. 因为有如下原因:u003Cu002Fpu003Eu003Colu003Eu003Cliu003E没有任何方法可以确保运行环境会真正的执行文件的析构. 不同的Python实现采用不同的内存管理技术, 比如延时垃圾处理机制. 延时垃圾处理机制可能会导致对象生命周期被任意无限制的延长.u003Cu002Fliu003Eu003Cliu003E对于文件意外的引用,会导致对于文件的持有时间超出预期(比如对于异常的跟踪, 包含有全局变量等).u003Cu002Fliu003Eu003Cu002Folu003Eu003Cpu003E推荐使用 “with”语句 以管理文件:u003Cu002Fpu003Eu003Cpreu003Ewith open(“hello.txt”) as hello_file:u003Cbru003E for line in hello_file:u003Cbru003E print lineu003Cbru003Eu003Cu002Fpreu003Eu003Cpu003E对于不支持使用”with”语句的类似文件的对象,使用 contextlib.closing():u003Cu002Fpu003Eu003Cpreu003Eimport contextlibu003Cbru003Ewith contextlib.closing(urllib.urlopen(“http:u002Fu002Fwww.python.orgu002F”)) as front_page:u003Cbru003E for line in front_page:u003Cbru003E print lineu003Cbru003Eu003Cu002Fpreu003Eu003Cpu003ELegacy AppEngine 中Python 2.5的代码如使用”with”语句, 需要添加 “from __future__ import with_statement”.u003Cu002Fpu003Eu003Ch1u003Eu003Cstrongu003ETODO注释u003Cu002Fstrongu003Eu003Cu002Fh1u003Eu003Cpu003E为临时代码使用TODO注释, 它是一种短期解决方案. 不算完美, 但够好了.u003Cu002Fpu003Eu003Cpu003ETODO注释应该在所有开头处包含”TODO”字符串, 紧跟着是用括号括起来的你的名字, email地址或其它标识符. 然后是一个可选的冒号. 接着必须有一行注释, 解释要做什么. 主要目的是为了有一个统一的TODO格式, 这样添加注释的人就可以搜索到(并可以按需提供更多细节). 写了TODO注释并不保证写的人会亲自解决问题. 当你写了一个TODO, 请注上你的名字.u003Cu002Fpu003Eu003Cpreu003E# TODO(kl@gmail.com): Use a “*” here for string repetition.u003Cbru003E# TODO(Zeke) Change this to use relations.u003Cbru003Eu003Cu002Fpreu003Eu003Cpu003E如果你的TODO是”将来做某事”的形式, 那么请确保你包含了一个指定的日期(“2009年11月解决”)或者一个特定的事件(“等到所有的客户都可以处理XML请求就移除这些代码”).u003Cu002Fpu003Eu003Ch1u003Eu003Cstrongu003E导入格式u003Cu002Fstrongu003Eu003Cu002Fh1u003Eu003Cpu003E每个导入应该独占一行u003Cu002Fpu003Eu003Cpreu003EYes: import osu003Cbru003E import sysu003Cbru003ENo: import os, sysu003Cbru003Eu003Cu002Fpreu003Eu003Cpu003E导入总应该放在文件顶部, 位于模块注释和文档字符串之后, 模块全局变量和常量之前. 导入应该按照从最通用到最不通用的顺序分组:u003Cu002Fpu003Eu003Colu003Eu003Cliu003E标准库导入u003Cu002Fliu003Eu003Cliu003E第三方库导入u003Cu002Fliu003Eu003Cliu003E应用程序指定导入u003Cu002Fliu003Eu003Cu002Folu003Eu003Cpu003E每种分组中, 应该根据每个模块的完整包路径按字典序排序, 忽略大小写.u003Cu002Fpu003Eu003Cpreu003Eimport foou003Cbru003Efrom foo import baru003Cbru003Efrom foo.bar import bazu003Cbru003Efrom foo.bar import Quuxu003Cbru003Efrom Foob import aru003Cbru003Eu003Cu002Fpreu003Eu003Ch1u003Eu003Cstrongu003E语句u003Cu002Fstrongu003Eu003Cu002Fh1u003Eu003Cpu003E通常每个语句应该独占一行u003Cu002Fpu003Eu003Cpu003E不过, 如果测试结果与测试语句在一行放得下, 你也可以将它们放在同一行. 如果是if语句, 只有在没有else时才能这样做. 特别地, 绝不要对 tryu002Fexcept 这样做, 因为try和except不能放在同一行.u003Cu002Fpu003Eu003Cpreu003EYes:u003Cbru003E if foo: bar(foo)u003Cbru003ENo:u003Cbru003E if foo: bar(foo)u003Cbru003E else: baz(foo)u003Cbru003E try: bar(foo)u003Cbru003E except ValueError: baz(foo)u003Cbru003E try:u003Cbru003E bar(foo)u003Cbru003E except ValueError: baz(foo)u003Cbru003Eu003Cu002Fpreu003Eu003Ch1u003Eu003Cstrongu003E访问控制u003Cu002Fstrongu003Eu003Cu002Fh1u003Eu003Cpu003E在Python中, 对于琐碎又不太重要的访问函数, 你应该直接使用公有变量来取代它们, 这样可以避免额外的函数调用开销. 当添加更多功能时, 你可以用属性(property)来保持语法的一致性.u003Cu002Fpu003Eu003Cpu003E(译者注: 重视封装的面向对象程序员看到这个可能会很反感, 因为他们一直被教育: 所有成员变量都必须是私有的! 其实, 那真的是有点麻烦啊. 试着去接受Pythonic哲学吧)u003Cu002Fpu003Eu003Cpu003E另一方面, 如果访问更复杂, 或者变量的访问开销很显著, 那么你应该使用像 get_foo() 和 set_foo() 这样的函数调用. 如果之前的代码行为允许通过属性(property)访问 , 那么就不要将新的访问函数与属性绑定. 这样, 任何试图通过老方法访问变量的代码就没法运行, 使用者也就会意识到复杂性发生了变化.u003Cu002Fpu003Eu003Ch1u003Eu003Cstrongu003E命名u003Cu002Fstrongu003Eu003Cu002Fh1u003Eu003Cpu003Emodule_name, package_name, ClassName, method_name, ExceptionName, function_name, GLOBAL_VAR_NAME, instance_var_name, function_parameter_name, local_var_name.u003Cu002Fpu003Eu003Cpu003Eu003Cstrongu003E应该避免的名称u003Cu002Fstrongu003Eu003Cu002Fpu003Eu003Culu003Eu003Cliu003E单字符名称, 除了计数器和迭代器.u003Cu002Fliu003Eu003Cliu003E包u002F模块名中的连字符(-)u003Cu002Fliu003Eu003Cliu003E双下划线开头并结尾的名称(Python保留, 例如__init__)u003Cu002Fliu003Eu003Cu002Fulu003Eu003Cpu003Eu003Cstrongu003E命名约定u003Cu002Fstrongu003Eu003Cu002Fpu003Eu003Culu003Eu003Cliu003E所谓”内部(Internal)”表示仅模块内可用, 或者, 在类内是保护或私有的.u003Cu002Fliu003Eu003Cliu003E用单下划线(_)开头表示模块变量或函数是protected的(使用import * from时不会包含).u003Cu002Fliu003Eu003Cliu003E用双下划线(__)开头的实例变量或方法表示类内私有.u003Cu002Fliu003Eu003Cliu003E将相关的类和顶级函数放在同一个模块里. 不像Java, 没必要限制一个类一个模块.u003Cu002Fliu003Eu003Cliu003E对类名使用大写字母开头的单词(如CapWords, 即Pascal风格), 但是模块名应该用小写加下划线的方式(如lower_with_under.py). 尽管已经有很多现存的模块使用类似于CapWords.py这样的命名, 但现在已经不鼓励这样做, 因为如果模块名碰巧和类名一致, 这会让人困扰.u003Cu002Fliu003Eu003Cu002Fulu003Eu003Cpu003Eu003Cstrongu003EPython之父Guido推荐的规范u003Cu002Fstrongu003Eu003Cu002Fpu003Eu003Cpu003ETypePublicInternalModuleslower_with_under_lower_with_underPackageslower_with_under ClassesCapWords_CapWordsExceptionsCapWords Functionslower_with_under()_lower_with_under()Globalu002FClass ConstantsCAPS_WITH_UNDER_CAPS_WITH_UNDERGlobalu002FClass Variableslower_with_under_lower_with_underInstance Variableslower_with_under_lower_with_under (protected) or __lower_with_under (private)Method Nameslower_with_under()_lower_with_under() (protected) or __lower_with_under() (private)Functionu002FMethod Parameterslower_with_under Local Variableslower_with_underu003Cu002Fpu003Eu003Cpu003EMainu003Cu002Fpu003Eu003Cpu003E即使是一个打算被用作脚本的文件, 也应该是可导入的. 并且简单的导入不应该导致这个脚本的主功能(main functionality)被执行, 这是一种副作用. 主功能应该放在一个main()函数中.u003Cu002Fpu003Eu003Cpu003E在Python中, pydoc以及单元测试要求模块必须是可导入的. 你的代码应该在执行主程序前总是检查 if __name__ == ‘__main__’ , 这样当模块被导入时主程序就不会被执行.u003Cu002Fpu003Eu003Cpreu003Edef main():u003Cbru003E …u003Cbru003Eif __name__ == ‘__main__’:u003Cbru003E main()u003Cbru003Eu003Cu002Fpreu003Eu003Cpu003E所有的顶级代码在模块导入时都会被执行. 要小心不要去调用函数, 创建对象, 或者执行那些不应该在使用pydoc时执行的操作。u003Cu002Fpu003Eu003Cpu003Eu003Cstrongu003E最后:如果你正在学习Python的路上,或者准备打算学习Python、那么小编这套学习教程免费赠送给你喔!绝对零套路 零收费!u003Cu002Fstrongu003Eu003Cu002Fpu003Eu003Cpu003E你正好需要、我正好有、就是这么完美的事情u003Cu002Fpu003Eu003Ch1u003Eu003Cstrongu003E你只需转发本文,然后私信小编“资料”即可马上领取400python学习教程!!u003Cu002Fstrongu003Eu003Cu002Fh1u003Eu003Cdiv class=”pgc-img”u003Eu003Cimg src=”http:u002Fu002Fp1.pstatp.comu002Flargeu002Fpgc-imageu002F6cbf3e8e1b234491b04bdbc53e07158d” img_width=”481″ img_height=”761″ alt=”入门python,你应该知道的Python 风格规范(Google)” inline=”0″u003Eu003Cp class=”pgc-img-caption”u003Eu003Cu002Fpu003Eu003Cu002Fdivu003Eu003Cu002Fdivu003E”

原文始发于:入门python,你应该知道的Python 风格规范(Google)

主题测试文章,只做测试使用。发布者:醒百年,转转请注明出处:http://www.cxybcw.com/13662.html

联系我们

13687733322

在线咨询:点击这里给我发消息

邮件:1877088071@qq.com

工作时间:周一至周五,9:30-18:30,节假日休息

QR code