SuperAPI AI 工具集

python-best-practices-fail-fast-imports

编程与开发

查看项目

更新于 10-16 05:05

技能介绍

用途:该技能用于强制 Python 的 fail-fast 导入原则,即所有依赖在模块加载时立即导入,缺失依赖应在启动阶段报错,而不是运行到某处才失败。它扫描 Python 文件中的导入反模式并报告违规位置与修复建议。

主要能力:检测四类违规——try/except ImportError 可选导入、基于配置的条件导入、函数或类内部的延迟导入、带默认回退的导入(静默降级)。输出包含 file:line 引用、影响等级和具体修复示例;无违规时返回通过结果,有违规时以退出码 1 阻止提交。

使用方式:可在修改导入语句后、提交前、质量门禁(pre-commit 钩子)或代码审查时调用。典型调用形式为 validate_fail_fast_imports(changed_files) 或 validate_fail_fast_imports("src/")。也可用 grep 辅助检测,例如 grep -rn "except ImportError:" src/ 和 grep -rn "_AVAILABLE = False" src/。

适用场景:Python 项目导入规范检查、CI/CD 质量门禁、架构守护代理委派导入校验,以及修复 ImportError 反模式时的指导。

限制:资料未提供具体安装命令、支持的 Python 版本、性能基准的独立验证方式;检测延迟导入需结合上下文,grep 无法完全覆盖。资料声称精度 100%、召回 95%+、单文件 <0.5s,但未提供可复现的测试细节。对于确实可选的依赖,资料建议改为必需、拆分插件模块或移除相关功能,而非保留可选导入。