关于 python-code-style
python-code-style 是用于审查 Python 代码可读性和可维护性的技能。它结合 ruff 等工具建议与人工检查，涵盖命名、API 边界、类型标注和文档，并给出精简的修改计划。
主要功能
- 01建议 lint 和格式化默认工具
- 02检查命名与函数职责
- 03检查类型标注和文档字符串
- 04发现可读性风险与死代码
- 05提供精简修改计划
适用场景
- 01合并前审查 Python 模块
- 02找出缺少的类型标注和文档
- 03改进命名与函数边界
- 04规划有针对性的代码风格修改
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/python-code-style确认已加载。
附带文件references/style-configs.md
详细介绍
Python 代码风格
机械性的风格检查交给工具，名称、边界和文档则依靠人的判断。目标是编写易读、易审查和易维护的代码。
具体配置和文档字符串模板请参阅 references/style-configs.md。
默认规范
- 除非项目已有其他规范，否则使用
ruff进行 lint 检查、导入排序和格式化。 - 为公共 API 和不明显的内部边界添加类型提示。
- 优先使用清晰的名称，避免缩写。
- 按以下顺序分组导入：标准库、第三方库、本地模块。
- 由格式化工具决定如何换行。
审查清单
检查：
- 名称是否能表达领域含义；
- 函数是否各自只负责一项明确的工作；
- 公共函数和类是否有类型注解；
- 文档字符串是否说明行为、输入、输出和重要副作用；
- 错误是否明确且有帮助；
- 导入是否组织有序；
- 是否已移除无用代码和注释掉的代码。
命名
- 函数和变量：
snake_case。 - 类：
PascalCase。 - 常量：
SCREAMING_SNAKE_CASE。 - 仅在确属内部实现时，才为私有辅助项添加前导下划线。
- 除非用于范围很小的数学或局部上下文，否则避免使用单字母名称。
文档
说明原因和约定，而不是逐行解释。为公共 API、复杂转换以及未来读者可能误用的内容添加文档字符串。
输出
返回：
- 风格和配置建议；
- 命名问题；
- 类型标注和文档字符串方面的缺漏；
- 可能影响可读性的问题；
- 最小补丁计划。
评论
支持 Markdown