如何在Python包发布前正确编写pyproject.toml元数据

小强同学_7760

小强同学_7760

2026-09-21

518人浏览

原创

pypi上传必需字段为name、version、description、readme;name须小写且仅含字母数字和短横线,version须符合pep 440,description不能为空,readme须指定路径如"readme.md"。

如何在python包发布前正确编写pyproject.toml元数据

pyproject.toml 里哪些字段是 PyPI 上传必需的

不填 nameversiondescriptionauthors 这四个字段,twine upload 会成功,但 PyPI 页面会显示不全甚至拒绝索引——尤其是 nameversion 缺一不可,否则 build 阶段就报错:Invalid sdist: filename does not match PEP 508 name

实操建议:

  • name 必须小写、用短横线(-)分隔,不能含下划线或大写字母;PyPI 不接受 my_packageMyPackage,只认 my-package
  • version 推荐用 dynamic = true + setuptools-scm 自动推导,避免手动改多个地方;若静态写死,必须符合 PEP 440(如 "0.1.0",不能写 "v0.1.0""0.1"
  • authors 是数组,每个元素是 {name = "...", email = "..."};只写字符串(如 authors = "Alice")会被 setuptools 忽略
  • readme 字段要明确指定路径和格式,例如 readme = "README.md",否则 build 会警告并降级为纯文本

classifier 怎么选才不影响用户安装

错误填写 classifiers 不会阻止上传,但会导致包在 PyPI 搜索中不可见、被误判为“仅限 Python 2”或“开发版”,甚至触发依赖解析器跳过该版本。

常见问题:

  • 漏掉 "Programming Language :: Python :: 3" → PyPI 认为这是 Python 2 包,现代 pip 默认不安装
  • 写了 "Development Status :: 3 - Alpha" 却没加 requires-python = ">=3.8" → 用户用 Python 3.7 安装时不会报错,但运行时报 ModuleNotFoundError
  • "License :: OSI Approved :: MIT License" 写成 "MIT License" → PyPI 不识别,许可证栏显示为空

实操建议:用 PyPI 官方分类器列表 复制粘贴,不要手敲;核心必选包括:Programming Language :: Python :: 3、对应的具体版本(如 :: 3.9)、License :: OSI Approved :: ...Operating System :: OS Independent(除非你真依赖 Windows API)。

Shadows Python Sensei
Shadows Python Sensei

Python 最佳实践助手——代码规范、设计模式、性能优化、测试与类型注解。适用于编写或审查 Python 代码。

下载

动态 version 和静态 version 哪种更适合 CI 发布

CI 环境下用静态 version = "0.2.0" 最简单,但极易出错:git tag、pyproject.toml、CHANGELOG 三处不同步,就会导致发布版本号混乱或重复。

推荐用动态方案,但要注意工具链兼容性:

  • setuptools-scm 是目前最稳的选择,只要 git repo 有 tag(如 v0.2.0),它就能自动算出 0.2.00.2.0.dev1+gabc123;需在 [build-system] 中声明 requires = ["setuptools>=45", "wheel", "setuptools-scm[toml]>=6.2"]
  • 别用 __version__ 文件 + dynamic.version.file:某些构建后端(如 build CLI)可能读不到,且 CI 中容易因缓存导致版本号滞后
  • CI 脚本里执行 python -m build 前,确保 git fetch --tags 已运行,否则 setuptools-scm 算不出正确版本

为什么 build 后的 sdist 里没有 LICENSE 文件

不是 pyproject.toml 没配对,而是默认打包逻辑只包含 py 文件和 readme,其他文件(LICENSEpy.typedexamples/)必须显式声明。

解决方式只有两个有效路径:

  • [project.files](PEP 621,新标准):写 files = [{include = "LICENSE"}],但注意目前 pip install 从 sdist 安装时仍可能忽略它
  • 更可靠的是用 [tool.setuptools.manifest] + MANIFEST.in:在项目根目录建 MANIFEST.in,写 include LICENSE;同时确保 [build-system]requires 包含 setuptools(而非仅 setuptools-core
  • 验证方法:运行 python -m build --sdist 后解压生成的 .tar.gz,检查顶层是否含 LICENSE;缺了就说明 manifest 没生效

最容易被忽略的是:即使 pyproject.toml 里写了 license = {text = "MIT"},也不会自动把 LICENSE 文件打进包——这个字段只用于 PyPI 页面展示,和实际分发无关。

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

相关文章

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

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

下载

相关标签:

python python包

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

相关专题

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

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

2023.07.20

1551

4

python能做什么
python能做什么

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

2023.07.25

3624

7

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

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

2023.07.31

1549

3

python教程
python教程

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

2023.08.03

20657

23

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

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

2023.08.04

2567

5

python eval
python eval

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

2023.08.04

2627

5

scratch和python区别
scratch和python区别

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

2023.08.11

1063

5

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

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

2023.08.10

576

4

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

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

2023.08.11

2023

5

热门下载

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

精品课程

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