Python代码规范：如何写出符合PEP8的代码

让代码像诗一样优雅，像文档一样可读

一、什么是PEP8？

PEP8（Python Enhancement Proposal 8）是Python官方推出的编码风格指南，被誉为"Python代码的圣经"。它规定了代码布局、命名、注释等规范，让全球Python开发者写出风格一致的代码。

二、为什么要遵循PEP8？

1. 提升可读性：让代码像英文一样流畅
2. 降低维护成本：减少团队沟通成本
3. 避免低级错误：规范减少隐藏bug
4. 面试加分项：HR看到规范代码会眼前一亮

三、PEP8核心规范速查表

3.1 代码布局

# ✔️正确：运算符前后空格
x = 1 + 2

# ❌错误：缺少空格
x=1+2

# ✔️正确：逗号后空格
items = [1, 2, 3]

# ✔️正确：每行不超过79字符
def long_function_name(
        var_one, var_two, var_three):
    return var_one + var_two + var_three

3.2 命名规范

# 模块名：小写+下划线
import my_module

# 类名：驼峰式
class MyClass:
    pass

# 函数/变量：小写+下划线
def calculate_area():
    radius = 5
    return 3.14 * radius ** 2

# 常量：全大写+下划线
MAX_CONNECTIONS = 100

3.3 注释艺术

def divide(a, b):
    """
    返回两个数的商。
    
    参数:
        a (float): 被除数
        b (float): 除数，不能为0
        
    返回:
        float: 商
        
    抛出:
        ZeroDivisionError: 当b为0时
    """
    if b == 0:
        raise ZeroDivisionError("除数不能为0")
    return a / b

四、PyCharm自动格式化技巧

1. 一键格式化：Ctrl+Alt+L（Win/Linux）或Command+Option+L（Mac）|NyaFun
2. 实时检查：Settings → Editor → Inspections → 搜索"PEP8"|动漫花园
3. 自动修复：Alt+Enter → 选择"Reformat file"|70看看

五、VS Code配置指南

1. 安装Python扩展|Byrutor
2. 设置保存时自动格式化：

   {
       "python.formatting.provider": "black",
       "editor.formatOnSave": true,
       "python.linting.enabled": true,
       "python.linting.pylintEnabled": true
   }
   

3. 安装Black格式化工具：

   pip install black
   

六、自动化工具链

工具	作用	安装命令
Black	代码格式化	pip install black
Flake8	风格检查	pip install flake8
isort	导入排序	pip install isort
pre-commit	Git钩子	pip install pre-commit

6.1 一键检查脚本

# 检查当前目录所有Python文件
flake8 --max-line-length=79 .

# 自动格式化
black .
isort .

6.2 配置pre-commit

.pre-commit-config.yaml：

repos:
  - repo: https://github.com/psf/black
    rev: 22.3.0
    hooks:
      - id: black
        language_version: python3
  - repo: https://github.com/pycqa/flake8
    rev: 4.0.1
    hooks:
      - id: flake8

安装钩子：

pre-commit install

七、常见错误对比图

错误示例	正确示例
x=1+2	x = 1 + 2
def foo( x,y ):	def foo(x, y):
if(x==1):	if x == 1:
myVariable=1	my_variable = 1
#这是注释	# 这是注释

八、团队协作文档模板

CONTRIBUTING.md：

## 代码提交规范
1. 所有代码必须通过 `flake8` 检查
2. 使用 `black` 格式化后再提交
3. 函数必须包含 docstring
4. 单元测试覆盖率不低于 80%

## 提交信息格式
type: subject
feat: 新增功能
fix: 修复bug
docs: 文档变更

九、总结

遵循PEP8不是束缚，而是让代码：

• 像诗一样优雅
• 像文档一样自解释
• 像积木一样可维护

从今天开始，让每一行Python代码都成为艺术品！

---

彩蛋：在PyCharm中连续按两次Shift，输入PEP8，有惊喜彩蛋等你发现！