Python 模块边界治理的核心是职责清晰、依赖明确、变更可控,关键在于主动识别、约束和验证依赖:显式 import 为源头,动态 / 条件 / 相对导入需特殊处理;pyproject.toml 分类管理依赖;vulture 和 pydeps 扫描冗余与越界依赖;__all__和__init__.py 控制接口暴露。

Python 模块边界治理的核心,是让每个模块职责清晰、依赖明确、变更可控。关键不在于禁止依赖,而在于主动识别、约束和验证依赖关系。
用 import 语句定位真实依赖
模块的显式 import 是依赖的源头信号。但要注意:
- 动态导入(如 __import__()、importlib.import_module())不会被静态分析 工具 捕获,需人工标注或运行时日志辅助识别
- 条件导入(如if sys.version_info >= (3, 8): import zoneinfo)需按目标环境分别检查
- 相对导入(from .utils import helper)只在包内有效,跨包使用必须转为绝对导入
通过 pyproject.toml 声明接口契约
在项目根目录的 pyproject.toml 中,用 [project.optional-dependencies] 和[tool.black]等分段,把依赖分类管理:
- [project.dependencies]:运行时强依赖,所有功能路径都可能触发
- [project.optional-dependencies.test]:仅测试时需要,CI 中单独安装
- [tool.mypy]下配置disallow_untyped_defs = true,强制类型注解——这是隐式依赖(如未注解的函数返回值类型)的“显性化”手段
用 vulture 和pydeps做依赖体检
静态扫描工具能暴露被遗忘或冗余的依赖:
立即学习“Python 免费学习笔记(深入)”;
- vulture –min-confidence 80 your_package/ 找出未使用的导入和变量,提示可删减的依赖入口
- pydeps –max-bacon=2 –max-cluster-size=10 your_module.py 生成依赖图,快速识别跨层调用(如 api → db → utils → config 中api直接引用 config 属于越界)
- 结合pipdeptree –reverse –packages your_package,确认谁在拉取你的模块——反向依赖强弱决定你能否安全重构内部结构
模块边界靠 __all__ 和__init__.py收口
边界不是靠文件夹物理隔离,而是靠公开接口控制:
- 在 __init__.py 中显式定义__all__ = [“Client”, “connect”],其他符号即使存在也不应被外部导入
- 子模块内部用 _private_func() 命名约定,配合 from .sub import * 时不自动导入(前提是 __all__ 未包含它)
- 若某模块只供内部使用(如 yourpkg._internal.retry),不在任何__init__.py 中暴露,也不写入__all__,即默认为私有边界