使用PDM管理Python项目时如何配置本地包构建规则

老磊君_2032

老磊君_2032

2026-09-28

737人浏览

原创

pdm 不执行 setuptools.find_packages(),而是通过 pyproject.toml 中 tool.pdm.build.packages 显式声明包路径(如 {include = "mylib", from = "src"})来确定打包内容,未正确配置会导致构建空包、import 失败及 ide 识别异常。

使用pdm管理python项目时如何配置本地包构建规则

pdm 默认不读取 setup.py 或旧式 pyproject.toml 中的 [tool.setuptools] 配置,它使用自己的构建后端(pdm-backend),所以直接沿用传统 setuptools 写法会导致本地包构建失败、子包未被发现、可编辑安装后 import 报错。

为什么 find_packages() 在 PDM 里不生效

PDM 的构建逻辑绕过了 setuptools.find_packages() 的运行时调用——它在构建前就通过静态分析 pyproject.toml 中的 packages 字段或约定路径来确定要打包的模块。如果你只写 packages = ["mylib"],但实际源码在 src/mylib/ 下,PDM 就会找不到任何 __init__.py,最终生成空包或报 No module named 'mylib'。

常见错误现象:

  • pdm build 成功但生成的 .whl 里没有 Python 模块文件
  • pdm install -e 后 python -c "import mylib" 报 ModuleNotFoundError
  • IDE(如 PyCharm)识别不到包结构,补全失效

必须显式声明 packages 或启用 include 规则

PDM 不自动递归扫描 src/ 或项目根目录;它依赖明确的包路径声明。两种可靠方式:

  • 用 packages 列表直接写死路径:
    packages = [{include = "mylib", from = "src"}](适用于 src/mylib/ 结构)
  • 用 include + exclude 模式匹配:
    include = ["src/**/*"],再配合 exclude = ["**/__pycache__/**", "**/*.pyc"]
  • 若坚持用传统布局(包名即目录名,无 src/),则写:
    packages = [{include = "mylib"}],且确保 mylib/__init__.py 存在

示例(pyproject.toml 片段):

[project]
name = "mylib"
version = "0.2.0"
# ... 其他元数据
<p>[tool.pdm]</p><h1>启用 pdm-backend(PDM 2.0+ 默认已启用,显式写更清晰)</h1><p>build-backend = "pdm.backend"</p><p>[tool.pdm.build]</p><div class="aritcle_card flexRow artxards">
											<div class="artcardd flexRow">
												<a class="aritcle_card_img" rel="nofollow" href="/xiazai/skill5288" title="提示词大师-python版"><img
														src="https://img.php.cn/upload/skill/000/000/081/179042051830184.jpg" alt="提示词大师-python版" onerror="this.onerror='';this.src='/static/lhimages/moren/morentu.png'" ></a>
												<div class="aritcle_card_info flexColumn">
													<a rel="nofollow" href="/xiazai/skill5288" title="提示词大师-python版" class="overflowclass">提示词大师-python版</a>
													<p class="overflowclass">图片提示词生成器?不止如此。
马甲系统 —— 把脑海中的画面,翻译成AI能理解的专业表达。
用得越多,它越懂你:首次需要多问几句确认方向,用久了几乎一说就懂。
用得越多,它越快:缓存机制让后续对话越来越省。
RAG进化:成功案例持续入库,越跑越聪明。
输入「新手指南」查看完整功能介绍</p>
												</div>
												<a rel="nofollow" href="/xiazai/skill5288" title="提示词大师-python版" class="aritcle_card_btn flexRow flexcenter"><b></b><span>下载</span>
												</a>
											</div>
										</div><h1>✅ 正确:告诉 PDM 包物理位置</h1><p>packages = [{include = "mylib", from = "src"}]</p><h1>可选:额外包含非 Python 文件(如数据、schema)</h1><p>include = ["src/mylib/data/<strong>", "src/mylib/schemas/</strong>"]</p>

package-dir 映射在 PDM 中无效,别白费劲

你在 setup.py 里习惯写的 package_dir={"": "src"} 或 package_dir={"mylib": "src/mylib"},对 PDM 完全不起作用。PDM 不解析 setup.py,也不支持该字段映射。试图保留 setup.py 并指望它影响 PDM 构建,只会让你陷入“明明写了却没用”的困惑。

真正起作用的是:

  • [tool.pdm.build].packages —— 控制哪些目录被打进 wheel
  • [tool.pdm.build].includes —— 补充非模块文件
  • [tool.pdm.build].editable-verbose(布尔值)—— 开启后 pdm install -e 会打印详细符号链接路径,方便调试

如果你的项目用了 src/ 布局但没配 from = "src",PDM 就默认从项目根找 mylib/,自然失败。

验证本地构建是否真生效

别只信 pdm build 不报错。检查生成物和运行时行为:

  • 解压 dist/*.whl,确认 mylib/ 目录及其下所有 __init__.py 都在 mylib/ 路径下(不是顶层或嵌套错层)
  • 运行 pdm run python -c "import mylib; print(mylib.__file__)",看路径是否指向 __pypackages__/ 下的符号链接或已安装的 egg-link
  • 对子包(如 mylib.utils)执行导入测试,不能只测顶层包

最容易被忽略的一点:PDM 的可编辑安装(-e)依赖 pyproject.toml 中 [project].name 和实际包目录名严格一致。如果 name = "mylib",但你的源码目录叫 mypkg,哪怕配了 from = "src",也会因命名不匹配导致导入失败——PDM 不做重映射,只做路径搬运。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

python

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1591

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

3824

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1609

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

22097

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

2707

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

2767

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1103

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

596

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2143

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程