用途:这是一个面向 Python 代码的团队质量检查清单技能,适合在代码评审或合并前使用,用于统一检查代码质量、输入校验和测试覆盖情况。
主要检查项:代码质量方面要求所有函数有类型标注、不使用裸 except、不使用可变默认参数、文件 I/O 使用上下文管理器、函数不超过 50 行、变量与函数命名遵循 PEP 8 的 snake_case。输入校验方面要求处理前校验用户输入、处理边界情况(空字符串、None、越界值)、错误信息清晰有用。测试方面要求新代码有对应的 pytest 测试、覆盖边界情况、测试名称具有描述性。
使用方式:将本清单应用于待检查的 Python 代码,逐项核对,并按指定格式输出结果。输出格式为标题“## Code Checklist: [文件名]”,下分 Code Quality、Input Validation、Testing 三节,每条以 [PASS/FAIL] 加说明呈现,最后在 Summary 中给出需要处理的事项数量,例如“[X] items need attention before merge”。
适用场景:Python 项目日常代码评审、提交前自检、团队统一质量规范落地。
限制:资料未提供安装命令、具体调用方式、依赖版本、收费信息及与工具链的集成细节,这些内容暂未提供;清单本身不自动修复代码,只给出检查结论。