PEP 8 代码风格指南附录#

# 续行与括号对齐
def long_function_name(var_one, var_two,
                       var_three, var_four):
    return var_one

# 悬挂缩进（续行额外缩进）
result = some_function_that_takes_arguments(
    'arg1', 'arg2', 'arg3',
    'arg4', 'arg5'
)

# 两个空行分隔顶级定义
import os


def function_one():
    pass


def function_two():
    pass


class MyClass:
    """类文档"""

    def method_one(self):
        pass

    def method_two(self):
        pass

"""模块文档字符串"""

import os
import sys

import numpy as np
import pandas as pd

from mypackage.utils import helper

# 二元运算符两侧各一个空格
x = 1
result = a + b

# 逗号后一个空格
spam(ham[1], {eggs: 2})
foo = (0,)

# 函数默认参数 = 两侧不加空格
def func(a=0, b=None):
    pass

# 切片冒号两侧空格可选，保持一致
ham[1:9], ham[1:9:3]

# 与 None 比较用 is / is not
if x is None:
    pass
if x is not None:
    pass

# 布尔值用 is True / is False（慎用），通常直接 if x:

# 这是一个块注释
# 说明下面的逻辑
x = process(data)

x = x + 1  # 补偿边界

def complex(real=0.0, imag=0.0):
    """Form a complex number.

    Keyword arguments:
    real -- the real part (default 0.0)
    imag -- the imaginary part (default 0.0)
    """
    return complex(real, imag)

def greeting(name: str) -> str:
    return f'Hello {name}'