用途:在编写或审查 Python 代码时提供风格与规范指导,目标是产出易于评审和维护的可读代码。机械性风格交给工具处理,命名、边界划分与文档则依赖人工判断。
主要能力与约定:默认使用 ruff 进行 lint、导入排序和格式化,除非项目已有其他标准;公共 API 及不明显的内部边界使用类型提示;优先使用清晰命名而非缩写;导入按标准库、第三方、本地三组划分;换行交给格式化工具决定。
审查清单:名称是否体现领域含义;函数是否职责单一;公共函数/类是否有类型注解;文档字符串是否说明行为、输入、输出及重要副作用;错误是否明确有用;导入是否有序;是否移除了死代码和注释掉的代码。
命名规范:函数与变量用 snake_case,类用 PascalCase,常量用 SCREAMING_SNAKE_CASE;仅真正内部使用的辅助函数才加前导下划线;除紧密的数学或局部上下文外避免单字母命名。
文档:说明原因与契约,而非逐行注释。为公共 API、复杂转换以及可能被误用的内容添加文档字符串。
输出形式:返回风格/配置建议、命名问题、类型与文档字符串缺口、风险性可读性问题以及最小修改方案。
限制:具体配置与文档字符串模板需查阅其 references/style-configs.md;资料未提供收费、价格、平台或其他细节。