pep8

https://blog.csdn.net/ratsniper/article/details/78954852
** 缩进**
续行应该与其包裹元素对齐，1、使用圆括号、方括号和花括号内的隐式行连接来垂直对齐，2、使用挂行缩进对齐，当使用挂行缩进时，应该考虑到第一行不应该有参数，以及使用缩进以区分自己是续行。
推荐

#与左括号对齐，用更多的缩进来与其他行区分
def long_function_name(var_one, var_two,
                       var_three, var_four):
print()
#第一行不应该有参数，以及使用缩进以区分自己是续行。下面两种都行
def long_function_name(
        var_one, var_two, var_three,
        var_four):
        print(var_one)
def long_function_name(
        var_one, var_two, 
        var_three，var_four):
    print(var_one)

不推荐

#没有使用垂直对齐时，禁止把参数放在第一行
def long_function_name(var_one, var_two,
                var_three,var_four): 
print()
# 当缩进没有与其他行区分时，要增加缩进
def long_function_name(
    var_one, var_two, var_three,
    var_four):
       print(var_one)

四空格的规则对于续行是可选的。

#挂行缩进不一定要用4个空格
x=long_function_name(
1,2,
3,4)

当if语句的条件部分长到需要换行写的时候，注意可以在两个字符关键字的连接处（比如if），增加一个空格，再增加一个左括号来创造一个4空格缩进的多行条件。（if 左括号）这会与if语句内同样使用4空格缩进的代码产生视觉冲突。PEP没有明确指明要如何区分i发的条件代码和内嵌代码。可使用的选项包括但不限于下面几种情况：

# 没有额外的缩进
if (this_is_one_thing and
    that_is_another_thing):
    do_something()

# 增加一个注释，在能提供语法高亮的编辑器中可以有一些区分
if (this_is_one_thing and
    that_is_another_thing):
    # Since both conditions are true, we can frobnicate.
    do_something()

# 在条件判断的语句添加额外的缩进
if (this_is_one_thing
        and that_is_another_thing):
    do_something()

在多行结构中的大括号/中括号/小括号的右括号*},],)可以与内容对齐单独起一行作为最后一行的第一个字符*，就像这样

#*},],)*可以与*内容对齐*单独起一行的第一个字符
my_list = [
    1, 2, 3,
    4, 5, 6,
    ]
result = (
    'a', 'b', 'c',
    'd', 'e', 'f',
    )
 #与多行结构的*第一行第一个字符*对齐
my_list = [
    1, 2, 3,
    4, 5, 6,
]
result = (
    'a', 'b', 'c',
    'd', 'e', 'f',
)

** 制表符还是空格？**
空格是首选的缩进方式。 制表符只能用于与同样使用制表符缩进的代码保持一致。
Python3不允许同时使用空格和制表符的缩进。
混合使用制表符和空格缩进的Python2代码应该统一转成空格。
** 行的最大长度**
所有行限制的最大字符数为79。
没有结构化限制的大块文本（文档字符或者注释），每行的最大字符数限制在72。
较长的代码行选择Python在*（），[]，{}，中的隐式续行方式*。通过（）小括号内表达式的换行方式将长串折成多行。这种方式应该优先使用，而不是使用反斜杠续行。
反斜杠有时依然很有用。比如，比较长的，多个with状态语句，不能使用隐式续行，所以反斜杠是可以接受的：对比多行if-语句，另一种类似情况是使用assert语句。 确保在续行进行适当的缩进。

with open('/path/to/some/file/you/want/to/read') as file_1, \
     open('/path/to/some/file/being/written', 'w') as file_2:
    file_2.write(file_1.read())

** 在二元运算符之前应该换行吗？**
不推荐

# 不推荐: 操作符离操作数太远
income = (gross_wages +
          taxable_interest +
          (dividends - qualified_dividends) -
          ira_deduction -
          student_loan_interest)
# 推荐：运算符和操作数很容易进行匹配
income = (gross_wages
          + taxable_interest
          + (dividends - qualified_dividends)
          - ira_deduction
          - student_loan_interest)

** 空行**
顶层函数和类的定义，前后用两个空行隔开。
类里的方法定义用一个空行隔开。
相关的功能组可以用额外的空行（谨慎使用）隔开。一堆相关的单行代码之间的空白行可以省略（例如，一组虚拟实现 dummy implementations）。
在函数中使用空行来区分逻辑段（谨慎使用）。

Python接受control-L（即^L）换页符作为空格；许多工具把这些字符当作页面分隔符，所以你可以在文件中使用它们来分隔相关段落。
注意，一些编辑器和基于Web的代码阅读器可能无法识别control-L为换页，将在其位置显示另一个字形。
*** 源文件编码***
使用ASCII（在Python2中）或UTF-8（在Python3中）编码的文件不应具有编码声明。
对于Python 3和更高版本，标准库规定了以下策略（参见 PEP 3131）：Python标准库中的所有标识符必须使用ASCII标识符，并在可行的情况下使用英语单词（在许多情况下，缩写和技术术语是非英语的）。此外，字符串文字和注释也必须是ASCII。唯一的例外是*（a）测试非ASCII特征的测试用例，以及（b）作者的名称。作者的名字如果不使用拉丁字母拼写，必须提供一个拉丁字母的音译。*
Imports 导入

#导入通常在分开的行
推荐: import os
     import sys
     from subprocess import Popen, PIPE
不推荐:  import sys, os

• 导入总是位于文件的顶部，在模块注释和文档字符串之后，在模块的全局变量与常量之前。
  导入应该按照以下顺序分组：
  1、标准库导入
  2、相关第三方库导入
  3、本地应用/库特定导入
  你应该在每一组导入之间加入空行。
• 推荐使用绝对路径导入，如果导入系统没有正确的配置（比如包里的一个目录在sys.path里的路径后），使用绝对路径会更加可读并且性能更好（至少能提供更好的错误信息）:

 import mypkg.sibling
from mypkg import sibling
from mypkg.sibling import example

显示的指定相对导入路径是使用绝对路径的一个可接受的替代方案，特别是在处理使用绝对路径导入不必要冗长的复杂包布局时：

from . import sibling
from .sibling import example

标准库要避免使用复杂的包引入结构，而总是使用绝对路径。
不应该使用隐式相对路径导入，并且在Python 3中删除了它

#当从一个包含类的模块中导入类时
from myclass import MyClass
from foo.bar.yourclass import YourClass
#上述的写法导致名字的冲突，然后使用“myclass.MyClass”和“foo.bar.yourclass.YourClass”
import myclass
import foo.bar.yourclass

• 避免通配符的导入（from import *），因为这样做会不知道命名空间中存在哪些名字，会使得读取接口和许多自动化工具之间产生混淆。
  模块级的“呆”名
  像__all__ , author , version 等这样的模块级“呆名“（也就是名字里有两个前缀下划线和两个后缀下划线），应该放在文档字符串的后面，以及除from future 之外的import表达式前面。Python要求将来在模块中的导入，必须出现在除文档字符串之外的其他代码之前。
  顺序：（文字档字符串），（from future 的import表达式），（all , author , version 等这样的模块级“呆名“），（import os）

#下面是文档字符串
"""This is the example module.
This module does stuff.
"""

from __future__ import barry_as_FLUFL

__all__ = ['a', 'b', 'c']
__version__ = '0.1'
__author__ = 'Cardinal Biggles'

import os
import sys

字符串引号
在Python中，单引号和双引号字符串是相同的。
当一个字符串中包含单引号或者双引号字符的时候，使用和最外层不同的符号来避免使用反斜杠，从而提高可读性。
对于三引号字符串，总是使用双引号字符来与PEP 257中的文档字符串约定保持一致。
表达式和语句中的空格
在下列情况下，避免使用无关的空格：

#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、冒号在切片中,在两边应该有相同数量的空格,在扩展的切片操作中，所有的冒号必须有相同的间距,例外情况：当一个切片参数被省略时，空格就被省略了。 
ham[1:9], ham[1:9:3], ham[:9:3], ham[1::3], ham[1:9:] #不推荐ham[1: 9], ham[1 :9], ham[1:9 :3]
ham[lower:upper], ham[lower:upper:], ham[lower::step]
ham[lower+offset : upper+offset] #不推荐ham[lower + offset:upper + offset]
ham[: upper_fn(x) : step_fn(x)], ham[:: step_fn(x)]
ham[lower + offset : upper + offset]#不推荐ham[lower : : upper]，ham[ : upper]
#4、紧贴在函数参数的左括号之前
Yes: spam(1)
No:  spam (1)
#5、紧贴索引或者切片的左括号之前。
Yes: dct['key'] = lst[index]
No:  dct ['key'] = lst [index]
#6、为了和另一个赋值语句对齐，在赋值运算符附件加多个空格。 
x = 1
y = 2
long_variable = 3
#不推荐
x             = 1
y             = 2

其他建议

• 避免在尾部添加空格。因为尾部的空格通常都看不见，会产生混乱
• 总是在二元运算符两边加一个空格：赋值（=），增量赋值（+=，-=），比较（==,<,>,!=,<>,<=,>=,in,not,in,is,is not），布尔（and, or, not）。
• 如果使用具有不同优先级的运算符，请考虑在具有最低优先级的运算符周围添加空格。有时需要通过自己来判断；但是，不要使用一个以上的空格，并且在二元运算符的两边使用相同数量的空格。

i = i + 1#不推荐i=i+1
submitted += 1#不推荐submitted +=1
x = x*2 - 1#不推荐x = x * 2 - 1
hypot2 = x*x + y*y#不推荐hypot2 = x * x + y * y
c = (a+b) * (a-b)#不推荐c = (a + b) * (a - b)

• 在制定关键字参数或者默认参数值的时候，不要在=附近加上空格。
  推荐：

def complex(real, imag=0.0):
    return magic(r=real, i=imag)#不推荐(r = real, i = imag)

• 功能型注释应该使用冒号的一般性规则，并且在使用->的时候要在两边加空格。

def munge(input: AnyStr): ...
def munge() -> AnyStr: ...#不推荐def munge()->PosInt: ...

• 当给有类型备注的参数赋值的时候，在=两边添加空格（仅针对那种有类型备注和默认值的参数）。

 def munge(sep: AnyStr = None): ...#不推荐def munge(input: AnyStr=None): ...
def munge(input: AnyStr, sep: AnyStr = None, limit=1000): ...#不推荐def munge(input: AnyStr, limit = 1000): ...

• 复合语句(同一行中的多个语句)通常是不允许的。
  推荐：

if foo == 'blah':
    do_blah_thing()
do_one()
do_two()
do_three()

#最好不要这样
if foo == 'blah': do_blah_thing()
do_one(); do_two(); do_three()
for x in lst: total += x
while t < 10: t = delay()
#绝对别这样
if foo == 'blah': do_blah_thing()
else: do_non_blah_thing()
try: something()
finally: cleanup()

do_one(); do_two(); do_three(long, argument,
                             list, like, this)

if foo == 'blah': one(); two(); three()

注释
与代码相矛盾的注释比没有注释还糟，当代码更改时，优先更新对应的注释！
注释应该是完整的句子。如果一个注释是一个短语或句子，它的第一个单词应该大写，除非它是以小写字母开头的标识符(永远不要改变标识符的大小写！)。
如果注释很短，结尾的句号可以省略。块注释一般由完整句子的一个或多个段落组成，并且每句话结束有个句号。
在句尾结束的时候应该使用两个空格。
当用英文书写时，遵循Strunk and White （译注：《Strunk and White, The Elements of Style》）的书写风格。
在非英语国家的Python程序员，请使用英文写注释，除非你120%的确信你的代码不会被使用其他语言的人阅读。
块注释
块注释通常适用于跟随它们的某些（或全部）代码，并缩进到与代码相同的级别。块注释的每一行开头使用一个#和一个空格（除非块注释内部缩进文本）。
块注释内部的段落通过只有一个#的空行分隔。
行内注释
有节制地使用行内注释。
事实上，如果状态明显的话，行内注释是不必要的，反而会分散注意力。比如说下面这样就不需要：
x = x + 1 # Increment x1
但有时，这样做很有用：
x = x + 1 # Compensate for border
文档字符串

• 要为所有的公共模块，函数，类以及方法编写文档说明。非公共的方法没有必要，但是应该有一个描述方法具体作用的注释。
• 这个注释应该在def那一行之后。
• 多行文档说明使用的结尾三引号应该自成一行，对于单行的文档说明，尾部的三引号应该和文档在同一行

"""Return a foobang

Optional plotz says to frobnicate the bizbaz first.
"""

命名规范
新的模块和包（包括第三方框架）应该用这套标准，但当一个已有库采用了不同的风格，推荐保持内部一致性。
最重要的原则
那些暴露给用户的API接口的命名，应该遵循反映使用场景而不是实现的原则。
描述：命名风格
以下是常见的命名方式：

• b（单个小写字母）
• B（单个大写字母）
• lowercase 小写字母
• lower_case_with_underscores 使用下划线分隔的小写字母
• UPPERCASE 大写字母
• UPPER_CASE_WITH_UNDERSCORES 使用下划线分隔的大写字母
• CapitalizedWords（或者叫 CapWords，或者叫CamelCase 驼峰命名法，也被称为StudlyCaps。
  注意：当在首字母大写的风格中用到缩写时，所有缩写的字母用大写，因此，HTTPServerError 比 HttpServerError 好
• mixedCase（不同于首字母大写，第一个单词的首字母小写）
• Capitalized_Words_With_Underscores（巨丑无比！）
• 也有用唯一的短前缀把相关命名组织在一起的方法。这在Python中不常用，但还是提一下。比如，os.stat()函数中包含类似以st_mode，st_size，st_mtime这种传统命名方式命名的变量。属性和方法在调用的时候都会用类名做前缀，函数名用模块名做前缀。

另外，下面这种用前缀或结尾下划线的特殊格式是被认可的（通常和一些约定相结合）：

• _single_leading_underscore：（单下划线开头）弱“内部使用”指示器。比如 from M import * 是不会导入以下划线开始的对象的。
• single_trailing_underscore_：（单下划线结尾）这是避免和Python内部关键词冲突的一种约定，比如：Tkinter.Toplevel(master, class_=’ClassName’)
• __double_leading_underscore：（双下划线开头）当这样命名一个类的属性时，调用它的时候名字会做矫正（在类FooBar中，__boo变成了_FooBar__boo；见下文）。
• double_leading_and_trailing_underscore：（双下划线开头，双下划线结尾）“magic”对象或者存在于用户控制的命名空间内的属性，例如：init,import__或者__file。除了作为文档之外，永远不要命这样的名。
  约定俗成：命名约定
  应避免的名字
  永远不要使用字母‘l’（小写的L），‘O’（大写的O），或者‘I’（大写的I）作为单字符变量名。
  在有些字体里，这些字符无法和数字0和1区分，如果想用‘l’，用‘L’代替。
  包名和模块名
  模块应该用简短全小写的名字，如果为了提升可读性，下划线也是可以用的。Python包名也应该使用简短全小写的名字，但不建议用下划线。
  当使用C或者C++编写了一个依赖于提供高级（更面向对象）接口的Python模块的扩展模块，这个C/C++模块需要一个下划线前缀（例如：_socket）
  类名
  类名一般使用首字母大写的约定。
  在接口被文档化并且主要被用于调用的情况下，可以使用函数的命名风格代替。
  注意，对于内置的变量命名有一个单独的约定：大部分内置变量是单个单词（或者两个单词连接在一起），首字母大写的命名法只用于异常名或者内部的常量。
  异常名
  因为异常一般都是类，所有类的命名方法在这里也适用。然而，你需要在异常名后面加上“Error”后缀（如果异常确实是一个错误）。
  全局变量名
  通过 from M import * 导入的模块应该使用all机制去防止内部的接口对外暴露，或者使用在全局变量前加下划线的方式（表明这些全局变量是模块内非公有）

函数名

函数名应该小写，如果想提高可读性可以用下划线分隔。
大小写混合仅在为了兼容原来主要以大小写混合风格的情况下使用（比如 threading.py），保持向后兼容性。
函数和方法参数
始终要将 self 作为实例方法的的第一个参数。
始终要将 cls 作为类静态方法的第一个参数。
如果函数的参数名和已有的关键词冲突，在最后加单一下划线比缩写或随意拼写更好。因此 class_ 比 clss 更好。（也许最好用同义词来避免这种冲突）
方法名和实例变量
遵循这样的函数命名规则：使用下划线分隔小写单词以提高可读性。
在非共有方法和实例变量前使用单下划线。
通过双下划线前缀触发Python的命名转换规则来避免和子类的命名冲突。
Python通过类名对这些命名进行转换：如果类 Foo 有一个叫 __a 的成员变量， 它无法通过Foo.__a 访问。（执着的用户可以通过 Foo._Foo__a 访问。）一般来说，前缀双下划线用来避免类中的属性命名与子类冲突的情况。
注意：关于__names的用法存在争论（见下文）。
常量
常量通常定义在模块级，通过下划线分隔的全大写字母命名。例如： MAX_OVERFLOW 和 TOTAL
继承的设计
始终要考虑到一个类的方法和实例变量（统称：属性）应该是共有还是非共有。，那就选非共有。
公共属性是那些与类无关的客户使用的属性，并承诺避免向后不兼容的更改。非共有属性是那些不打算让第三方使用的属性；你不需要承诺非共有属性不会被修改或被删除。
我们不使用“私有（private）”这个说法，是因为在Python中目前还没有真正的私有属性（为了避免大量不必要的常规工作）。
另一种属性作为子类API的一部分（在其他语言中，通常被称为“protected”）。有些类是专为继承设计的，用来扩展或者修改类的一部分行为。当设计这样的类时，要谨慎决定哪些属性时公开的，哪些是作为子类的API，哪些只能在基类中使用。
一下是一些让代码Pythonic的准则：

• 公共属性不应该有前缀下划线。
• 如果公共属性名和关键字冲突，在属性名之后增加一个下划线。这比缩写和随意拼写好很多。（然而，尽管有这样的规则，在作为参数或者变量时，‘cls’是表示‘类’最好的选择，特别是作为类方法的第一个参数。）
  注意1：参考之前的类方法参数命名建议
• 对于单一的共有属性数据，最好直接对外暴露它的变量名，而不是通过负责的 存取器（accessor）/突变（mutator） 方法。请记住，如果你发现一个简单的属性需要成长为一个功能行为，那么Python为这种将来会出现的扩展提供了一个简单的途径。在这种情况下，使用属性去隐藏属性数据访问背后的逻辑。
  注意1：属性只在new-style类中起作用。
  注意2：尽管功能方法对于类似缓存的负面影响比较小，但还是要尽量避免。
  注意3：属性标记会让调用者认为开销（相当的）小，避免用属性做开销大的计算。
• 如果你的类打算用来继承的话，并且这个类里有不希望子类使用的属性，就要考虑使用双下划线前缀并且没有后缀下划线的命名方式。这会调用Python的命名转换算法，将类的名字加入到属性名里。这样做可以帮助避免在子类中不小心包含了相同的属性名而产生的冲突。
  注意1：只有类名才会整合进属性名，如果子类的属性名和类名和父类都相同，那么你还是会有命名冲突的问题。
  注意2：命名转换会在某些场景使用起来不太方便，例如调试，getattr()。然而命名转换的算法有很好的文档说明并且很好操作。
  注意3：不是所有人都喜欢命名转换。尽量避免意外的名字冲突和潜在的高级调用。
  公共和内部的接口
  文档化的接口被认为是公开的，除非文档明确声明它们是临时或内部接口，不受通常的向后兼容性保证。所有未记录的接口都应该是内部的。
  为了更好地支持内省（introspection），模块应该使用__all__属性显式地在它们的公共API中声明名称。将__all__设置为空列表表示模块没有公共API。
  即使通过__all__设置过，内部接口（包，模块，类，方法，属性或其他名字）依然需要单个下划线前缀。
  如果一个命名空间（包，模块，类）被认为是内部的，那么包含它的接口也应该被认为是内部的。
  导入的名称应该始终被视作是一个实现的细节。其他模块必须不能间接访问这样的名称，除非它是包含它的模块中有明确的文档说明的API，例如 os.path 或者是一个包里从子模块公开函数接口的__init__ 模块。
  编程建议
• 在性能要求比较高的库中，可以种 ”.join() 代替。这可以确保字符关联在不同的实现中都可以以线性时间发生。
• 和像None这样的单例对象进行比较的时候应该始终用 is 或者 is not，永远不要用等号运算符。
• if x 的时候，请注意你是否表达的意思是 if x is not None
• 使用 is not 运算符，而不是 not … is 。虽然这两种表达式在功能上完全相同，但前者更易于阅读，所以优先考虑。

#推荐
if foo is not None:
#不推荐
if not foo is None:

• 当使用富比较（rich comparisons，一种复杂的对象间比较的新机制，允许返回值不为-1,0,1）实现排序操作的时候，最好实现全部的六个操作符（eq, ne, lt, gt,ge）而不是依靠其他的代码去实现特定的比较。
  为了最大程度减少这一过程的开销，functools.total_ordering() 修饰符提供了用于生成缺少的比较方法的工具。 PEP 207 指出Python实现了反射机制。因此，解析器会将 y > x 转变为 x < y，将 y >= x 转变为 x <= y，也会转换x == y 和 x != y的参数。sort() 和 min()方法确保使用<操作符，max()使用>操作符。然而，最好还是实现全部六个操作符，以免在其他地方出现冲突。
• 始终使用def表达式，而不是通过赋值语句将lambda表达式绑定到一个变量上。

#推荐
def f(x): return 2*x
#不推荐f = lambda x: 2*x