Python 开发规范

这个技能能帮你做什么

Python 语法简单，但写好 Python 需要了解它的"地道"写法。这个技能提供了一套经过验证的 Python 开发模式，让你的代码更符合社区规范，更易于阅读和维护。

简单说，它能帮你：

• 统一代码风格 —— 遵循 PEP 8 标准，让代码看起来专业一致
• 用好类型提示 —— 用类型注解提升代码可读性和 IDE 支持
• 优雅处理错误 —— 用 Python 的方式（EAFP）处理异常，而不是过度防御
• 管理资源 —— 用上下文管理器自动处理资源释放
• 组织项目 —— 合理规划目录结构，让项目从一开始就井井有条
• 提升性能 —— 用生成器、slots 等技巧优化内存和执行效率

什么时候用

写新代码时 —— 不确定 Python 的推荐写法是什么？它会告诉你

审查代码时 —— 检查代码是否符合 Python 社区的最佳实践

重构时 —— 把不规范的代码改成更地道的 Python 风格

组织新项目时 —— 确定项目结构、依赖管理、工具配置

学习时 —— 了解 Python 的各种特性和惯用法

主要覆盖哪些场景

1. 代码风格
   • 命名规范：函数用小写加下划线，类用大驼峰
   • 代码格式化：用 Black 自动统一代码风格
   • 导入排序：用 isort 自动排序导入语句
   • 注释和文档字符串：清晰说明代码意图
2. 类型提示
   • 函数参数和返回值加类型注解
   • 用 TypeVar 定义泛型函数
   • 用 Protocol 实现鸭子类型
   • 用现代类型语法（Python 3.9+）：list[str] 代替 List[str]
3. 错误处理
   • 优先捕获具体异常，不要裸 except
   • 用异常链（from e）保留原始错误信息
   • 自定义异常层次，方便调用方处理
   • EAFP 风格：先尝试，再处理异常
4. 上下文管理
   • 用 with 语句管理文件、数据库连接等资源
   • 自定义上下文管理器，用 @contextmanager 装饰器
   • 确保资源一定被释放，即使发生异常
5. 列表和生成器
   • 列表推导式：简洁高效地处理集合
   • 生成器表达式：惰性求值，处理大数据量
   • 生成器函数：逐个产出数据，节省内存
   • 避免在循环中拼接字符串，用 join 方法
6. 数据类
   • 用 @dataclass 自动生成常用方法（init, repr, eq）
   • 在 post_init 中做数据校验
   • 用 NamedTuple 定义不可变数据结构
7. 装饰器
   • 用 functools.wraps 保留原函数元数据
   • 参数化装饰器，让装饰器更灵活
   • 类装饰器，统计函数调用次数等
8. 并发处理
   • 多线程：适合 I/O 密集型任务（网络请求、文件读写）
   • 多进程：适合 CPU 密集型任务（计算、图像处理）
   • 异步编程：async/await 处理高并发 I/O
   • 根据场景选择合适的并发模型
9. 项目组织
   • 标准目录结构：src、tests、docs 分离
   • init.py 控制包的公开接口
   • 用 pyproject.toml 管理依赖和工具配置
   • 合理划分模块，避免循环导入
10. 性能优化
    • slots 减少内存占用（对象数量多时效果显著）
    • 生成器代替列表，惰性处理大数据
    • 避免在循环中做字符串拼接
    • 用 pathlib 代替 os.path，更面向对象

怎么用

写代码时 —— 问它"这种情况 Python 推荐怎么处理？"

审查时 —— 把代码发给它，检查有没有更地道的写法

重构时 —— 让它帮你把代码改成更符合 Python 习惯的风格

搭项目时 —— 问它"Python 项目应该怎么组织？"

核心原则

写 Python 时，记住这几条原则：

1. 可读性优先 —— Python 的设计哲学，代码是给人读的
2. 显式优于隐式 —— 代码意图要明确，不要搞隐藏逻辑
3. 简单优于复杂 —— 能用简单方案解决的，不要用复杂方案
4. EAFP 优于 LBYL —— 先尝试，失败再处理，比先检查再执行更 Pythonic
5. 类型提示是文档 —— 给函数加类型注解，帮助自己和他人理解代码

适用场景

• Python 后端服务开发
• 数据处理和脚本编写
• Python 代码审查
• 项目架构设计
• 学习 Python 最佳实践
• 从其他语言迁移到 Python

不适用场景

• 需要极致性能的场景（考虑用 C/C++/Rust）
• 移动端开发（虽然 Kivy 存在，但不主流）
• 纯前端开发（Python 不是前端语言）
• 需要强类型保证的复杂系统（考虑用 Java/Kotlin/C#）