严谨的Python编码标准技能
生产级Python编码标准,用于编写干净、可维护、现代的Python代码(版本3.10-3.13)。
何时使用本技能
当用户询问以下问题时自动调用:
- "让这个更Pythonic" / "这段Python写得好吗"
- "类型提示" / "类型注解" / "typing"
- "LBYL与EAFP" / "异常处理"
- "pathlib与os.path" / "路径操作"
- "CLI模式" / "click用法"
- "代码审查" / "改进这段代码"
- 任何Python代码质量或标准相关问题
注意:本技能是通用Python标准,而非Dagster专属。Dagster模式请使用/dagster-expert。
何时使用本技能 vs. 其他
| 用户需求 | 使用本技能 | 替代技能 |
|---|---|---|
| "让这个更Pythonic" | ✅ 是 - Python标准 | |
| "这段Python写得好吗" | ✅ 是 - 代码质量 | |
| "类型提示" | ✅ 是 - 类型指导 | |
| "LBYL与EAFP" | ✅ 是 - 异常模式 | |
| "pathlib与os.path" | ✅ 是 - 路径处理 | |
| "Dagster专属模式" | ❌ 否 | /dagster-expert |
| "CLI参数解析" | ✅ 是 - CLI模式 |
核心知识(始终加载)
版本检测
识别项目的最低Python版本,通过以下顺序检查:
pyproject.toml- 查找requires-python字段(例如requires-python = ">=3.12")setup.py或setup.cfg- 查找python_requires.python-version文件 - 包含版本号,如3.12或3.12.0- 如果未找到版本说明,默认使用Python 3.12
一旦识别,加载对应的版本特定文件:
- Python 3.10:加载
versions/python-3.10.md - Python 3.11:加载
versions/python-3.11.md - Python 3.12:加载
versions/python-3.12.md - Python 3.13:加载
versions/python-3.13.md
条件加载(根据任务模式加载)
核心文件覆盖了80%以上的Python代码模式。仅在检测到特定模式时加载以下附加文件:
模式检测示例:
- 如果任务提及"click"或"CLI" -> 加载
cli-patterns.md - 如果任务提及"subprocess" -> 加载
subprocess.md
参考文档结构
参考文档分布在顶层文件和子目录中:
核心参考(与SKILL.md同目录)
dignified-python-core.md- 基本标准(始终加载)cli-patterns.md- 命令行界面模式(click、argparse)subprocess.md- 子进程操作
版本特定参考(versions/)
versions/python-3.10.md- Python 3.10+可用的特性versions/python-3.11.md- Python 3.11+可用的特性versions/python-3.12.md- Python 3.12+可用的特性versions/python-3.13.md- Python 3.13+可用的特性
高级主题(references/advanced/)
exception-handling.md- LBYL模式、错误边界interfaces.md- ABC和Protocol模式typing-advanced.md- 高级类型模式api-design.md- API设计原则
何时阅读每个参考文档
references/advanced/exception-handling.md
在以下情况阅读:
- 编写try/except块
- 包装可能引发异常的第三方API
- 看到或编写
from e或from None - 不确定LBYL替代方案是否存在
references/advanced/interfaces.md
在以下情况阅读:
- 创建ABC或Protocol类
- 编写@abstractmethod装饰器
- 设计网关层接口
- 在ABC和Protocol之间做选择
references/advanced/typing-advanced.md
在以下情况阅读:
- 使用typing.cast()
- 创建Literal类型别名
- 在条件块中缩小类型
references/module-design.md
在以下情况阅读:
- 创建新的Python模块
- 添加模块级代码(超出简单常量)
- 在模块级使用@cache装饰器
- 在模块级看到Path()或计算
- 考虑内联导入
references/api-design.md
在以下情况阅读:
- 为函数添加默认参数值
- 定义具有5个或更多参数的函数
- 使用ThreadPoolExecutor.submit()
- 审查函数签名
references/checklists.md
在以下情况阅读:
- 提交Python代码前的最终审查
- 不确定是否已遵循所有规则
- 需要快速查看要求
如何使用本技能
- 核心知识自动加载(LBYL、pathlib、基础导入、反模式)
- 版本检测只进行一次 - 识别最低Python版本并加载对应的版本文件
- 参考文档根据上述触发条件按需加载
- 附加模式可能需要额外加载(CLI模式、子进程)
- 每个文件自成体系,包含其领域的完整指导