讲师中心 微信公众号
AI工具推荐 视频效率加速

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

陌丽君_4375

陌丽君_4375

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

|

747人浏览过

|

来源于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 查询技能
python 查询技能

查询客流数据,输出JSON格式,可直接导入Bitable等可视化工具

下载

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

  • 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() 调用,即可实现单命令安装 + 全子包可用的开发体验。

热门AI工具

更多
DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

相关专题

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

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

2810

2023.10.09

更新pip版本
更新pip版本

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

6443

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

8042

2024.12.23

python升级pip
python升级pip

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

4007

2025.07.23

scripterror怎么解决
scripterror怎么解决

scripterror的解决办法有检查语法、文件路径、检查网络连接、浏览器兼容性、使用try-catch语句、使用开发者工具进行调试、更新浏览器和JavaScript库或寻求专业帮助等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

949

2023.10.18

500error怎么解决
500error怎么解决

500error的解决办法有检查服务器日志、检查代码、检查服务器配置、更新软件版本、重新启动服务、调试代码和寻求帮助等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2720

2023.10.25

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

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

1658

2023.08.03

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

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

2504

2023.09.04

Kratos框架HTTP与gRPC服务开发教程
Kratos框架HTTP与gRPC服务开发教程

本专题围绕Kratos框架双协议服务开发,涵盖HTTP路由与处理器编写、参数获取、gRPC服务实现与客户端调用、metadata上下文传递、encoding编解码注册、统一响应封装、超时控制与流式响应实现方法。

0

2026.10.10

热门下载

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

精品课程

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn