Tach项目中基于Glob模式禁止特定模块导入的实现
2025-07-02 12:16:34作者:明树来
在Python项目开发中,模块间的依赖管理是一个重要课题。Tach作为一款依赖关系管理工具,近期通过版本更新引入了基于Glob模式的模块导入限制功能,为开发者提供了更灵活的依赖控制手段。
背景需求
在实际项目中,我们经常需要限制某些特定模块的导入行为。例如,测试代码(test_*.py)通常不应该被生产代码导入,同时测试模块之间也应避免相互依赖,以保持测试的独立性和可维护性。
传统解决方案需要显式列出所有需要限制的模块路径,这在大型项目中会变得难以维护。Tach 0.27.2版本引入的Glob模式支持,为这一问题提供了优雅的解决方案。
实现方案
Tach现在支持三种关键位置的Glob模式匹配:
-
模块路径定义:可以使用
**匹配任意多级路径,或*匹配单级路径[[modules]] path = "tests.**" # 匹配所有tests包及其子包 -
依赖关系声明:同样支持Glob模式
depends_on = ["utils.*"] # 允许依赖utils包下的直接子模块 -
禁止依赖声明:新增的
cannot_depend_on配置项cannot_depend_on = ["**.test_*"] # 禁止导入任何test_开头的模块
实际应用示例
场景一:隔离测试代码
[[modules]]
path = "tests.**"
depends_on = ["production"] # 测试代码只能依赖生产代码
[[modules]]
path = "production"
cannot_depend_on = ["tests.**"] # 生产代码禁止依赖测试代码
这种配置确保了:
- 生产代码不会意外导入测试代码
- 测试模块之间默认不能相互导入
- 测试代码可以访问它需要测试的生产代码
场景二:禁止特定模式模块导入
[[modules]]
path = "src"
cannot_depend_on = [
"**.test_*", # 禁止导入任何test_开头的文件
"**.fixtures.*" # 禁止导入fixtures包下的所有模块
]
技术实现要点
- Glob模式解析:Tach内部将Glob模式转换为正则表达式进行匹配
- 模块优先级:显式定义的模块路径会覆盖Glob匹配的结果
- 冲突检测:当多个规则冲突时,采用"就近原则"处理
最佳实践建议
- 对于大型项目,建议先使用宽泛的Glob模式定义基础规则,再针对特殊情况添加具体规则
- 测试代码建议统一放在特定包(如
tests)中,便于统一管理 - 定期运行依赖检查,确保配置的规则符合预期
Tach的这一功能增强,使得项目依赖管理更加灵活和强大,特别适合中大型Python项目的架构治理需求。通过合理配置,开发者可以有效地实施架构约束,保持代码库的整洁和可维护性。
登录后查看全文
热门项目推荐
相关项目推荐
暂无数据
项目优选
收起
deepin linux kernel
C
27
11
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
539
3.76 K
Ascend Extension for PyTorch
Python
349
414
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
889
609
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
338
185
openJiuwen agent-studio提供零码、低码可视化开发和工作流编排,模型、知识库、插件等各资源管理能力
TSX
986
252
openGauss kernel ~ openGauss is an open source relational database management system
C++
169
233
暂无简介
Dart
778
193
华为昇腾面向大规模分布式训练的多模态大模型套件,支撑多模态生成、多模态理解。
Python
114
140
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.35 K
758