0

0

Python namespace package 的现代用法

舞夢輝影

舞夢輝影

发布时间:2026-02-20 01:25:17

|

254人浏览过

|

来源于php中文网

原创

python 3.3+ 因pep 420支持隐式命名空间包,故__init__.py不再必需;其核心作用是跨路径合并同名包,适用于多发行单元场景(如google.cloud),单目录项目中加不加影响甚微,但显式添加更稳定、ide友好。

python namespace package 的现代用法

为什么 __init__.py 不再是必须的

Python 3.3+ 引入了 PEP 420,正式支持隐式命名空间包(implicit namespace packages),这意味着目录只要符合结构、不包含 __init__.py,也能被识别为包——前提是它被 Python 的导入系统“发现”。

常见错误现象:ModuleNotFoundError: No module named 'mylib.utils',但目录结构明明存在,只是没放 __init__.py。这往往不是因为“不能用”,而是路径没进 sys.path,或用了旧版工具(如某些 IDE 缓存未刷新)。

  • 只有当包分散在多个物理路径(比如不同 eggs、不同 src 子目录)时,隐式命名空间包才真正发挥作用;单目录项目里加不加 __init__.py 几乎无感
  • pip install -e . 会自动处理命名空间逻辑,但直接 python -m mylib 运行时,当前目录是否在 sys.path 才决定能否导入
  • 如果你用的是 src/ 布局(比如 src/mylib/utils.py),推荐显式加空 __init__.py:它更稳定、IDE 支持更好、且明确表达了“这是个包”

pyproject.toml 中如何声明命名空间包

现代 Python 项目不再靠 setup.py,而用 pyproject.toml 配置打包行为。命名空间包的关键不在“声明”,而在“不阻止”——即避免把子包当成独立发行单元。

使用场景:你有 company.corecompany.cli 两个子包,想分别发布,又希望用户能统一导入 import company.coreimport company.cli

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

doxygen 官方手册
doxygen 官方手册

doxygen是一款好用的程序员辅助工具,它可以让程序添加批添代码更加简单轻松,兼容C++、 C、Java、 Objective-C、Python等主流编程语言,小编提供的doxygen中文手册包含了基本介绍、语法技巧以及进阶技巧等内容,可以让你快速上手操作,有需要的欢迎下载。 基本介绍 Doxygen已经支持生成ANSI编码的chm目录文件(index.hhc)!Doxygen通常是用作生成英文文档的,生成中文文档需要修改输入和输出的码制,这样可以改变解析方式,生成中文文档。但是,你必须意识 到,Dox

下载
  • 每个子包的 pyproject.toml 中,project.name 必须唯一(如 "company-core""company-cli"),但 project.packages 要设为 { include = ["company/**"] },而非 ["company.core"]
  • 绝对不要在任一子包中提供 company/__init__.py——那是显式包的标志,会阻断跨发行版的命名空间合并
  • 验证方式:安装两个包后,在 Python 中执行 import company; print(company.__path__),输出应是多个路径组成的 _NamespacePath

什么时候该用命名空间包,什么时候不该

命名空间包不是“高级功能”,而是解决特定分发问题的机制。滥用反而增加维护成本和用户困惑。

容易踩的坑:团队成员误以为“没 __init__.py 就是错的”,手动补上导致命名空间失效;或者为了“看起来现代”强行拆包,结果 CI 构建失败、类型检查器报错。

  • 适合用:组织大型组织级生态(如 google.cloudazure.mgmt),各服务由不同团队独立发布
  • 不适合用:单体应用内部模块划分(如 app.models / app.views)——这时用普通包 + 显式 __init__.py 更清晰、可调试、IDE 友好
  • 性能影响极小,但 import 时需遍历 sys.path 查找所有匹配前缀的目录,路径越多越慢;生产环境建议控制命名空间层级 ≤ 2(如 org.lib,别到 org.team.project.lib

VS Code / PyCharm 下的常见识别问题

编辑器对隐式命名空间包的支持滞后于解释器。你代码能跑通,但 IDE 可能标红、跳转失败、类型提示缺失。

典型错误现象:Import "company.core" could not be resolved(Pylance)、右键 “Go to Definition” 提示 “No definition found”。

  • VS Code:确保工作区根目录含 pyproject.toml,并在设置中启用 "python.defaultInterpreterPath" 指向正确 Python 环境;必要时在 .vscode/settings.json"python.analysis.extraPaths": ["src"]
  • PyCharm:File → Settings → Project → Python Interpreter → Show All → 选中解释器 → Show Paths → 手动添加你的 src 或包根目录
  • 最稳妥的绕过方式:在项目根下加一个空的 company/__init__.py(仅用于开发),但发布时删掉——这不是 hack,PEP 420 明确允许“混合模式”

隐式命名空间包真正的复杂点不在写法,而在协作边界:它要求所有相关方(开发者、CI、打包工具、编辑器)对“包在哪”有一致认知。一旦路径管理松散,问题就从运行时报错变成环境不一致的幽灵 bug。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

442

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

544

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

322

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

81

2025.09.10

pip安装使用方法
pip安装使用方法

安装步骤:1、确保Python已经正确安装在您的计算机上;2、下载“get-pip.py”脚本;3、按下Win + R键,然后输入cmd并按下Enter键来打开命令行窗口;4、在命令行窗口中,使用cd命令切换到“get-pip.py”所在的目录;5、执行安装命令;6、验证安装结果即可。大家可以访问本专题下的文章,了解pip安装使用方法的更多内容。

349

2023.10.09

更新pip版本
更新pip版本

更新pip版本方法有使用pip自身更新、使用操作系统自带的包管理工具、使用python包管理工具、手动安装最新版本。想了解更多相关的内容,请阅读专题下面的文章。

426

2024.12.20

pip设置清华源
pip设置清华源

设置方法:1、打开终端或命令提示符窗口;2、运行“touch ~/.pip/pip.conf”命令创建一个名为pip的配置文件;3、打开pip.conf文件,然后添加“[global];index-url = https://pypi.tuna.tsinghua.edu.cn/simple”内容,这将把pip的镜像源设置为清华大学的镜像源;4、保存并关闭文件即可。

786

2024.12.23

python升级pip
python升级pip

本专题整合了python升级pip相关教程,阅读下面的文章了解更多详细内容。

359

2025.07.23

pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法
pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法

本专题系统整理pixiv网页版官网入口及登录访问方式,涵盖官网登录页面直达路径、在线阅读入口及快速进入方法说明,帮助用户高效找到pixiv官方网站,实现便捷、安全的网页端浏览与账号登录体验。

660

2026.02.13

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 22.4万人学习

Django 教程
Django 教程

共28课时 | 4.4万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.6万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号