SuperAPI AI 工具集

python-design

编程与开发

查看项目

更新于 10-16 06:48

技能介绍

用途:为 Python CLI 脚本与工具提供可维护性设计准则,适用于编写或修改 Python 文件、规划模块拆分、审查 Python 改动、重构杂乱脚本、新增子命令或工具函数。核心论点是管理复杂度而非堆功能;复杂度源于变更放大、认知负荷和未知未知,需靠无数小决策累积控制。

主要能力:深模块(隐藏功能多于暴露接口);类型优先开发(先定数据形状与函数签名,再实现,边界处做运行时校验);内部数据用 frozen dataclass,外部 JSON 用 TypedDict,领域原始值用 NewType,状态用可辨识联合;信息隐藏,避免 JSON 结构或路径约定散落多处;复杂度下沉到模块内部而非推给调用者;通过后置条件把错误定义得不复存在;KISS 与三次法则(出现三次再抽象);单一职责与按信息隐藏而非执行顺序拆分模块;共享能力统一放入 common/;解析命令输出时保留语义空白。

使用方式:作为设计检查清单在动手前使用(先定类型、检查模块深度、查重复、确认职责、设计错误、精确命名),也用于代码审查(扫描红旗、检查类型与信息隐藏、一致性与调用简单度)。建议每次改动投入约 10%–20% 改进周边设计。

限制:资料未提供安装命令、许可、价格、平台或具体 API 细节;内容基于《A Philosophy of Software Design》改编,属设计指导而非可直接运行的代码库。