讲师中心 微信公众号
AI工具推荐 视频效率加速

Python如何解决setup.py执行时的编码错误_指定encoding参数

落瑶酱_7271

落瑶酱_7271

发布时间:2026-04-12 11:09:17

|

926人浏览过

|

来源于php中文网

原创

setup.py读取含中文文件时因未指定encoding参数导致UnicodeDecodeError,根本原因是Python默认编码与文件实际编码(如GBK)不匹配;应显式指定encoding='utf-8-sig'或'gbk',优先将文件转为UTF-8保存。

python如何解决setup.py执行时的编码错误_指定encoding参数

setup.py读取文件时抛出UnicodeDecodeError

Python 2默认用ASCII解码,Python 3默认用UTF-8,但Windows系统上很多setup.py会读取README.md或__init__.py等含中文的文件,而这些文件实际是GBK编码——此时open()不指定encoding就会崩在read()那行,报错类似:UnicodeDecodeError: 'utf-8' codec can't decode byte 0xc4 in position 10。

根本原因不是setup.py本身有问题,而是它调用open()读取项目元数据时没传encoding参数,让Python按平台默认编码去猜,一猜就错。

  • 检查出问题的文件真实编码:用VS Code或Notepad++打开README.md,右下角看是UTF-8、GBK还是UTF-8 with BOM
  • 在setup.py里所有open()调用处显式加encoding参数,别依赖默认值
  • 不要写open('README.md', 'r', encoding='utf-8')硬编码UTF-8——如果文件是GBK,这行照样报错;优先用encoding='utf-8-sig'兼容BOM,或根据文件实际编码选'gbk'

setup()中long_description字段的编码处理

setup()函数的long_description参数通常来自readme文件内容,这是最常翻车的地方。错误写法:long_description=open('README.md').read()——完全没指定编码,跨平台必挂。

正确做法是统一用io.open()(兼容Py2/Py3)或Python 3.7+原生open(),并强制指定encoding:

立即学习“Python免费学习笔记(深入)”;

import io
with io.open('README.md', encoding='utf-8') as f:
    long_description = f.read()

如果你确认README.md是Windows记事本保存的(即GBK),就得写encoding='gbk';若不确定,可先用chardet探测:

import chardet
with open('README.md', 'rb') as f:
    raw = f.read()
    encoding = chardet.detect(raw)['encoding'] or 'utf-8'
with open('README.md', encoding=encoding) as f:
    long_description = f.read()

使用setuptools.find_packages()时的中文路径问题

当包目录名或__init__.py路径含中文(比如src/工具模块/),find_packages()本身不报错,但后续构建wheel或sdist时,MANIFEST.in或setup.cfg若未声明编码,打包工具可能在读取文件列表时出错。

python-code-analyz
python-code-analyz

专业Python代码分析与优化,支持语法检查、安全扫描、性能评估、复杂度分析及重构后优化代码生成。

下载

这不是find_packages()的锅,而是setup.py里其他open()调用没处理好。重点检查:

  • MANIFEST.in是否被open()读取?如有,必须加encoding
  • 自定义build_py或sdist命令类时,所有open()都要带encoding
  • 避免在setup.py里拼接中文路径字符串再传给os.listdir()或glob.glob()——它们返回的bytes或str类型在不同Python版本行为不一致

pyproject.toml替代setup.py后还用管encoding吗

用pyproject.toml后,setup.py可以删掉,但long_description仍可能从文件读取——比如用setuptools-scm或自定义dynamic字段。这时读取逻辑仍在Python代码里,encoding问题照旧存在。

例如,在pyproject.toml中这样写是危险的:

[project]
readme = "README.md"

因为底层仍会调用open()读取该文件。最新版setuptools(≥61.0)已默认用utf-8读取readme,但如果你的README.md是GBK,就得在pyproject.toml里显式声明:

[project]
readme = {file = "README.md", content-type = "text/markdown; charset=gbk"}

不过这个charset字段支持度有限,更稳妥的方式仍是把README.md转成UTF-8保存——编辑器里“另存为”,编码选UTF-8,BOM勾不勾都行(utf-8-sig能自动跳过BOM)。

真正容易被忽略的是:即使迁移到pyproject.toml,只要代码里还有open()读文件,encoding就得自己管。没人替你兜底。

热门AI工具

更多
立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

相关专题

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

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

1671

2023.07.20

python能做什么
python能做什么

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

4164

2023.07.25

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

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

1669

2023.07.31

python教程
python教程

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

24177

2023.08.03

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

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

2967

2023.08.04

python eval
python eval

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

2987

2023.08.04

scratch和python区别
scratch和python区别

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

1163

2023.08.11

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

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

596

2023.08.10

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

100

2026.09.30

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn