Python包中如何隐藏内部私有子模块不被外部直接导入

千辰小哥_9605

千辰小哥_9605

2026-09-20

936人浏览

原创

最简单有效的第一步是用\_前缀重命名子模块,如\_internal.py,它能向python社区发出私有模块信号,避免被from package import *暴露和ide默认补全。

python包中如何隐藏内部私有子模块不被外部直接导入

_ 前缀重命名子模块是最简单有效的第一步

Python 社区公认:以单下划线开头的模块名(如 _internal.py_utils.py)是“私有模块”信号。它不会被 from package import * 暴露,也不会出现在 IDE 自动补全的默认建议列表里。

常见错误现象:有人只把文件改成 internal.py,但没加下划线,结果外部仍能轻松 from mypkg import internal —— 这完全没效果。

  • 必须重命名为 _internal.py,不是 internal.pyInternal.py
  • 重命名后,检查所有上级 __init__.py,确保里面没有 from . import _internalfrom ._internal import helper
  • 如果该模块仅用于内部逻辑,连 _internal.py 本身都不应出现在 setup.pypackages 列表或 pyproject.toml[project.optional-dependencies] 之外的包声明中——否则打包时仍会被安装并可导入

__all__ 在子模块里设为空列表不起作用,但在父模块 __init__.py 中必须清理导入

__all__ = [] 放在 _internal.py 顶部,对阻止 from mypkg._internal import * 有用;但它**完全无法阻止** import mypkg._internalfrom mypkg import _internal —— 因为 __all__ 只约束 import * 行为。

真正关键的是父模块的 __init__.py

  • 删掉所有类似 from ._internal import somethingfrom . import _internal 的语句
  • 避免在 __init__.py 中写 import *,比如 from ._internal import * —— 这会把符号拖进父命名空间
  • 如果父模块内部确实需要使用 _internal,改用局部导入:在函数体或类方法内写 from ._internal import helper,而不是放在模块顶层

禁用 import 的运行时拦截不推荐,除非强沙箱场景

有人试图在 _internal.py 开头加 inspect.stack() 检查调用来源,发现非授权模块就抛 ImportError。这看似彻底,但问题很多:

Python数据分析(免费版)
Python数据分析(免费版)

提供Python数据清洗、统计分析与可视化建议,覆盖业务报表与科研数据的快速处理流程。

下载
  • inspect.stack() 性能开销大,不能出现在高频路径(比如每次 HTTP 请求都触发)
  • 单元测试、REPL、调试器常会误报,导致开发体验断裂
  • 用户仍可通过 importlib.util.spec_from_file_location 绕过,实际封不住
  • 违背 Python “我们都是 consenting adults” 哲学:靠命名和文档提示,比 runtime 报错更可持续

打包配置遗漏是线上最常踩的坑

本地测试时一切正常,一发版到 PyPI,用户却能 import mypkg._internal —— 很大概率是 pyproject.tomlsetup.py 里漏掉了排除逻辑。

例如,在 pyproject.toml 中:

[[tool.setuptools.package-data]]
"mypkg.*" = ["*.py"]
# ❌ 这样会把 _internal.py 也打包进去

正确做法是显式声明只包含公有模块:

[tool.setuptools.packages.find]
where = ["src"]
include = ["mypkg", "mypkg.*"]
exclude = ["mypkg._*", "mypkg.tests*"]

或者更稳妥:不用自动发现,手动列明 packages = ["mypkg", "mypkg.utils", "mypkg.api"],彻底不提 _internal

名字加了 _ 只是约定,真正让它“消失”的,是打包时没把它放进分发包里。

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

相关文章

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

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

下载

相关标签:

python python包

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

相关专题

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

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

2023.07.20

1531

4

python能做什么
python能做什么

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

2023.07.25

3584

7

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

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

2023.07.31

1549

3

python教程
python教程

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

2023.08.03

20357

23

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

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

2023.08.04

2527

5

python eval
python eval

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

2023.08.04

2587

5

scratch和python区别
scratch和python区别

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

2023.08.11

1063

5

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

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

2023.08.10

576

4

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

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

2023.08.11

2003

5

热门下载

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

精品课程

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