SuperAPI AI 工具集

python-anti-patterns

编程与开发

查看项目

更新于 10-16 00:30

技能介绍

用途:这是一份 Python 常见错误与反模式的参考清单,适合在代码合并前审查、调试疑难问题、教学或学习 Python 最佳实践、制定团队编码规范以及重构遗留代码时使用。该技能聚焦“应避免什么”,正向模式与架构可参考 python-design-patterns 技能。

主要能力与检查要点: 基础设施:避免超时/重试逻辑散落各处(应集中到装饰器或客户端封装)、避免应用层与基础设施层双重重试、避免硬编码配置与密钥(改用环境变量配合 pydantic-settings 等类型化设置)。 架构:避免对外暴露内部类型(如 ORM 模型,应使用 DTO/响应模型)、避免 I/O 与业务逻辑混杂(可用仓储模式保持业务逻辑纯粹)。 错误处理:避免裸 except Exception: pass 静默吞异常(应捕获具体异常并记录或处理)、避免批处理遇首个错误即中止(应返回同时包含成功与失败的结果)、避免缺少输入校验(应在 API 边界用 Pydantic 提前校验)。 资源:避免未关闭的资源(使用上下文管理器)、避免在异步代码中调用阻塞函数(改用异步原生库)。 类型安全:避免缺少类型注解、避免无类型参数的集合(如 list 应写成 list[User])。 测试:避免只测正常路径(应覆盖错误与边界情况)、避免过度 mock(关键路径用集成测试,仅 mock 外部服务)。

使用方式:作为审查清单逐项核对,文中给出“BAD/GOOD”对照示例与常见修复对照表,例如集中式重试装饰器、环境变量配置、DTO 响应模型、仓储模式、捕获具体异常、BatchResult、Pydantic 校验、上下文管理器、异步库、类型注解、错误与边界测试。

限制:资料未提供安装命令、运行方式、平台支持、收费或价格信息,暂未提供。