Python PEP 8 风格备忘录

Python Enhancement Proposal #8 叫作 PEP 8，它是一份针对 Python 代码格式而编订的风格指南。

下面这些规则是 PEP 8 中绝对应该遵循的。

空白

用空格（space）表示缩进，而不要用制表符（tab）
和语法相关的每一层缩进都用 4个空格 表示
每行不超过 79 个字符
对于占据多行的长表达式来说，除了首行之外的其余各行都应该在通常的缩进级别之上再加 4 个空格。
```
# 正确
total = (first_variable
        + second_variable
        - third_variable)
```

在同一份文件中，函数与类之间用两个空行隔开。

# 正确
def function_one():
    pass


class MyClass:
    pass

在同一个类中，方法与方法之间用一个空行隔开。

# 正确
class MyClass:
    def method_one(self):
        pass

    def method_two(self):
        pass

使用字典时，键与冒号之间不加空格，写在同一行的冒号和值之间应该加一个空格。
```
# 正确
data = {"name": "Alice", "age": 30}
```
给变量赋值时，赋值符号的左边和右边各加一个空格，并且只加一个空格就好。
```
# 正确
count = 1
```
给变量的类型做注解（annotation）时，不要把变量名和冒号隔开，但在类型信息前应该有一个空格。
```
# 正确
name: str = "Alice"
```

命名

函数、变量及属性用小写字母来拼写，各单词之间用下划线相连，例如：lowercase_underscore。
受保护的实例属性，用一个下划线开头，例如：_leading_underscore。
私有的实例属性，用两个下划线开头，例如：__double_leading_underscore。
类（包括异常）命名时，每个单词的首字母均大写，例如：CapitalizedWord。
模块级别的常量，所有字母都大写，各单词之间用下划线相连，例如：ALL_CAPS。
类中的实例方法，应该把第一个参数命名为 self，用来表示该对象本身。
类方法的第一个参数，应该命名为 cls，用来表示这个类本身。

语法建议

每件事都应该有简单的做法，而且最好只有一种。—— The Zen of Python

采用行内否定，即把否定词直接写在要否定的内容前面，而不要放在整个表达式的前面，例如应该写 if a is not b，而不是 if not a is b。
```
# 正确
if a is not b:
    pass

# 错误
if not a is b:
    pass
```
不要通过长度判断容器或序列是不是空的，例如不要通过 if len(somelist) == 0 判断 somelist 是否为 [] 或 '' 等空值，而是应该采用 if not somelist 这样的写法来判断，因为 Python 会把空值自动评估为 False。
```
# 正确
if not somelist:
    print("列表为空")

# 错误
if len(somelist) == 0:
    print("列表为空")
```
如果要判断容器或序列里面有没有内容（比如要判断 somelist 是否为 [1] 或 'hi' 这样非空的值），也不应该通过长度来判断，而是应该采用 if somelist 语句，因为 Python 会把非空的值自动判定为 True。
```
# 正确
if somelist:
    print("列表有内容")

# 错误
if len(somelist) != 0:
    print("列表有内容")
```
不要把 if 语句、for 循环、while 循环及 except 复合语句挤在一行。应该把这些语句分成多行来写，这样更加清晰。
```
# 正确
if condition:
    do_something()

# 错误
if condition: do_something()
```

如果表达式一行写不下，可以用括号将其括起来，而且要适当地添加换行与缩进以便于阅读。

# 正确
result = (some_long_variable_name
          + another_long_variable_name
          * yet_another_variable)

多行的表达式，应该用括号括起来，而不要用 \ 符号续行。

# 正确
total = (first_value
         + second_value
         + third_value)

# 错误
total = first_value \
        + second_value \
        + third_value

导入模块

PEP 8 对于怎样在代码中引入并使用模块，给出了下面几条建议：

import 语句（含 from x import y）总是应该放在文件开头。

# 正确
import os
import sys
from typing import List

def main():
    pass

引入模块时，总是应该使用绝对名称，而不应该根据当前模块路径来使用相对名称。例如，要引入 bar 包中的 foo 模块，应该完整地写出 from bar import foo，即便当前路径为 bar 包里，也不应该简写为 import foo。
```
# 正确
from bar import foo

# 错误（在 bar 包内时）
import foo
```
如果一定要用相对名称来编写 import 语句，那就应该明确地写成：from . import foo。
```
# 正确（明确的相对导入）
from . import foo
from .bar import baz
```

文件中的 import 语句应该按顺序划分成三个部分：首先引入标准库里的模块，然后引入第三方模块，最后引入自己的模块。属于同一个部分的 import 语句按字母顺序排列。

# 正确
# 标准库
import os
import sys
from typing import List

# 第三方库
import numpy as np
import pandas as pd
import requests

# 自己的模块
from myapp import config
from myapp.utils import helper