0

0

如何使用 pip 安装本地 Python 项目并自动识别嵌套子包

聖光之護

聖光之護

发布时间:2025-12-27 10:57:16

|

835人浏览过

|

来源于php中文网

原创

如何使用 pip 安装本地 Python 项目并自动识别嵌套子包

本文详解如何通过 `pip install -e .` 正确安装采用“ad-hoc 布局”的本地 python 项目,解决 `find_packages(where='mypkg')` 报错及子包不可导入的问题,关键在于配置 `package_dir` 映射源码根目录与实际包路径。

在开发多层嵌套的本地 Python 项目时(如 mypkg/subpkg1/, mypkg/subpkg2/),常希望仅执行一条命令(如 pip install -e .)即可完成可编辑安装,并让所有带 __init__.py 的子目录自动作为可导入子包。但若项目结构为典型的 ad-hoc layout(即包代码位于子目录 mypkg/ 下,而非与 setup.py 同级),直接使用 find_packages() 很容易失败——典型报错如:

error: package directory 'subpkg1' does not exist

该错误并非因为目录真实缺失,而是 setuptools.find_packages() 默认在当前目录(即 project_root_directory)下查找包,而你的包实际位于 mypkg/ 子目录中。此时,仅靠 find_packages(where='mypkg') 是不够的:它能发现 mypkg.subpkg1 等包,但 setuptools 仍会尝试从项目根路径解析模块路径,导致路径映射错位。

✅ 正确解法是同时声明 package_dir,显式告诉 setuptools:“当导入 mypkg 及其子包时,请从 mypkg/ 目录下加载源码”。

修改你的 setup.py 如下:

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

蝉镜
蝉镜

AI数字人视频创作平台,100+精品数字人形象库任您选择

下载
from setuptools import setup, find_packages

setup(
    name="Code",
    author="Me",
    author_email="me@example.com",
    description="My local Python project",
    package_dir={"": "mypkg"},  # ? 关键!将空字符串(即顶层包名)映射到 'mypkg' 目录
    packages=find_packages(where="mypkg"),  # 在 mypkg/ 下自动发现所有子包
    python_requires=">=3.6",
)
? 补充说明:package_dir={"": "mypkg"} 表示“所有未指定前缀的包(包括 mypkg 本身)均从 mypkg/ 目录读取”。这样 find_packages(where="mypkg") 才能与安装时的路径解析逻辑对齐。

✅ 安装验证:

pip install -e .

安装成功后,即可在 Python 中正常导入:

from mypkg import module          # ✔️ 主包
from mypkg.subpkg1 import module1 # ✔️ 子包
import mypkg.subpkg2.module2      # ✔️ 深层嵌套

⚠️ 注意事项:

  • __init__.py 文件必须存在且非空(至少含 __all__ 或 pass),否则 find_packages() 会跳过该目录;
  • 若使用 pyproject.toml(推荐现代项目),应改用 setuptools 配置块,并保留等效逻辑([project] + [tool.setuptools]);
  • IDE(如 VS Code、PyCharm)可能因缓存延迟无法立即支持 tab 补全,重启 Python 解释器或刷新环境后通常可恢复;
  • 避免在 packages 中手动列出子包名(如 ["mypkg", "mypkg.subpkg1"]),这会绕过自动发现机制,丧失可维护性。

总结:package_dir={"": "mypkg"} 是 ad-hoc 布局下实现一键可编辑安装与完整子包可见性的核心配置。它桥接了物理目录结构与 Python 包命名空间,是本地开发中兼顾简洁性与规范性的最佳实践。

相关专题

更多
python开发工具
python开发工具

php中文网为大家提供各种python开发工具,好的开发工具,可帮助开发者攻克编程学习中的基础障碍,理解每一行源代码在程序执行时在计算机中的过程。php中文网还为大家带来python相关课程以及相关文章等内容,供大家免费下载使用。

708

2023.06.15

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

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

625

2023.07.20

python能做什么
python能做什么

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

736

2023.07.25

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

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

616

2023.07.31

python教程
python教程

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

1234

2023.08.03

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

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

547

2023.08.04

python eval
python eval

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

573

2023.08.04

scratch和python区别
scratch和python区别

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

695

2023.08.11

ip地址修改教程大全
ip地址修改教程大全

本专题整合了ip地址修改教程大全,阅读下面的文章自行寻找合适的解决教程。

27

2025.12.26

热门下载

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

精品课程

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

共4课时 | 0.6万人学习

Django 教程
Django 教程

共28课时 | 2.5万人学习

SciPy 教程
SciPy 教程

共10课时 | 0.9万人学习

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

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