python-anti-patterns

概览

什么是 python-anti-patterns？

python-anti-patterns 是一款实用技能，旨在帮助 Python 开发者和团队识别并避免常见的编码错误。它提供了 Python 代码库中常见反模式的检查清单，方便在问题进入生产环境前及时发现。此技能特别适合代码审查、调试、重构遗留代码以及建立团队编码规范。

谁适合使用此技能？

• 希望提升代码质量的 Python 开发者
• 进行代码审查或重构的团队
• 教授 Python 最佳实践的教育者
• 维护或调试 Python 项目的任何人

python-anti-patterns 解决的问题

• 通过突出不良实践减少技术债务
• 帮助防止因常见错误引发的细微 bug
• 提供现成的检查清单，简化代码审查流程
• 通过明确应避免的内容，支持新成员入职培训

使用方法

安装步骤

1. 使用以下命令安装该技能：

   npx skills add https://github.com/wshobson/agents --skill python-anti-patterns
   

2. 安装完成后，首先查看 SKILL.md 文件，获取全面的 Python 反模式检查清单。

审查并应用检查清单

• 在代码审查时使用检查清单，及早发现问题。
• 参考每个反模式提供的示例，如避免分散的超时/重试逻辑和重复重试场景。
• 按建议集中处理错误和重试逻辑，提高代码可维护性。

适应您的工作流程

• 将检查清单整合进团队的代码审查流程。
• 用作新开发者入职培训的辅助工具。
• 在重构或调试现有代码时应用相关建议。

推荐查看的文件

• SKILL.md：主要检查清单和使用指南
• 相关技能：关于正向设计模式，请参见 python-design-patterns

常见问题

什么时候应该使用 python-anti-patterns？

在合并代码前、调试难以发现的 bug 时，或重构遗留 Python 代码时使用此技能。同时，它也适合用于教学最佳实践和制定团队标准。

涵盖哪些类型的反模式？

该技能涵盖诸如重复的超时/重试逻辑、多层重复重试以及其他可能导致 bug 或维护困难的常见陷阱。

这个技能可以用于任何 Python 项目吗？

可以，python-anti-patterns 在 Python 生态系统内语言无关，适用于任何 Python 代码库。

这个技能能替代正向设计指导吗？

不能，python-anti-patterns 侧重于避免的内容。有关推荐的设计模式和架构，请参考 python-design-patterns 技能。

哪里可以找到更多细节或示例？

打开 Files 标签，浏览完整文件树，包括 SKILL.md，其中包含详细的检查清单和代码示例。