如何在Python中禁止某个特定的子模块被外部调用?

陌涛君_7782

陌涛君_7782

2026-06-19

126人浏览

原创

__all__ 明确导出列表是最直接有效的方式,它限定 from module import * 可见符号,需配合下划线命名、__init__.py 导入控制及打包配置排除私有模块。

如何在python中禁止某个特定的子模块被外部调用?

用 __all__ 明确导出列表是最直接有效的方式

Python 模块默认会把所有不以下划线开头的公有名称都暴露出去,但 __all__ 能强制限定 from module import * 可见的符号。它不阻止直接导入(比如 import module.submod),但能显著降低误用概率,是 PEP 8 推荐的惯用法。

实操建议:

python-code-analyz
python-code-analyz

专业Python代码分析与优化,支持语法检查、安全扫描、性能评估、复杂度分析及重构后优化代码生成。

下载
  • 在子模块(如 mylib/utils/internal.py)顶部显式定义 __all__ = [],让它空着——这样 from mylib.utils.internal import * 什么也得不到
  • 若该子模块本就不该被外部直接引用,更推荐把它重命名为 _internal.py(加前导下划线),这是 Python 社区公认的“私有模块”信号
  • __all__ 只影响 import *,对 import mylib.utils.internal 或 from mylib.utils import internal 无效,所以必须配合命名规范一起用

在父模块中不导入、不转发私有子模块

即使子模块本身没被 __all__ 放行,只要父模块(如 mylib/utils/__init__.py)里写了 from . import internal 或 from .internal import helper,外部仍可能通过 mylib.utils.internal 访问到它。

实操建议:

  • 检查所有上级 __init__.py,删掉对目标子模块的导入语句
  • 如果父模块需要内部使用该子模块,用局部导入:在函数或类内部写 from . import internal,而不是模块顶层导入
  • 避免在 __init__.py 中用 import *,它会把子模块名直接拖进父模块命名空间

运行时抛错拦截非法访问(慎用)

想彻底封死路径?可以在子模块顶部加一段运行时检查,判断调用栈是否来自允许的模块。但这属于防御性过载,通常没必要,且容易被绕过。

实操建议:

  • 仅在强约束场景(如 SDK 分发、插件沙箱)考虑,例如:
    import inspect
    if not any("mylib/" in f.filename for f in inspect.stack()):
        raise ImportError("mylib._secret is private, do not import directly")
  • 注意 inspect.stack() 开销较大,不能放在高频路径;而且单元测试、REPL 等环境可能触发误报
  • 这种做法破坏了 Python 的“责任共担”哲学——模块作者应靠文档和命名提示,而非强行阻断

真正关键的是包结构与命名的一致性

Python 没有真正的私有模块访问控制机制,_ 命名 + __all__ + 文档说明才是实际有效的组合。最容易被忽略的点是:很多人只改了子模块名,却忘了同步清理 setup.py 的 packages 列表或 pyproject.toml 的 packages 配置——导致打包后仍把不该发布的模块塞进了安装包里。

务必确认:find_packages(exclude=["tests*", "examples*", "*._*"]) 或等效配置已排除所有带下划线前缀的子模块目录。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

python

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1671

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

4224

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1669

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

24597

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3007

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3027

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1163

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

596

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2343

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程