Python 编程规范
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md 安装 @user_f12a44b7/self-dev-python。
技能介绍
解决什么问题
很多 Python 代码在本地能跑,但合并后会出现风格漂移、依赖混乱、版本过旧和测试缺失。这个技能把 Python 编程规范 拆成可执行的检查点,而不是只给一篇 PEP 8 链接。
如何工作
它围绕提交前闭环组织:先用 py_compile 确认语法,再用 pytest 跑聚焦的单元测试;检查是否使用 Python 3.10+ 的现代能力,例如 match、walrus operator 和类型注解。依赖管理优先识别 uv,否则回退到 pip,并建议用虚拟环境隔离项目。风格上要求 4 空格缩进、snake_case、PascalCase、UPPER_CASE 常量,以及导入按 stdlib、third-party、local 分组。文档字符串、pathlib、上下文管理器和 f-strings 也被列为常见模式。
适用边界
这套规范更适合新项目和团队仓库,强调 Python 3.10+,不兼容 Python 2 语法。它主要约束代码风格、依赖、测试与提交检查,不替代架构设计、性能调优或安全审计;对需要严格 PEP 8 行宽 79 的项目,可把 88 字符默认值视为 Black 风格。
使用场景
- 在新仓库初始化阶段统一导入顺序、命名和缩进,让 Python 代码符合 PEP 8。
- 合并 PR 前检查是否使用 Python 3.10+ 特性、类型注解和 pytest 单元测试。
- 为数据处理脚本选择 uv 或 pip 虚拟环境,并用 pathlib 与上下文管理器处理 I/O。
- 提交前跑 py_compile 和 pytest,确认无硬编码密钥、可变默认参数等反模式。
适合人员
- 负责 Python 工具库维护的工程师,希望团队代码在命名、导入和测试上保持一致。
- 使用大模型生成代码的后端开发者,需要按 PEP 8 与 Python 3.10+ 特性复核输出。
- 维护数据管道脚本的工程师,想规范依赖管理、I/O、类型注解和提交前检查。
- 参与开源评审的贡献者,需要对照 pytest、docstring 和反模式清单修改代码。