如何使用Hatch现代打包工具构建并分发Python开源库

陌萱君_2739

陌萱君_2739

2026-10-09

131人浏览

原创

hatch build 和 hatch publish 是构建与发布 python 包的核心命令,但需严格满足 pep 517/518 规范:pyproject.toml 必须正确定义 hatchling 构建后端、采用 src/ 目录结构、正确配置项目名称,并通过 hatch publish --repository pypi 显式推送至正式 pypi。

如何使用hatch现代打包工具构建并分发python开源库

hatch build 和 hatch publish 是构建和分发 Python 开源库最直接的两个命令,但前提是项目结构、配置和环境都符合 PEP 517/518 规范。盲目运行只会报错或上传失败。

pyproject.toml 必须声明 hatchling 构建后端

很多失败源于 pyproject.toml 缺少或写错构建系统配置。Hatch 本身不负责构建,它调用的是后端(如 hatchling)。必须确保文件里有且仅有:

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

常见错误包括:

  • 误写成 build-backend = "hatch.build"(hatch 没有 build 后端)
  • 漏掉 requires,导致构建时找不到 hatchling
  • 同时存在 setuptools 和 hatchling 配置,造成冲突

src/ 目录结构是默认前提,别硬套传统 flat 结构

Hatch(配合 hatchling)默认期望包代码放在 src/<package_name>/</package_name> 下。如果你把 __init__.py 直接放在项目根目录,hatch build 会成功,但生成的 .whl 里不含模块,安装后 import 报错。

正确做法:

testing-python
testing-python

使用pytest编写和评估有效的Python测试。适用于编写测试、审查测试代码、调试测试失败或提高测试覆盖率。

下载
  • 创建 src/example_pkg/ 目录
  • 把所有包内文件(__init__.py、main.py 等)放进去
  • pyproject.toml 中无需额外声明 source-dir —— hatchling 默认识别 src/
  • 若坚持用根目录结构,需在 [tool.hatch.build.targets.wheel] 下显式配置 source-dir = ".",但不推荐

hatch publish 默认推送到 TestPyPI,不是 PyPI

执行 hatch publish 时,它不会直接上传到生产 PyPI。默认行为是推送到 TestPyPI,这是安全机制,但容易被忽略。

验证方式:

  • 首次运行会提示 “Uploading to https://www.php.cn/link/79304cca1ad8a247a9bafffd5f4db436/legacy/”
  • 上传后去 https://www.php.cn/link/79304cca1ad8a247a9bafffd5f4db436/project/your-package-name/ 查看
  • 要发布到正式 PyPI,必须显式加 --repository pypi 参数:hatch publish --repository pypi
  • 提前在 ~/.pypirc 或使用 hatch config set pypi.token <token></token> 配置凭据,否则会卡在认证

dist/ 下产物不等于可用包,得验证安装路径

hatch build 成功后,dist/ 下会出现 .whl 和 .tar.gz,但这只是构建结果。真正决定能否被用户 pip install 的,是 wheel 内部的 RECORD 和模块路径。

快速验证方法:

  • 解压 .whl 文件(它是 zip 格式),检查顶层是否为 example_pkg- 目录,内部是否含 example_pkg/ 子目录及 __init__.py
  • 用 pip install --find-links dist/ --no-index example_pkg 在干净虚拟环境中本地安装测试
  • 如果 import example_pkg 失败,大概率是 src/ 结构没对齐,或 [project] 表中 name 和目录名不一致
真正卡住人的地方,往往不是命令记不住,而是 pyproject.toml 里一个空格、src/ 少一层、或者以为 hatch publish 默认上生产站 —— 这些细节不验证,打包就只是生成了两个文件,而不是一个可交付的开源库。

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

相关文章

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

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

下载

相关标签:

python

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

相关专题

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

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

2023.07.20

1671

4

python能做什么
python能做什么

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

2023.07.25

4204

7

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

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

2023.07.31

1669

3

python教程
python教程

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

2023.08.03

24437

23

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

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

2023.08.04

2987

5

python eval
python eval

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

2023.08.04

3007

5

scratch和python区别
scratch和python区别

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

2023.08.11

1163

5

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

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

2023.08.10

596

4

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

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

2023.08.11

2323

5

热门下载

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

精品课程

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