CentOS Python代码风格指南

在CentOS环境下写Python，想让代码既跑得稳又看着顺眼，PEP 8这个官方风格指南就是你的“金科玉律”。它不是什么死板的教条，而是一套旨在提升代码可读性和团队协作一致性的最佳实践。今天，咱们就来聊聊如何在CentOS系统里，把这些规范从纸面落到实地。

工欲善其事，必先利其器。在CentOS里，借助包管理器和一些现成的工具，能让规范检查变得非常轻松。

1. 工具安装与环境准备

最直接的方式，就是在终端里使用yum包管理器安装flake8。这个工具能帮你快速扫描代码，找出不符合PEP 8规范的地方：

sudo yum install python3-flake8

安装完成后，检查单个文件就很简单了：flake8 your_script.py。如果想更自动化，完全可以把它集成到项目的CI/CD流程（比如GitHub Actions）里，每次提交代码都自动跑一遍检查，把问题扼杀在萌芽状态。

2. 代码布局规范

代码的“排版”是给人的第一印象，整齐的布局直接决定了可读性的下限。

缩进

• 坚决使用4个空格进行每级缩进，别用Tab键。这是Python社区的硬性约定，能避免在不同编辑器里显示混乱。
• 遇到长表达式或者括号里的内容需要换行时，有两种主流做法：一是与包裹元素的左括号对齐，二是使用“悬挂缩进”（即在原缩进基础上再缩进4个空格）。关键是要清晰区分逻辑层次。看看正反例子就明白了：

正确示例：

fo = dict(name='小数先生', age=18, city='hangzhou')

def long_function_name(var_one, var_two, var_three):
    print(var_one)

错误示例：

fo = dict(name='小数先生', age=18, city='hangzhou')
def long_function_name(var_one, var_two, var_three):
print(var_one)  # 缩进不足

行长度限制

• 普通代码行建议不超过79个字符，文档字符串和注释则建议在72字符以内。这个限制不是为了刁难人，而是为了在并排查看代码或阅读文档时，不需要左右滚动屏幕。
• 一行写不下怎么办？优先利用Python括号（圆括号、方括号、花括号）带来的隐式换行，而不是用反斜杠\。后续行缩进4个空格即可。

正确示例：

income = (gross_wages
          + taxable_interest
          + (dividends - qualified_dividends)
          - ira_deduction)

错误示例：

income = gross_wages + taxable_interest + (dividends - qualified_dividends) - ira_deduction  # 超过79字符

空行

• 顶层函数或者类定义之间，用2个空行隔开，给视觉一个清晰的呼吸区。
• 类内部的方法定义之间，用1个空行分隔就够了。
• 函数内部，如果逻辑块比较分明（比如初始化、计算、输出），也可以用1个空行稍微隔一下，但别滥用，否则代码就太“稀疏”了。

3. 命名规范

命名是代码的“门面”，好的命名让人一眼就知道它是干什么的。

• 函数、变量、属性：统一使用小写字母加下划线的蛇形命名法（snake_case），比如calculate_total、user_name。
• 受保护的实例属性：以一个下划线开头，比如_internal_var。这是一种约定，意思是“这个属性主要是内部使用的，外部别直接碰”，但Python并不会阻止你访问它。
• 私有实例属性：以双下划线开头，如__private_var。这会触发Python的名称改写机制，能在一定程度上避免子类意外重写父类属性。
• 类和异常：使用驼峰命名法（CamelCase），每个单词首字母大写，例如UserAccount、ValueNotFoundError。
• 模块级常量：全部字母大写，单词间用下划线连接，像MAX_RETRIES、DEFAULT_TIMEOUT这样，老远就能认出它是常量。
• 方法参数：记住两个关键字：实例方法的第一个参数必须是self，代表对象自身；类方法的第一个参数必须是cls，代表类本身。这是Python的语法要求，也是清晰的约定。

4. 表达式与语句规范

写代码时的一些小习惯，能显著提升代码的“地道”程度。

• 布尔判断：和None比较时，优先用is或is not，而不是==或!=。写成if x is not None更符合Python风格。
• 容器空值判断：检查列表、字典等容器是否为空，直接使用容器本身。因为空容器在布尔上下文中为False。所以应该写if somelist:，而不是if len(somelist) == 0。
• 循环与条件：避免把if、for等复合语句挤在一行。虽然if x > 0: print(x)语法上没错，但不符合PEP 8对可读性的要求。正确的做法是换行并缩进。

正确示例：

if x is not None and y > 0:
    for item in items:
        print(item)

错误示例：

if x is not None and y > 0: print(x)  # 复合语句挤在一行

5. 导入规范

导入语句的整洁度，反映了一个模块的依赖关系是否清晰。

• 分组与顺序：导入应该分三组，组间用空行隔开，顺序如下：
  1. 先导入Python标准库模块，比如import os、import sys。
  2. 再导入第三方库，比如import numpy、import requests。
  3. 最后导入你自己项目里的本地模块，比如from . import utils、from mymodule import MyClass。
• 每行一个导入：不要图省事写成import os, sys。每行只导入一个模块或从模块导入一个对象，这样更清晰，也便于维护。
• 绝对导入优先：尽量使用from package import module这种绝对导入形式，代码意图更明确。除非你的项目结构特别复杂，为了清晰起见才使用相对导入（from .subpackage import module）。

6. 注释与文档字符串规范

代码是写给机器执行的，但注释和文档是写给人看的。好的文档能省下未来大量的沟通成本。

注释

• 块注释：用来解释一段代码的逻辑。它应该缩进到和所解释的代码同级，每行以# 开头（注意#后面有个空格）。如果注释内容很长，段落之间可以用空行隔开。

示例：

# 计算订单总价（含税）
# 参数：price（商品单价），quantity（数量），tax_rate（税率）
total = price * quantity * (1 + tax_rate)

• 行内注释：紧跟在代码语句后面，用来补充说明该行代码的意图。它应该与代码之间至少间隔2个空格。但要慎用，很多时候优化代码本身（比如把x = x + 1写成x += 1）比加注释更有效。

文档字符串（Docstring）

• 公共对象必写：所有模块、函数、类、公开方法，都应该有文档字符串（用三引号"""包裹）。它应该描述功能、参数、返回值以及可能抛出的异常。
• 多行格式：首行写一个简短的总结，然后空一行，再开始详细的描述。结尾的三引号单独成行。这种格式在各种文档生成工具里都能被很好地解析。

示例：

def calculate_discount(price, discount_rate):
    """计算商品折扣后的价格。

    Args:
        price (float): 商品原价。
        discount_rate (float): 折扣率（0~1之间的小数）。

    Returns:
        float: 折扣后价格。
    """
    return price * (1 - discount_rate)

7. 配置文件与团队协作

个人遵守规范不难，难的是让整个团队保持一致。这时候，配置文件和流程就至关重要了。

• 项目级配置文件：在项目根目录下放一个.flake8文件。在这里，你可以统一团队的检查规则，比如调整最大行长度（有人喜欢调到88字符以适应GitHub的代码审查视图），或者排除掉一些不需要检查的目录（如__pycache__、构建产物目录等）。

示例.flake8文件内容：

[flake8]
max-line-length = 88  # 根据项目需求调整（如88字符适配GitHub代码审查）
exclude = .git,__pycache__,dist  # 排除无需检查的目录

• 集成到开发流程：把这个.flake8文件纳入Git版本控制。要求团队成员在拉取代码后，安装flake8并运行flake8 .来检查整个项目。更进一步，可以把flake8检查作为代码提交前钩子（pre-commit hook）或者代码审查（Code Review）的一个必过环节。这样一来，风格规范就不再是口头建议，而是可执行、可检查的团队契约了。