0

0

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

碧海醫心

碧海醫心

发布时间:2025-12-27 12:13:18

|

707人浏览过

|

来源于php中文网

原创

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

本文详解如何通过 `pip install -e .` 正确安装本地 python 项目,并确保所有嵌套子包(如 `mypkg.subpkg1`)被自动识别和导入,核心在于正确设置 `package_dir` 与 `find_packages()` 的协同关系。

在采用“ad-hoc 布局”(即源码位于子目录如 mypkg/ 而非项目根目录)的本地 Python 项目中,执行 pip install -e . 时若遇到 error: package directory 'subpkg1' does not exist,通常并非路径真实缺失,而是 setuptools 未能正确定位包根目录——它默认在当前目录(.)下搜索 __init__.py,而你的实际包结构位于 mypkg/ 下。

根本原因在于:find_packages(where='mypkg') 告诉 setuptools 去哪里找包,但它仍默认认为包的导入名前缀(import namespace)与该目录名一致;而你的目标是让 import mypkg 成立,即顶层包名为 mypkg,但 mypkg/ 本身是子目录。此时必须显式声明 “空字符串命名空间对应 mypkg/ 目录”,即通过 package_dir={"": "mypkg"} 建立映射。

✅ 正确的 setup.py 应如下所示:

from setuptools import setup, find_packages

setup(
    name="Code",
    author="Me",
    author_email="Me",
    description="Code",
    package_dir={"": "mypkg"},  # ← 关键!声明:顶级包("")位于 ./mypkg/
    packages=find_packages(where="mypkg"),  # ← 在 mypkg/ 内递归发现所有含 __init__.py 的子目录
    python_requires=">=3.6",
)

? 注意事项:

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

星火作家大神
星火作家大神

星火作家大神是一款面向作家的AI写作工具

下载
  • package_dir={"": "mypkg"} 是必需的,否则 setuptools 会尝试在项目根目录下查找 mypkg.__init__.py(实际路径为 ./mypkg/__init__.py),导致子包路径解析失败;
  • find_packages(where="mypkg") 配合 package_dir 才能正确识别 mypkg/subpkg1/、mypkg/subpkg2/ 等为有效子包;
  • 确保每个希望被导入的子目录(如 subpkg1/)均包含 __init__.py(可为空),否则 find_packages() 会跳过它;
  • 安装后验证:启动 Python,执行 import mypkg; mypkg.subpkg1.module1 应正常工作;
  • IDE(如 VS Code、PyCharm)可能因缓存延迟不显示 tab 补全,但运行时导入无误;可重启语言服务器或清除 .vscode/ 缓存提升体验。

? 进阶建议:推荐迁移到 pyproject.toml(PEP 621)风格,更简洁且现代:

# 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.options.packages]
find = {where = ["mypkg"], include = ["*"]}

此时无需 setup.py,pip install -e . 同样生效,且 package_dir 映射由 find = {where = ["mypkg"]} 隐式支持(setuptools 自动处理)。

总结:package_dir={"": "mypkg"} 是 ad-hoc 布局下可编辑安装的“钥匙”,它桥接了物理路径与 Python 导入命名空间。配合适当的 find_packages() 调用,即可实现单命令安装 + 全子包可用的开发体验。

相关专题

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