0

0

如何正确配置本地 Python 项目以支持可编辑安装及自动发现子包

霞舞

霞舞

发布时间:2025-12-27 13:54:24

|

185人浏览过

|

来源于php中文网

原创

如何正确配置本地 Python 项目以支持可编辑安装及自动发现子包

本文详解如何通过 pip install -e . 正确安装本地 python 项目,并使其自动识别嵌套子包(如 mypkg.subpkg1),关键在于正确设置 package_dir 映射与 find_packages() 的配合使用。

在采用“ad-hoc 布局”(即源码目录不与包名同名,例如顶层为 project_root/,实际包位于 project_root/mypkg/)的本地 Python 项目中,直接使用 pip install -e . 往往无法正确导入子模块——即使所有 __init__.py 文件齐全、路径结构合规。典型症状包括:find_packages() 报错 package directory 'subpkg1' does not exist,或虽安装成功但 import mypkg.subpkg1 失败。

根本原因在于:find_packages() 默认在当前目录(.)下搜索带 __init__.py 的包,而你的包实际位于 mypkg/ 子目录中。若未显式声明源码根目录映射,setuptools 会错误地将 mypkg/subpkg1 解析为相对于项目根的 ./subpkg1,从而导致路径查找失败。

✅ 正确解法是:同时配置 package_dir 和 find_packages(),明确告知 setuptools “包逻辑名称” 与 “物理路径” 的对应关系:

# setup.py
from setuptools import setup, find_packages

setup(
    name="Code",
    author="Me",
    author_email="Me",
    description="Code",
    package_dir={"": "mypkg"},  # ✅ 关键:空字符串 "" 表示根包名(即 mypkg),映射到 ./mypkg/
    packages=find_packages(where="mypkg"),  # ✅ 在 mypkg/ 下递归发现所有子包
    python_requires=">=3.6",
)
? package_dir={"": "mypkg"} 的含义是:所有未显式命名的包(即顶层包 mypkg 及其全部子包)均从 mypkg/ 目录下加载。这使 find_packages(where="mypkg") 能正确遍历 mypkg/subpkg1/、mypkg/subpkg2/ 等真实路径。

安装后验证:

Looka
Looka

AI辅助Logo和品牌设计工具

下载

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

pip install -e .
python -c "from mypkg.subpkg1 import module1; print('Success!')"

⚠️ 注意事项:

  • 不要混用 setup.py 和 pyproject.toml 中的构建配置:若已存在 pyproject.toml(尤其含 [build-system]),优先推荐迁移到现代声明式配置(见下方替代方案);
  • IDE 自动补全可能滞后:如 VS Code 或 PyCharm 未立即识别新包结构,重启语言服务器或重新加载工作区即可解决(非代码问题,属环境缓存);
  • __init__.py 缺失 = 非包目录:确保每个希望被导入的子目录(如 subpkg1/)均含 __init__.py(可为空),否则 find_packages() 会跳过它;
  • 现代推荐(Python 3.8+):可改用 pyproject.toml 实现等效配置,更简洁且符合 PEP 517/518 标准:
# pyproject.toml
[build-system]
requires = ["setuptools>=45", "wheel", "setuptools_scm[toml]>=6.2"]
build-backend = "setuptools.build_meta"

[project]
name = "Code"
authors = [{name = "Me", email = "Me"}]
description = "Code"
requires-python = ">=3.6"

[project.urls]
Homepage = "https://example.com"

[tool.setuptools]
package-dir = {"" = "mypkg"}           # 等效于 setup.py 中的 package_dir
packages = {find = {where = ["mypkg"]}} # 等效于 find_packages(where="mypkg")

至此,执行 pip install -e . 即可完成可编辑安装,所有 mypkg.* 子模块均可直接导入与使用,真正实现“一次配置,全树可见”。

相关专题

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