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

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

老浩君_6930

老浩君_6930

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

|

875人浏览过

|

来源于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免费学习笔记(深入)”;

librosa Python 音频与音乐分析库
librosa Python 音频与音乐分析库

librosa 是一个用于音频和音乐分析的 Python 库。它提供了特征提取、频谱分析、节拍跟踪、起始检测和音频可视化的工具,基于 NumPy 和 SciPy 构建,用于科学音频计算。

下载
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 包命名空间,是本地开发中兼顾简洁性与规范性的最佳实践。

热门AI工具

更多
讯飞智文

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

豆包大模型

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

DeepSeek

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

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

Atoms
Atoms Hot

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

WorkBuddy

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

创客贴AI

创客贴AI是一款AI图像与设计工具,AI辅助的智能在线设计工具。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

相关专题

更多
pip安装使用方法
pip安装使用方法

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

3470

2023.10.09

更新pip版本
更新pip版本

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

7903

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、保存并关闭文件即可。

9582

2024.12.23

python升级pip
python升级pip

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

5027

2025.07.23

pycharm怎么改成中文
pycharm怎么改成中文

PyCharm是一种Python IDE(Integrated Development Environment,集成开发环境),带有一整套可以帮助用户在使用Python语言开发时提高其效率的工具,比如调试、语法高亮、项目管理、代码跳转、智能提示、自动完成、单元测试、版本控制。此外,该IDE提供了一些高级功能,以用于支持Django框架下的专业Web开发。php中文网给大家带来了pycharm相关的教程以及文章,欢迎大家前来学习和阅读。

3369

2023.07.25

pycharm安装教程
pycharm安装教程

PyCharm是一款由JetBrains开发的Python集成开发环境(IDE),它提供了许多方便的功能和工具。本专题为大家带来pycharm安装教程,帮助大家解决问题。

6417

2023.08.21

如何解决pycharm找不到模块
如何解决pycharm找不到模块

解决pycharm找不到模块的方法:1、检查python解释器;2、安装缺失的模块;3、检查项目结构;4、检查系统路径;5、使用虚拟环境;6、重启PyCharm或电脑。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

738

2023.12.04

如何安装pycharm
如何安装pycharm

安装pycharm的步骤:1、访问PyCharm官方网站下载最新版本的PyCharm;2、下载完成后,打开安装文件;3、安装完成后,打开PyCharm;4、在PyCharm的主界面中等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

974

2024.02.23

Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

0

2026.11.06

热门下载

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

精品课程

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

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