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/ 等真实路径。

安装后验证:

摄图AI
摄图AI

摄图网旗下AI视觉创作平台

下载

立即学习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.* 子模块均可直接导入与使用,真正实现“一次配置,全树可见”。

热门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包管理工具、手动安装最新版本。想了解更多相关的内容,请阅读专题下面的文章。

432

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

797

2024.12.23

python升级pip
python升级pip

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

370

2025.07.23

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

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

229

2023.07.25

pycharm安装教程
pycharm安装教程

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

213

2023.08.21

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

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

666

2023.12.04

如何安装pycharm
如何安装pycharm

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

154

2024.02.23

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号