讲师中心 微信公众号
AI工具推荐 视频效率加速

如何在Python中通过__all__变量精确控制模块导出接口

落辰吖_4885

落辰吖_4885

发布时间:2026-11-07 10:59:16

|

863人浏览过

|

来源于php中文网

原创

__all__仅控制from module import *的导入范围,不提供访问控制;它是向用户声明公共API的约定,影响IDE补全、文档生成和类型检查,但无法阻止显式导入或点号访问。

如何在python中通过__all__变量精确控制模块导出接口

__all__ 只影响 from module import * 的行为

很多人误以为 __all__ 能限制所有导入方式,其实它只对 from module import * 生效。直接 import module 后用 module.func,或 from module import func 都完全不受 __all__ 约束——Python 解释器根本不会检查它。

这意味着:__all__ 是一种“礼貌性声明”,不是访问控制机制。它的实际作用是告诉使用者:“这些是模块作者明确推荐的公共接口”,同时让 IDE、文档生成工具(如 Sphinx)和静态分析器(如 mypy)能更准确地识别导出内容。

定义 __all__ 的常见错误写法

最常踩的坑是把 __all__ 放错位置或类型不对:

  • __all__ 必须是模块顶层的 list 或 tuple,且元素必须是字符串 —— 写成 __all__ = [my_func](变量名未加引号)会直接报 NameError
  • 在 if __name__ == "__main__": 块里定义 __all__ 无效,它必须在模块全局作用域
  • 动态生成时(比如遍历 dir() 过滤),容易漏掉双下划线方法或引入私有名,不推荐

正确写法示例:

立即学习“Python免费学习笔记(深入)”;

Python Hardener
Python Hardener

通过完整的安全审查、代码整洁重构、健壮的错误处理、正确的日志记录以及完整的文档字符串覆盖,强化 Python 脚本。

下载
def public_func():
    return "ok"
<p>def _private_helper():
return 42</p><p>class PublicClass:
pass</p><p><strong>all</strong> = ["public_func", "PublicClass"]  # 字符串列表,不含 _private_helper

与 from ... import ... 的组合行为

当模块 A 定义了 __all__ = ["foo"],而模块 B 执行 from A import *,B 中只会得到 foo;但若 B 写的是 from A import foo, _private_helper,即使 _private_helper 不在 __all__ 里,也能成功导入并使用。

更隐蔽的问题出现在子模块重导出场景:

  • 如果 pkg/__init__.py 中写 from .submod import func 但没把 func 加入自己的 __all__,那么 from pkg import * 就不会包含 func
  • 要实现“透传导出”,得显式写 __all__ = ["func"] 或 __all__ = submod.__all__(前提是 submod 本身定义了 __all__)

__all__ 对打包和类型检查的实际影响

虽然运行时不强制,但在工程实践中它直接影响下游体验:

  • PyPI 包发布时,__all__ 是 pyright 和 mypy 推断模块公共 API 的主要依据;缺省时工具可能把所有顶层名称都当作可导出项,导致误报“未声明的导入”
  • 打包成 wheel 后,IDE 的自动补全(如 VS Code 的 Pylance)依赖 __all__ 缩小候选范围,否则会列出大量内部函数和测试变量
  • 如果模块用了 __getattr__ 实现懒加载,__all__ 还需手动维护,否则 from mod import * 无法触发懒加载逻辑

所以别把它当成可选装饰——只要模块有明确的对外接口边界,__all__ 就该和函数、类一起被写进源码,且每次增删接口时同步更新。

热门AI工具

更多
SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

讯飞智文

一款面向学习和办公场景的AI文档创作工具,可辅助生成PPT与Word文档,提高资料整理和内容制作效率。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

相关专题

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

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

1891

2023.07.20

python能做什么
python能做什么

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

5164

2023.07.25

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

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

1829

2023.07.31

python教程
python教程

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

31177

2023.08.03

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

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

3687

2023.08.04

python eval
python eval

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

3707

2023.08.04

scratch和python区别
scratch和python区别

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

1243

2023.08.11

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

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

616

2023.08.10

DBeaver怎么导入数据
DBeaver怎么导入数据

DBeaver数据导入专题,整理Excel、CSV、SQL、TXT等常见文件的数据导入方法,涵盖目标数据库选择、数据表创建、字段映射、数据类型设置及导入参数配置等操作,帮助用户将本地文件中的数据写入数据库,并了解批量导入、重复数据处理和导入失败等常见问题的解决方法。

20

2026.11.05

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn