关于 python-expert-best-practices-code-review
面向使用 Python 3.14+ 编写、审查或重构生产代码的开发者,提供精简规则集。规则按优先级分类,并链接到详细说明和示例。
主要功能
- 01按优先级分类规则
- 02字典键错误处理
- 03避免可变默认值
- 04异常与运算符指导
- 05代码清晰度与风格规范
- 06含示例的规则文件
适用场景
- 01审查 Python 错误处理
- 02重构函数默认值与运算符
- 03验证 API 边界代码
- 04发现 Python 模块中的可读性问题
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ wispbit-ai/ skills --skill python-expert-best-practices-code-review安装后在 Claude Code 中输入/python-expert-best-practices-code-review确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
rules/avoid-explanatory-comments.mddict-required-keys.mdlistcomp-no-side-effects.mdno-generic-except.mdno-inline-imports.mdno-mutable-defaults.mdoperators-return-notimplemented.mdunnecessary-else-blocks.md详细介绍
Python 3.14+ 专家级最佳实践
简单、务实、有主见。只涵盖编写可用于生产环境的 Python 代码时真正重要的内容。
适用场景
在以下情况下参考这些指南:
- 编写 Python 函数、类或模块
- 检查 Python 代码中的错误处理问题
- 重构现有 Python 代码库
- 实现数据验证和 API 边界
- 优化错误检测和调试模式
按优先级划分的规则类别
| 优先级 | 类别 | 影响 | 前缀 |
|---|---|---|---|
| 1 | 错误处理 | 严重 | dict-、operators- |
| 2 | 常见错误 | 严重-高 | no-mutable-、no-generic- |
| 3 | 代码清晰度 | 高-中 | listcomp-、no-inline- |
| 4 | 代码风格 | 低 | avoid-、unnecessary- |
快速参考
dict-required-keys- 必需的字典键使用d[key],以便快速触发 KeyErrorno-mutable-defaults- 函数或方法参数中不要使用可变默认值operators-return-notimplemented- 对不支持的操作数类型返回 NotImplemented,并有意设计+与+=的行为no-generic-except- 避免使用通用 except 子句,以免隐藏意外错误listcomp-no-side-effects- 列表推导式必须生成你会使用的值(不要编写有副作用的列表推导式)no-inline-imports- 将所有 import 语句放在文件顶部avoid-explanatory-comments- 代码能够自我说明时,避免不必要的注释unnecessary-else-blocks- return、break 或 continue 语句之后避免使用不必要的 else 块
使用方法
阅读各个规则文件,了解详细说明和代码示例:
rules/dict-required-keys.md
rules/no-mutable-defaults.md
rules/operators-return-notimplemented.md
rules/no-generic-except.md
rules/listcomp-no-side-effects.md
rules/no-inline-imports.md
rules/avoid-explanatory-comments.md
rules/unnecessary-else-blocks.md
每个规则文件都包含:
- 简要说明规则的重要性
- 何时使用和何时不使用该模式
- 实现要求
- 附有说明的错误代码示例
- 附有说明的正确代码示例
- 其他背景信息和参考资料
评论
支持 Markdown