如何解决Python项目构建时由于编码问题导致的wheel打包失败

风敏小哥_7683

风敏小哥_7683

2026-10-04

526人浏览

原创

python打包时编码错误主因是setup.py或pyproject.toml含非utf-8字符、readme.md带bom、toml字符串未引号、locale非utf-8;应统一转utf-8、去bom、显式指定encoding、字符串加双引号、设置正确locale。

如何解决python项目构建时由于编码问题导致的wheel打包失败

setup.py 或 pyproject.toml 文件本身含非UTF-8字符

Python 3.7+ 默认要求源码文件为 UTF-8 编码,但 Windows 记事本、某些 IDE 或 Git 钩子可能悄悄存成 GBK/ISO-8859-1。一旦 setup.py 里有中文注释、作者名、描述字段用了非 UTF-8 字节,python -m build 或 python setup.py bdist_wheel 就会在解析阶段直接报错,比如:

SyntaxError: Non-UTF-8 code starting with '\xd6' in file setup.py

这不是依赖或环境问题,而是 Python 解释器读取脚本时就卡住了。

  • 用 file setup.py(Linux/macOS)或 chcp + more setup.py(Windows)确认实际编码
  • 用 VS Code / PyCharm 打开后右下角看编码标识,点击切换并「Save with Encoding → UTF-8」
  • 避免在 setup.py 的 setup() 调用中硬写带中文的 description 或 long_description;改用 open("README.md", encoding="utf-8").read()

README.md 或其他被读取的文本文件含 BOM 或混合编码

很多项目在 setup.py 或 pyproject.toml 中通过 open("README.md") 读取内容填充 long_description。如果该文件是 Windows Notepad 保存的 UTF-8 with BOM,Python 3 默认 open() 会把 BOM 当作普通字符读入,导致生成的 METADATA 文件头部出现非法字节,后续 pip install 可能静默失败或报 InvalidDistribution。

  • 检查 README.md 是否含 BOM:head -c 3 README.md | xxd —— 输出 00000000: efbb bf 即为 BOM
  • 去除 BOM:用 sed -i '1s/^\xEF\xBB\xBF//' README.md(Linux/macOS),或用 VS Code 保存为「UTF-8」而非「UTF-8 with BOM」
  • 在 setup.py 中显式声明编码:open("README.md", encoding="utf-8"),不要省略 encoding 参数

pyproject.toml 中字符串值未加引号导致解析失败

TOML 规范要求含空格、中文、特殊符号的字符串必须用双引号包裹。若你在 [project] 下写了:

Li Python Sec Check
Li Python Sec Check

Python 安全规范检查工具:基于 CloudBase 规范、腾讯安全指南,LLM 智能分析(默认禁用,优先本地执行)

下载
authors = [{name = 张三, email = "zhang@example.com"}]

这里 张三 没加引号,tomllib(Python 3.11+ 内置)或 tomli 会直接拒绝解析,报错类似:

tomllib.TOMLDecodeError: Invalid character '张'

注意:这个错误发生在构建前期(读取配置阶段),甚至不会走到编译或打包逻辑。

  • 所有含中文、空格、连字符、点号的字符串值都必须加双引号,例如:name = "张三"
  • 用 tomli CLI 验证:python -m tomli dump pyproject.toml,出错即说明格式不合法
  • 避免在 [project.urls] 或 [project.optional-dependencies] 的键名里使用中文——TOML 键名不支持 Unicode 转义以外的非 ASCII 字符

构建环境 locale 设置影响 open() 默认编码

在某些 Linux 容器或 CI 环境(如 Ubuntu base 镜像),LANG 可能是 C 或 POSIX,导致 open() 默认使用 locale.getpreferredencoding()(即 ASCII),而非 UTF-8。这时即使文件是 UTF-8,读取也会失败。

  • 检查当前 locale:locale,确认 LANG 和 LC_ALL 是类似 en_US.UTF-8 的值
  • 在 CI 脚本中显式设置:export LANG=en_US.UTF-8 LC_ALL=en_US.UTF-8
  • 更稳妥的做法:所有 open() 调用都强制指定 encoding="utf-8",不依赖系统默认
真正的麻烦在于,这类错误往往不报“encoding”字样,只抛 SyntaxError、TOMLDecodeError 或模糊的 subprocess-exited-with-error。你得先盯住最上游的输入文件(setup.py、pyproject.toml、README),而不是急着升级 pip 或重装编译器。

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

相关专题

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

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

2023.07.20

1651

4

python能做什么
python能做什么

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

2023.07.25

4064

7

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

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

2023.07.31

1649

3

python教程
python教程

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

2023.08.03

23457

23

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

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

2023.08.04

2887

5

python eval
python eval

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

2023.08.04

2907

5

scratch和python区别
scratch和python区别

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

2023.08.11

1143

5

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

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

2023.08.10

596

4

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

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

2023.08.11

2263

5

热门下载

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

精品课程

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