0

0

如何正确使用 pip 安装本地 Python 项目并自动发现子包

聖光之護

聖光之護

发布时间:2025-12-27 13:21:03

|

285人浏览过

|

来源于php中文网

原创

如何正确使用 pip 安装本地 Python 项目并自动发现子包

本文详解如何通过 pip install -e . 正确安装采用“ad-hoc 布局”的本地 python 项目,解决 find_packages(where='mypkg') 报错及子包无法导入的问题,并说明 package_dir 的关键作用。

在开发多层嵌套的本地 Python 项目时,常见的目录结构是将实际包代码置于子目录(如 mypkg/)下,而非直接放在项目根目录——这种布局被称为 ad-hoc layout(非标准布局)。此时若仅依赖 find_packages() 而不显式声明源码映射关系,pip install -e . 很可能失败或导致包内容为空。

你遇到的错误:

error: package directory 'subpkg1' does not exist

根本原因在于:find_packages(where='mypkg') 告诉 setuptools 去 mypkg/ 目录里找包,但 setuptools 仍默认从当前目录(即 project_root_directory)解析包路径。当它尝试验证 subpkg1 是否为合法包时,会按相对路径 subpkg1/ 查找(即根目录下的 subpkg1/),而非 mypkg/subpkg1/,因此报错——尽管该子包真实存在于 mypkg/ 内。

✅ 正确解法是同时指定两件事:

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

小艺
小艺

华为公司推出的AI智能助手

下载
  • 源码位置(where):告诉 find_packages() 到哪里扫描;
  • 包名到路径的映射(package_dir):告诉 setuptools “空字符串包名(即顶级包)” 对应的实际目录是 mypkg。

因此,你的 setup.py 应修正为:

from setuptools import setup, find_packages

setup(
    name="Code",
    author="Me",
    author_email="Me",
    description="Code",
    packages=find_packages(where="mypkg"),  # ✅ 扫描 mypkg/ 下的所有包
    package_dir={"": "mypkg"},               # ✅ 关键!将 "" → "mypkg" 映射
    python_requires=">=3.6",
)
? 补充说明:package_dir={"": "mypkg"} 表示“所有未显式声明前缀的包(即顶层包 mypkg)均来自 mypkg/ 目录”。这使 find_packages(where="mypkg") 扫描到的 subpkg1、subpkg2 等能被正确定位为 mypkg.subpkg1、mypkg.subpkg2。

完成修改后,执行:

pip install -e .

即可成功以可编辑模式安装整个包结构。之后可在 Python 中正常导入:

from mypkg.subpkg1 import module1
from mypkg.subpkg2.module2 import some_function
import mypkg

⚠️ 注意事项:

  • 若使用 pyproject.toml(推荐现代方式),请改用 setuptools 配置块替代 setup.py,但 package-dir 和 find-package 逻辑保持一致;
  • __init__.py 缺失的子目录不会被 find_packages() 发现,这是预期行为(符合 Python 包定义规范);
  • IDE(如 VS Code、PyCharm)可能因缓存延迟导致 tab 补全失效,重启 Python 解释器或刷新索引即可解决,不影响实际运行时导入。

总结:find_packages(where=...) 只负责“发现”,而 package_dir 才真正决定“如何解析路径”。二者必须协同配置,才能让 ad-hoc 布局的本地项目被 pip 正确识别、安装与导入。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

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

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

373

2023.10.09

更新pip版本
更新pip版本

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

433

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

798

2024.12.23

python升级pip
python升级pip

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

370

2025.07.23

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

718

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

219

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

1561

2023.10.24

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

649

2023.11.24

JavaScript浏览器渲染机制与前端性能优化实践
JavaScript浏览器渲染机制与前端性能优化实践

本专题围绕 JavaScript 在浏览器中的执行与渲染机制展开,系统讲解 DOM 构建、CSSOM 解析、重排与重绘原理,以及关键渲染路径优化方法。内容涵盖事件循环机制、异步任务调度、资源加载优化、代码拆分与懒加载等性能优化策略。通过真实前端项目案例,帮助开发者理解浏览器底层工作原理,并掌握提升网页加载速度与交互体验的实用技巧。

1

2026.03.06

热门下载

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

精品课程

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

共4课时 | 22.5万人学习

Django 教程
Django 教程

共28课时 | 4.8万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.8万人学习

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

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