Python PEP8代码风格指南 - 命名规范缩进规则与Lint工具

# 模块级常量（全大写）
MAX_CONNECTIONS = 100
DEFAULT_TIMEOUT = 30
API_VERSION = "v2"

# 类定义（大驼峰）
class DataProcessor:
    """数据处理器的类"""
    
    # 私有属性（前导下划线）
    _cache = {}
    _instance_count = 0
    
    def __init__(self, config: dict):
        """初始化方法"""
        self.config = config
        self._data = []
        DataProcessor._instance_count += 1
    
    def process_data(self, input_file: str) -> list:
        """处理数据的主方法"""
        # 局部变量（小写下划线）
        raw_data = self._load_file(input_file)
        cleaned_data = self._clean(raw_data)
        return cleaned_data
    
    def _load_file(self, path: str) -> list:
        """内部方法（前导下划线表示私有）"""
        # ... 实现
        pass
    
    def _clean(self, data: list) -> list:
        """内部方法"""
        # ... 实现
        pass


# 函数定义（小写下划线）
def calculate_average(numbers: list[float]) -> float:
    """计算平均值"""
    if not numbers:
        return 0.0
    return sum(numbers) / len(numbers)


# 变量（小写下划线）
user_name = "Alice"
item_count = 42
is_valid = True

# ✅ 正确：4个空格缩进
def process_items(items):
    for item in items:
        if item.is_valid():
            process(item)
        else:
            skip(item)

# ✅ 正确：续行缩进
result = some_function(
    arg1,
    arg2,
    arg3
)

# ✅ 正确：使用悬挂缩进对齐
def long_function_name(
        var_one, var_two, var_three,
        var_four):
    print(var_one)

# ❌ 错误：使用Tab缩进
def bad_function():
	print("使用Tab是不规范的")

# ❌ 错误：缩进不一致
def inconsistent():
    if True:
        print("4 spaces")
        print("3 spaces")  # 少了一个空格

# PEP8规定：
# - 所有行限制为79个字符
# - 文档字符串和注释限制为72个字符

# ✅ 正确：使用括号内的隐式续行
if (condition_one and
        condition_two and
        condition_three):
    do_something()

# ✅ 正确：使用反斜杠续行（优先使用括号）
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())

# ✅ 正确：长字符串使用括号连接
message = (
    "This is a very long message that spans "
    "multiple lines but is actually a single string "
    "because of the adjacent string literals."
)

# 模块级函数和类之间：两个空行
class MyClass:
    pass


def my_function():
    pass


# 类内方法之间：一个空行
class DataProcessor:
    def method_one(self):
        pass
    
    def method_two(self):
        pass


# 函数内逻辑块之间：一个空行
def process_data(data):
    # 第一阶段：验证
    validate(data)
    
    # 第二阶段：处理
    result = transform(data)
    
    # 第三阶段：返回
    return result

# ✅ 正确：运算符两侧各一个空格
x = 1 + 2
result = a * b - c / d

# ✅ 正确：逗号后面一个空格
items = [1, 2, 3, 4]
data = {"name": "Alice", "age": 30}

# ✅ 正确：函数参数默认值不加空格
def greet(name, greeting="Hello"):
    pass

# ✅ 正确：切片冒号两侧不加空格（当两侧都是简单表达式时）
ham[1:9], ham[1:9:3], ham[:9:3]

# ✅ 正确：关键字参数等号两侧不加空格
complex(real=3, imag=4)

# ❌ 错误：括号内侧多余空格
spam( ham[ 0 ], eggs[ 100 ] )

# ❌ 错误：逗号前有多余空格
items = [1 , 2, 3]

# ❌ 错误：赋值号周围多余空格
x             = 1
y             = 2

# 安装Black
pip install black

# 格式化单个文件
black my_script.py

# 格式化整个目录
black src/ tests/

# 检查模式（不修改，只报告）
black --check src/

# 指定行长度
black --line-length 88 src/

# 安装Ruff
pip install ruff

# 检查代码
ruff check src/

# 自动修复可修复的问题
ruff check --fix src/

# 格式化代码（Ruff 0.4+支持）
ruff format src/

# pyproject.toml配置
# [tool.ruff]
# line-length = 88
# target-version = "py39"
# select = ["E", "F", "W", "I", "N", "UP", "B", "SIM"]

# 安装Flake8
pip install flake8

# 检查代码
flake8 src/

# 忽略特定错误
flake8 --ignore=E501,W503 src/

# 设置最大行长度
flake8 --max-line-length=88 src/

# .flake8 配置文件
# [flake8]
# max-line-length = 88
# ignore = E501,W503
# exclude = .git,__pycache__,build,dist