如何使用标准setuptools将Python代码打包成标准whl发行文件?

轻晨酱_8356

轻晨酱_8356

2026-11-21

266人浏览

原创

setup.py最小不可缺字段是name、version、packages;name须合法,version须符合PEP 440,packages推荐用find_packages();其他如install_requires、python_requires为强建议项。

如何使用标准setuptools将python代码打包成标准whl发行文件?

能,但必须用 python -m build 或 python setup.py bdist_wheel,且前提是项目结构和依赖已就绪;直接运行 setup.py 不等于打包成功,它只是入口脚本。

setup.py 文件必须包含哪些最小字段?

缺一不可的只有 name、version、packages。其他如 install_requires、python_requires 是强烈建议项,不是可选装饰:

  • name 必须是合法的 Python 包名(仅含字母、数字、下划线,不能以数字开头)
  • version 应遵循 PEP 440(如 "0.1.0",不能写 "v0.1" 或 "0.1-rc")
  • packages=find_packages() 是最安全的选择;手动写 packages=["mylib"] 容易漏子包或引入空目录
  • 如果项目含非 .py 文件(如 JSON、模板),需额外加 MANIFEST.in 并确保 include_package_data=True

为什么推荐用 python -m build 而非 python setup.py bdist_wheel?

python -m build 是当前官方推荐方式(PEP 517/518),它绕过 setup.py 的执行逻辑,只读取声明式配置,更稳定、更隔离:

使用 Claude Agent SDK 将绑定的 Claude 代码会话嵌入到 Python 自动化中
使用 Claude Agent SDK 将绑定的 Claude 代码会话嵌入到 Python 自动化中

当现有的脚本或服务需要将作用域化的仓库工作委托给 Claude Code 并以编程方式消费结构化响应时,请使用 Claude Agent SDK for Python。

下载
  • 不依赖 setup.py 是否可 import —— 某些 setup.py 会动态 import 项目代码,导致构建时触发运行时错误
  • 自动启用 pyproject.toml 中定义的 build-backend(即使你只写了 setup.py,build 也会 fallback 到 setuptools)
  • 不会污染当前 Python 环境(setup.py 运行时可能修改 sys.path 或加载本地模块)
  • 命令统一:python -m build --wheel 生成 .whl,--sdist 生成 .tar.gz

常见失败现象和对应检查点

运行后没生成 dist/*.whl,或报错信息模糊,多数卡在这几个地方:

  • 报错 ModuleNotFoundError: No module named 'setuptools':说明当前环境没装 setuptools 或版本太老,运行 pip install -U setuptools wheel
  • 报错 error in mypkg setup command: 'install_requires' must be a string or list of strings:检查 install_requires 值是否为列表,不能是元组或带换行的字符串
  • 生成的 .whl 安装后找不到模块:确认 find_packages() 找到的是源码目录(比如 src/mylib/ 需配 find_packages(where="src") 和 package_dir={"": "src"})
  • 文件名里出现 py3-none-any.whl 但你想支持 C 扩展:这是纯 Python 包标识;含 C 代码必须用 setuptools + 编译器,并在 setup.py 中显式定义 Extension

真正容易被忽略的是:.whl 文件名中的 python tag(如 py39)由构建时 Python 解释器决定,不是 python_requires 控制的;想发多版本包,得在对应 Python 版本环境下分别构建。

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

相关文章

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

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

下载

相关标签:

python

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

相关专题

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

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

2023.07.20

1971

4

python能做什么
python能做什么

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

2023.07.25

5624

7

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

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

2023.07.31

1909

3

python教程
python教程

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

2023.08.03

34537

23

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

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

2023.08.04

4027

5

python eval
python eval

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

2023.08.04

4027

5

scratch和python区别
scratch和python区别

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

2023.08.11

1303

5

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

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

2023.08.10

636

4

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

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

2023.08.11

3143

5

热门下载

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

精品课程

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