Python编程语言PEP8规范

1. 分号:

- 不要在行尾加分号, 也不要用分号将两条命令放在同一行。

2. 行长度:

  • 每行不超过80个字符(长的导入模块语句和注释里的URL除外)
  • 不要使用反斜杠连接行。Python会将圆括号, 中括号和花括号中的行隐式的连接起来 :
- 推荐: foo_bar(self, width, height, color='black', design=None, x='foo',       emphasis=None, highlight=0)
  • 如果一个文本串不能排成一行,可以使用括号来实现隐式的行连接:
    [En]

    if a text string cannot fit on one line, you can use parentheses to achieve implicit line concatenation:*

x = ('这是一个非常长非常长非常长非常长 '     '非常长非常长非常长非常长非常长非常长的字符串')
  • 在注释中,如果必要,将长的URL放在一行上。
Yes:  # See details at      # http://www.example.com/us/developer/documentation/api/content/v2.0/csv_file_name_extension_full_specification.html

3. 括号

最好使用括号,而不是过度使用。不要在RETURN语句或条件语句中使用括号,除非它们用于实现行联接。但是,可以在元组的两侧使用圆括号。

[En]

It is better to use parentheses rather than excessively. Do not use parentheses in return statements or conditional statements unless they are used to implement row joins. However, it is possible to use parentheses on both sides of the tuple.

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. 缩进

用4个空格来缩进代码,不要用tab, 也不要tab和空格混用. 对于行连接的情况, 你应该要么垂直对齐换行的元素(见 :ref:​ &#x200B;&#x884C;&#x957F;&#x5EA6; <line_length>&#x200B;</line_length>​ 部分的示例), 或者使用4空格的悬挂式缩进(这时第一行不应该有参数):

Yes:   # 与起始变量对齐       foo = long_function_name(var_one, var_two,                                var_three, var_four)       # 字典中与起始值对齐       foo = {           long_dictionary_key: value1 +                                value2,           ...       }       # 4 个空格缩进,第一行不需要       foo = long_function_name(           var_one, var_two, var_three,           var_four)       # 字典中 4 个空格缩进       foo = {           long_dictionary_key:               long_dictionary_value,           ...       }

5. 空行

顶级定义之间空2行, 方法定义之间空1行,顶级定义之间空两行, 比如函数或者类定义. 方法定义, 类定义与第一个方法之间, 都应该空一行. 函数或方法中, 某些地方要是你觉得合适, 就空一行.

6. 空格

  • 标点符号两侧按标准排版规范使用空格,括号内不留空格,标点符号两侧按标准排版规范使用空格
    [En]

    use spaces on both sides of punctuation in accordance with standard typesetting norms, with no spaces in parentheses, and use spaces on both sides of punctuation in accordance with standard typesetting specifications*

Yes: spam(ham[1], {eggs: 2}, [])No:  spam( ham[ 1 ], { eggs: 2 }, [ ] )
  • 不要在逗号, 分号, 冒号前面加空格, 但应该在它们后面加(除了在行尾).
Yes: if x == 4:         print x, y     x, y = y, xNo:  if x == 4 :         print x , y     x , y = y , x
  • 参数列表, 索引或切片的左括号前不应加空格.
Yes: spam(1)no: spam (1)Yes: dict['key'] = list[index]No:  dict ['key'] = list [index]
  • 在二元操作符两边都加上一个空格, 比如赋值(=), 比较(==,
Yes: x == 1No:  x
  • 当’=’用于指示关键字参数或默认参数值时, 不要在其两侧使用空格.
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)
  • 不要用空格来垂直对齐多行间的标记, 因为这会成为维护的负担(适用于:, #, =等):
Yes: foo = 1000  # 注释     long_name = 2  # 注释不需要对齐     dictionary = {         "foo": 1,         "long_name": 2,         }No: foo       = 1000  # 注释     long_name = 2     # 注释不需要对齐     dictionary = {         "foo"      : 1,         "long_name": 2,         }

7. 注释

  • 文档字符串:
    Python有一种独一无二的的注释方式: 使用文档字符串。文档字符串是包, 模块, 类或函数里的第一个语句. 这些字符串可以通过对象的__doc__成员被自动提取, 并且被pydoc所用。
    文档字符串的约定是使用三重双引号。
    [En]

    The convention for document strings is to use triple double quotation marks.

  • 函数和方法:
    每一节都应该以标题行开头。标题行以冒号结束。除标题行外,该部分的其他内容应缩进2个空格。
    [En]

    Each section should begin with a title line. The title line ends with a colon. Except for the title line, the other contents of the section should be indented by 2 spaces.

列出每个参数的名字, 并在名字后使用一个冒号和一个空格, 分隔对该参数的描述.如果描述太长超过了单行80字符,使用2或者4个空格的悬挂缩进(与文件其他部分保持一致). 描述应该包括所需的类型和含义. 如果一个函数接受 _foo(可变长度参数列表)或者bar (任意关键字参数), 应该详细列出_foo和bar.

Returns: (或者 Yields: 用于生成器)
描述返回值的类型和语义. 如果函数返回None, 这一部分可以省略.

Raises:
列出与接口相关的所有例外。

[En]

Lists all exceptions related to the interface.

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
  • 类:
    类应该在其定义下有一个用于描述该类的文档字符串. 如果你的类有公共属性(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."""
  • 块注释和行注释:
    最需要评论的是代码中巧妙的部分。如果您必须在下一次代码审查时解释它,那么您现在就应该对其进行注释。对于复杂的操作,在操作开始之前应该写几行注释。对于一目了然的代码,您应该在行尾添加注释。为了提高可读性,注释应该在代码中至少留出2个空格。
    [En]

    What needs to be commented most are the skillful parts of the code. If you have to explain it at the next code review, you should comment it now. For complex operations, several lines of comments should be written before the operation begins. For code that is not clear at a glance, you should add comments at the end of the line. To improve readability, comments should leave at least 2 spaces in the code.

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

8、类:

如果一个类不继承自其它类, 就显式的从object继承. 嵌套类也一样.

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 .

9、字符串:

Yes: x = a + b     x = '%s, %s!' % (imperative, expletive)     x = '{}, {}!'.format(imperative, expletive)     x = 'name: %s; score: %d' % (name, n)     x = 'name: {}; score: {}'.format(name, n)     No: x = '%s%s' % (a, b)  # use + in this case    x = '{}{}'.format(a, b)  # use + in this case    x = imperative + ', ' + expletive + '!'    x = 'name: ' + name + '; score: ' + str(n)

避免在循环中用+和+=操作符来字符串拼接. 由于字符串是不可变的, 这样做会创建不必要的临时对象, 并且导致二次方而不是线性的运行时间. 作为替代方案, 你可以将每个子串加入列表, 然后在循环结束后用 ” .join(列表对象,连接符号) 连接列表. (也可以将每个子串写入一个 cStringIO.StringIO 缓存中.)

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: employee_table = ''    for last_name, first_name in employee_list:        employee_table += '%s, %s' % (last_name, first_name)    employee_table += ''

在同一个文件中, 保持使用字符串引号的一致性. 使用单引号’或者双引号”之一用以引用字符串, 并在同一文件中沿用. 在字符串内可以使用另外一种引号, 以避免在字符串中使用. PyLint已经加入了这一检查.

Yes:     Python('Why are you hiding your eyes?')     Gollum("I'm scared of lint errors.")     Narrator('"Good!" thought a happy Python reviewer.')No:     Python("Why are you hiding your eyes?")     Gollum('The lint. It burns. It burns us.')     Gollum("Always the great lint. Watching. Watching.")

对于多行字符串,请使用三重双引号而不是三重单引号。当且仅当在项目中使用单引号来引用字符串时,才可以使用带有三重‘’的多行字符串作为非文档字符串来标识引用。文档字符串必须使用三重双引号。但是,请注意,这种连接通常使用隐式行更为清晰,因为多行字符串与程序其余部分的缩进不一致。

[En]

Use triple double quotation marks instead of triple single quotation marks for multiline strings. When and only if single quotation marks are used in the project to reference strings, it is possible to use multiline strings with triple”as non-document strings to identify references. Document strings must use triple double quotation marks. Note, however, that concatenation is usually clearer with implicit lines, because multiline strings are inconsistent with the indentation of the rest of the program.

Yes:    print ("This is much nicer.\n"           "Do it this way.\n")No:      print """This is pretty ugly.  Don't do this.  """

10、文件和sockets

在文件和sockets结束时, 需要显式的关闭它.
除文件外, sockets或其他类似文件的对象在没有必要的情况下打开, 会有许多副作用, 例如:
它们可能会消耗有限的系统资源,例如文件描述符。如果这些资源在使用后没有及时返回系统,则用于处理这些对象的代码将耗尽资源。

[En]

They may consume limited system resources, such as file descriptors. If these resources are not returned to the system in time after use, the code used to deal with these objects will run out of resources.

保留文件将阻止其他操作,如移动和删除文件。

[En]

Holding a file will prevent other operations such as moving and deleting the file.

仅仅是从逻辑上关闭文件和sockets, 那么它们仍然可能会被其共享的程序在无意中进行读或者写操作. 只有当它们真正被关闭后, 对于它们尝试进行读或者写操作将会跑出异常, 并使得问题快速显现出来.

而且, 幻想当文件对象析构时, 文件和sockets会自动关闭, 试图将文件对象的生命周期和文件的状态绑定在一起的想法, 都是不现实的. 因为有如下原因:
没有任何方法可以确保运行环境会真正的执行文件的析构. 不同的Python实现采用不同的内存管理技术, 比如延时垃圾处理机制. 延时垃圾处理机制可能会导致对象生命周期被任意无限制的延长.

对于文件意外的引用,会导致对于文件的持有时间超出预期(比如对于异常的跟踪, 包含有全局变量等).

推荐使用 "with"语句 以管理文件:with open("hello.txt") as hello_file:    for line in hello_file:        print line对于不支持使用"with"语句的类似文件的对象,使用 contextlib.closing():import contextlibwith contextlib.closing(urllib.urlopen("http://www.python.org/")) as front_page:    for line in front_page:        print line

11、TODO注释:

为临时代码使用TODO注释, 它是一种短期解决方案. 不算完美, 但够好了.

TODO注释应该在所有开头处包含”TODO”字符串, 紧跟着是用括号括起来的你的名字, email地址或其它标识符. 然后是一个可选的冒号. 接着必须有一行注释, 解释要做什么. 主要目的是为了有一个统一的TODO格式, 这样添加注释的人就可以搜索到(并可以按需提供更多细节). 写了TODO注释并不保证写的人会亲自解决问题. 当你写了一个TODO, 请注上你的名字.

TODO(kl@gmail.com): Use a "*" here for string repetition.# TODO(Zeke) Change this to use relations.

如果你的TODO是”将来做某事”的形式, 那么请确保你包含了一个指定的日期(“2009年11月解决”)或者一个特定的事件(“等到所有的客户都可以处理XML请求就移除这些代码”).

12、导入格式:

每个导入应该独占一行

Yes: import os     import sysNo:  import os, sys

导入总应该放在文件顶部, 位于模块注释和文档字符串之后, 模块全局变量和常量之前. 导入应该按照从最通用到最不通用的顺序分组:
标准库导入
第三方库导入
应用程序指定导入
每种分组中, 应该根据每个模块的完整包路径按字典序排序, 忽略大小写.

import foofrom foo import barfrom foo.bar import bazfrom foo.bar import Quuxfrom Foob import ar

13、语句:

通常,每条语句都应该有唯一的一行。但是,如果测试结果和测试语句位于同一行,则也可以将它们放在同一行。

[En]

Usually each statement should have a unique line. However, if the test results and test statements fit on one line, you can also put them on the same line.

如果是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)

13、访问控制:

在Python中, 对于琐碎又不太重要的访问函数, 你应该直接使用公有变量来取代它们, 这样可以避免额外的函数调用开销. 当添加更多功能时, 你可以用属性(property)来保持语法的一致性.

(译者注: 重视封装的面向对象程序员看到这个可能会很反感, 因为他们一直被教育: 所有成员变量都必须是私有的! 其实, 那真的是有点麻烦啊. 试着去接受Pythonic哲学吧)
另一方面, 如果访问更复杂, 或者变量的访问开销很显著, 那么你应该使用像 get_foo() 和 set_foo() 这样的函数调用. 如果之前的代码行为允许通过属性(property)访问 , 那么就不要将新的访问函数与属性绑定. 这样, 任何试图通过老方法访问变量的代码就没法运行, 使用者也就会意识到复杂性发生了变化.

14、命名:

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推荐的规范:

Python编程语言PEP8规范

15、Main:

即使是一个打算被用作脚本的文件, 也应该是可导入的. 并且简单的导入不应该导致这个脚本的主功能(main functionality)被执行, 这是一种副作用. 主功能应该放在一个main()函数中.

在Python中, pydoc以及单元测试要求模块必须是可导入的. 你的代码应该在执行主程序前总是检查 if name == ‘ main‘ , 这样当模块被导入时主程序就不会被执行.

def main():      ...if __name__ == '__main__':    main()

所有的顶级代码在模块导入时都会被执行. 要小心不要去调用函数, 创建对象, 或者执行那些不应该在使用pydoc时执行的操作.

Original: https://blog.51cto.com/u_11037231/5582730
Author: 一片白纸
Title: Python编程语言PEP8规范

原创文章受到原创版权保护。转载请注明出处:https://www.johngo689.com/500697/

转载文章受原作者版权保护。转载请注明原作者出处!

(0)

大家都在看

亲爱的 Coder【最近整理,可免费获取】👉 最新必读书单  | 👏 面试题下载  | 🌎 免费的AI知识星球