SuperAPI AI 工具集

clean-functions

编程与开发

查看项目

更新于 10-15 21:39

技能介绍

clean-functions 是一套面向 Python 函数的 Clean Code 规则技能,适用于编写、修复、编辑或重构 Python 函数的场景。它依据 Clean Code 原则对函数设计提出约束,主要包含四条规则。

F1 参数过多:函数参数最多 3 个。超过 3 个参数意味着函数职责过多,或应改用数据结构承载。示例中把 create_user(name, email, age, country, timezone, language, newsletter) 改为用 dataclass UserData 封装后只传一个 data 参数。

F2 禁止输出参数:不要通过副作用修改传入参数,而应返回值。例如 append_footer(report) 直接修改 report 属于反例,应改为 with_footer(report) 返回新值。

F3 禁止标志参数:布尔标志意味着函数至少做两件事。例如 render(is_test) 内部按标志分支调用不同渲染逻辑,应拆分为 render_test_page() 与 render_production_page() 两个函数。

F4 删除死函数:未被调用的函数应删除,不保留“以防万一”的代码,历史记录由 Git 保存。

使用方式为在涉及 Python 函数编写或重构时应用上述规则。资料未提供安装命令、依赖、平台支持、收费方式或具体工具集成细节,这些信息暂未提供。限制方面,规则针对 Python 函数设计,其他语言或非函数层面的代码组织未在资料中说明。