首页
/ Tach项目中基于Glob模式禁止特定模块导入的实现

Tach项目中基于Glob模式禁止特定模块导入的实现

2025-07-02 05:07:44作者:明树来

在Python项目开发中,模块间的依赖管理是一个重要课题。Tach作为一款依赖关系管理工具,近期通过版本更新引入了基于Glob模式的模块导入限制功能,为开发者提供了更灵活的依赖控制手段。

背景需求

在实际项目中,我们经常需要限制某些特定模块的导入行为。例如,测试代码(test_*.py)通常不应该被生产代码导入,同时测试模块之间也应避免相互依赖,以保持测试的独立性和可维护性。

传统解决方案需要显式列出所有需要限制的模块路径,这在大型项目中会变得难以维护。Tach 0.27.2版本引入的Glob模式支持,为这一问题提供了优雅的解决方案。

实现方案

Tach现在支持三种关键位置的Glob模式匹配:

  1. 模块路径定义:可以使用**匹配任意多级路径,或*匹配单级路径

    [[modules]]
    path = "tests.**"  # 匹配所有tests包及其子包
    
  2. 依赖关系声明:同样支持Glob模式

    depends_on = ["utils.*"]  # 允许依赖utils包下的直接子模块
    
  3. 禁止依赖声明:新增的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包下的所有模块
]

技术实现要点

  1. Glob模式解析:Tach内部将Glob模式转换为正则表达式进行匹配
  2. 模块优先级:显式定义的模块路径会覆盖Glob匹配的结果
  3. 冲突检测:当多个规则冲突时,采用"就近原则"处理

最佳实践建议

  1. 对于大型项目,建议先使用宽泛的Glob模式定义基础规则,再针对特殊情况添加具体规则
  2. 测试代码建议统一放在特定包(如tests)中,便于统一管理
  3. 定期运行依赖检查,确保配置的规则符合预期

Tach的这一功能增强,使得项目依赖管理更加灵活和强大,特别适合中大型Python项目的架构治理需求。通过合理配置,开发者可以有效地实施架构约束,保持代码库的整洁和可维护性。

登录后查看全文
热门项目推荐

最新内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
148
1.95 K
kernelkernel
deepin linux kernel
C
22
6
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
274
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
931
555
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
980
395
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
66
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.11 K
0
openHiTLS-examplesopenHiTLS-examples
本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
65
515