如何解决Python测试中因编码格式导致的乱码报错_在pytest中强制UTF-8

秋浩小哥_7455

秋浩小哥_7455

2026-05-31

941人浏览

原创

pytest中文乱码本质是编码不一致导致的显示异常,需从源文件utf-8保存与声明、运行环境(如windows设pythonioencoding=utf-8)、插件写入逻辑(如pytest-html的write_text加encoding='utf-8')三处统一解决。

如何解决python测试中因编码格式导致的乱码报错_在pytest中强制utf-8

Pytest 中的中文乱码不是“报错”,而是输出或保存时编码不一致导致的显示异常,pytest 本身不会因中文抛出 SyntaxError 或 UnicodeDecodeError(除非源文件本身保存为非 UTF-8 编码且未声明)。真正要强制 UTF-8,得从三处下手:源文件、运行环境、插件写入逻辑。

确保测试文件以 UTF-8 保存且声明编码

这是最基础但常被跳过的一步。即使你写了中文 ids 或 docstring,如果文件实际是 GBK 编码保存的,Python 解释器读取时就会失败。

  • 用 VS Code / PyCharm 打开测试文件,右下角查看当前编码,点击切换为 UTF-8,并选择「通过编码重新打开」
  • 在文件首行添加 PEP 263 声明:# -*- coding: utf-8 -*-(虽然 Python 3 默认 UTF-8,但显式声明能避免某些编辑器/IDE 误判)
  • 不要依赖记事本保存——它默认用 GBK,极易埋雷

设置运行时环境编码(Windows 尤其关键)

Windows 控制台默认使用 cp936(GBK),pytest 捕获 stdout/stderr 时若未指定编码,就可能把 UTF-8 字节流按 GBK 解码,造成双重乱码(如 单个)。

python-parallelization
python-parallelization

将顺序 Python 代码转换为并行/并发实现,用于在需要并行化 Python 代码、提升性能时使用。

下载
  • 运行前临时设置:set PYTHONIOENCODING=utf-8(Windows CMD)或 $env:PYTHONIOENCODING="utf-8"(PowerShell)
  • 更稳妥的是在 pytest.ini 中加:
    [pytest]
    addopts = --tb=short
    python_files = test_*.py
    # 强制输出编码
    console_output_style = utf-8
    (注意:console_output_style 是 pytest 7.0+ 支持的选项;旧版本可改用 --outputencoding=utf-8,但该参数在 7.0 后已弃用)
  • CI 环境(如 Jenkins)需在构建步骤中显式设置环境变量,不能只靠本地终端

修复 pytest-html 的 write_text 编码硬编码

pytest-html 3.2.0 及之前版本在 Windows 下默认用系统编码(GBK)写文件,self.logfile.write_text(...) 不带 encoding 参数,直接导致 HTML 文件头部是 UTF-8 内容、但文件本身是 GBK 编码,浏览器解析失败。

  • 找到插件路径:python -c "import pytest_html; print(pytest_html.__file__)",定位到 html_report.py
  • 搜索 _save_report 方法,在所有 write_text 调用后加 encoding='utf-8':
    self.logfile.write_text(report_content, encoding='utf-8')
    style_path.write_text(self.style_css, encoding='utf-8')
  • 同理检查 result.py 中涉及字符串拼接生成 nodeid 或 name 的地方,避免先 encode('utf-8') 再 decode('unicode_escape') 这类多余转换——这会把原本正常的中文变成 u82f9u679c

conftest.py 钩子中慎用 encode/decode 链式操作

网上流传的 item.name.encode().decode('unicode_escape') 是典型“以毒攻毒”:它假设原始字符串已是 Unicode 转义形式,但实际多数情况是正常中文字符串。强行 decode 会抛 UnicodeDecodeError 或静默损坏。

  • 先判断是否含 u 转义:if '\u' in item.name: 再做解码
  • 更安全的做法是只处理 nodeid 中明确被转义的部分,例如:
    if '[' in item.nodeid and ']' in item.nodeid:
        parts = item.nodeid.split('[', 1)
        if len(parts) == 2:
            id_part = parts[1].rstrip(']')
            try:
                item._nodeid = f"{parts[0]}[{id_part.encode().decode('unicode_escape')}]"
            except UnicodeDecodeError:
                pass
  • 真正一劳永逸的方式是禁用 ID 转义:disable_test_id_escaping_and_forfeit_all_rights_to_community_support=True 加进 pytest.ini,前提是你确认所有执行环境都支持 UTF-8 终端显示

最关键的其实是顺序:先保证源文件是 UTF-8,再统一运行时环境编码,最后才动插件和钩子。很多人一上来就改 conftest.py,结果发现控制台还是乱码——那说明根本没走到钩子那步,问题早在读取文件时就发生了。

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

相关专题

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

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

2023.07.20

1711

4

python能做什么
python能做什么

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

2023.07.25

4324

7

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

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

2023.07.31

1689

3

python教程
python教程

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

2023.08.03

25237

23

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

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

2023.08.04

3087

5

python eval
python eval

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

2023.08.04

3107

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

2403

5

热门下载

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

精品课程

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