Python tokenize.untokenize 为什么不能保证恢复原始空格
来源:17golang原创
时间:2026-11-10 12:26:16 265浏览 收藏
tokenize.untokenize 保证的是重新分词后 token 的类型与文本能够对应,而不是输出源码与原文件逐字节相同。普通 token 之间的空格可能重新安排,所以把它当成源码的“解压还原器”使用,容易得到意外的 diff。
官方文档:https://docs.python.org/3/library/tokenize.html
用最小例子区分两种相等
下面先保留 token 的类型和文本,再重新拼成源码。比较结果时,分别看字符串是否相同以及重新分词后的二元序列是否相同,不把两种结果混成一个判断。
import io
import tokenize
source = "total = 7 + 5\n"
def token_pairs(text):
# 保留词法身份,主动丢弃行列坐标和原始行字段。
return [
(item.type, item.string)
for item in tokenize.generate_tokens(io.StringIO(text).readline)
]
pairs = token_pairs(source)
rebuilt = tokenize.untokenize(pairs)
# repr 让普通空格和换行差异可见,不预设具体版本的排版。
print(repr(source))
print(repr(rebuilt))
print(source == rebuilt)
print(pairs == token_pairs(rebuilt))
这个例子供读者观察差异,不把某一种重建字符串当作跨版本固定输出。重要的是:二元 token 序列保留了哪些词法单元,却没有保存每两个单元之间原来用了几个空格。信息已丢失,拼接时就需要重新安排分隔。
区分词法信息与源码排版
完整的 TokenInfo 含有 type、string、start、end 和 line。type 表示类别,string 表示 token 文本;start/end 记录行列位置,line 带有来源行。普通间隔空白通常不是独立 token,但这不意味着 Python 的所有空白都不重要:缩进、逻辑换行等具有专门的词法记录。

例如字符串字面量内部的空格属于 token 文本,和赋值号两边的间隔不是同一种信息。不要为了“修正空白”直接对整个源码做空白替换,那样可能改变字符串内容、注释或缩进。
保留完整记录也不要承诺字节还原
把完整 TokenInfo 传给 untokenize,可以保留更多位置线索,常见输入的排版会更接近原文。但这仍不构成对原始字节的通用承诺。当前实现存在使用坐标补空白的逻辑;坐标能说明距离,却不能普遍表达原处到底是空格还是制表符。
文档对扩展字段的简述也不能当作原始文件保真承诺。实际维护工具应依据公开的类型与文本往返保证设计,而不是依赖某个实现版本恰好保留了多少空格。尤其在修改 token 长度之后,旧坐标未必仍然适用,位置冲突还可能引发异常。
| 保存内容 | 适合用途 | 不可据此承诺 |
|---|---|---|
| type、string | 词法替换与重新生成源码 | 原始间隔空格不变 |
| 完整 TokenInfo | 需要位置信息的分析与改写 | 原始字节完全一致 |
| 原始字节及编辑范围 | 需要控制文本差异的补丁 | 任意修改后仍自动保持语法正确 |
按保真目标选择保存方式
如果工具允许统一格式,保留需要的 token,改写后重新生成源码,再由项目采用的格式策略处理即可。如果只想改一个名称并尽量保留其他字符,应保存原始文本,以明确范围做局部替换,而不是重建整份文件。

构造文本补丁时,必须正确处理行列到文本位置的转换。tokenize 的列位置按 Unicode 码点计数,不能直接当作 UTF-8 字节偏移;制表符也不能简单视作若干显示列。多处修改应基于同一原始快照计算,避免前一次替换改变后续位置。
处理编码与输入边界
tokenize() 接收字节行并产生编码 token;generate_tokens() 接收文本行,不产生 ENCODING。untokenize 的输入中存在编码 token 时返回 bytes,否则返回 str。文件保存时应先弄清返回值类型,再选择二进制或文本写入方式。
注释能保留吗?tokenize 会返回注释 token,但主动过滤掉以后,untokenize 无法替你恢复。重新分词相同能证明程序行为完全一样吗?它回答的是词法对应关系,不能代替业务行为判断。能用它修复任意损坏源码吗?不应如此依赖,官方说明该模块按语法有效的 Python 源码设计,对无效代码的行为没有通用保证。
对源码工具而言,先确定要保留的是词法身份、可读格式,还是原始字节,再选择保存材料,通常比追逐某一处多出来的空格更有用。
-
464 收藏
-
217 收藏
-
366 收藏
-
156 收藏
-
471 收藏
-
309 收藏
-
433 收藏
-
361 收藏
-
271 收藏
-
486 收藏
-
494 收藏
-
118 收藏
-
- 前端进阶之JavaScript设计模式
- 设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
- 立即学习 543次学习
-
- GO语言核心编程课程
- 本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
- 立即学习 516次学习
-
- 简单聊聊mysql8与网络通信
- 如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
- 立即学习 500次学习
-
- JavaScript正则表达式基础与实战
- 在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
- 立即学习 487次学习
-
- 从零制作响应式网站—Grid布局
- 本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
- 立即学习 485次学习