0

0

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

聖光之護

聖光之護

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

|

265人浏览过

|

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

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

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

薏米AI
薏米AI

YMI.AI-快捷、高效的人工智能创作平台

下载
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 正确识别、安装与导入。

相关专题

更多
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号