SuperAPI AI 工具集

dignified-python

编程与开发

查看项目

更新于 10-26 16:20

技能介绍

用途:dignified-python 面向生产环境的 Python 代码,提供带有明确倾向的编码规范,帮助编写干净、可维护、现代化的 Python 代码,覆盖 Python 3.10 至 3.13。它既可用于新代码编写,也可用于代码评审与重构。

主要能力:该技能在用户提出下列需求时会自动触发,包括“让这段代码更 Pythonic”“这段 Python 写得好不好”“类型提示、类型注解”“LBYL 与 EAFP”“pathlib 与 os.path”“CLI 模式、click 用法”“代码评审、改进代码”,以及任何 Python 代码质量或规范问题。

版本检测:技能会依次检查 pyproject.toml 中的 requires-python 字段、setup.py 或 setup.cfg 中的 python_requires、.python-version 文件,以确定项目的最低 Python 版本;如果未找到版本声明,则默认使用 Python 3.12,然后加载对应的版本说明文件,包括 Python 3.10、3.11、3.12 或 3.13。

使用方式:核心知识会自动加载,涵盖默认约定、pathlib、导入与反模式;版本检测只执行一次,并据此加载对应的版本文件;参考文档根据任务模式按需加载。例如,任务提到 click 或 CLI 时加载 CLI 模式文档;提到 subprocess 时加载 subprocess 文档。只有当文档覆盖的内容不足时,才需要追加加载其他参考材料。

参考文档结构:核心参考包含 dignified-python-core.md 与 cli-patterns.md;版本参考位于 versions/ 目录,包括 python-3.10.md 到 python-3.13.md;高级主题位于 references/advanced/,包括 exception-handling.md(LBYL 模式、错误边界)、interfaces.md(ABC 与 Protocol 模式)、typing-advanced.md(高级类型模式)、api-design.md(API 设计原则);此外还有 module-design.md 与 checklists.md,后者用于提交前的最终检查或快速查阅要求。

适用场景:需要统一 Python 风格的仓库,涵盖代码编写、评审与重构,类型注解与异常处理策略选择,路径操作与 CLI 模式选择,以及提交前的规范核对。

限制:该技能提供的是通用 Python 风格指导,并不针对 Dagster 等特定框架;Dagster 最佳实践、流水线实现、集成选型等问题不应使用本技能,而应使用相应的专用技能。它体现的是一套明确的、偏向 LBYL 的约定,项目自身的约定可以覆盖它。关于收费、价格与平台支持情况,当前资料未提供。