SuperAPI AI 工具集

python-design-patterns

编程与开发

查看项目

更新于 10-16 07:31

技能介绍

用途

Python Design Patterns 是一个关于 Python 设计原则与模式的技能,目标是在设计新组件或服务、重构复杂或混乱代码、判断是否该创建抽象、在继承与组合之间做选择、评估代码复杂度与耦合度、规划模块化架构时,帮助写出易理解、易测试、易修改的 Python 代码。

核心概念

  1. KISS(保持简单):选择能正常工作的最简单方案,复杂性必须由具体需求来证明其合理性。

  2. 单一职责(SRP):每个单元应该只有一个变更理由,把关注点分离到聚焦的组件中。

  3. 组合优于继承:通过组合对象来构建行为,而不是扩展类。

  4. 三次法则:在有三个实例之前先不要抽象,重复往往优于过早抽象。

快速上手

技能给出的示例强调“简单胜过聪明”:

# Simple beats clever
# Instead of a factory/registry pattern:
FORMATTERS = {"json": JsonFormatter, "csv": CsvFormatter}

def get_formatter(name: str) -> Formatter:
    return FORMATTERS[name]()

详细的模式与完整示例记录在 references/details.md 中。当上方的导航层级不够用时,可以阅读该文件。

最佳实践摘要

  • 保持简单:选择能正常工作的最简单方案
  • 单一职责:每个单元只有一个变更理由
  • 分离关注点:不同层有清晰的目的
  • 组合,不要继承:组合对象以获得灵活性
  • 三次法则:先等待,再抽象
  • 保持函数小巧:约 20-50 行(视复杂度而定),只做一件事
  • 注入依赖:用构造函数注入以便测试
  • 抽象前先删除:移除死代码,再考虑模式
  • 逐层测试:对每个关注点做隔离测试
  • 显式优于聪明:可读代码胜过优雅代码

排障指南

  • 某个类不断膨胀,似乎有多个职责,但拆分感觉不对:应用“变更理由”测试——列出所有可能需要修改这个类的变更。如果列表中的项来自不同领域(例如 HTTP 解析、业务规则、格式化),就拆分它。如果所有变更都源于同一个领域关注点,那么这个类的规模可能是合适的。

  • 所有依赖都通过构造函数注入,导致构造函数有 7 个以上参数:这是一个类职责过多的信号,而不是依赖注入本身的问题。先把类拆成更小的单元,然后每个构造函数自然会更小。

  • 组合产生了难以追踪的深层嵌套包装对象:保持组合浅层(2-3 层)。如果包装是唯一机制,考虑基于 Protocol 的方式或简单的函数组合是否比一连串装饰器对象更清晰。

  • 三次法则说先不要抽象,但重复已经在某一份更新而另一份没更新时引发 bug:已经以危险方式产生分歧的重复应该更早抽象。三次法则是启发式,不是定律。如果副本已经出现错误分歧,立即提取,并添加一个覆盖共享行为的测试。

  • 服务层在导入 API 层,破坏了依赖方向:这是分层违规。服务层不得从处理程序导入。引入一个共享的 types/models 层供两者导入,保持依赖箭头向下(API → Service → Repository)。

相关技能

  • python-testing-patterns:利用这里建立的依赖注入结构,对每一层做隔离测试。
  • python-project-structure:组织模块和目录布局,让层边界从一开始就明确。

限制

技能中未提供关于支持平台、依赖版本、安装方式或收费模式的信息,这些内容暂未提供。