Python AST 怎样提取节点对应的原始源码片段
来源:17golang原创
时间:2026-11-16 23:58:26 261浏览 收藏
如果你已经用 ast.parse() 得到节点,想取回它在原文件里的那段文字,优先使用 ast.get_source_segment(source, node)。它依赖节点的 lineno、col_offset、end_lineno 和 end_col_offset 四个位置字段,能保留原始空格、括号和换行;位置不完整时返回 None。需要“重新生成一段等价代码”时,才考虑 ast.unparse()。
source必须是产生该节点的同一份源码文本,不能只传节点对象。padded=True只处理多行语句首行的列位置,不会把缺失位置补成原文。- 保留原格式用
get_source_segment,生成等价代码用ast.unparse,两者目标不同。
用同一份 source 和位置字段取回原文
AST 节点保存的是语法结构,不是完整的源码字符串。解析时,表达式和语句节点通常会带上起止行号与 UTF-8 字节列偏移,get_source_segment 再根据这些坐标从 source 中切出片段。这里的关键不是重新拼接节点字段,而是让文本与位置保持同源。
import ast
source = "total = (first + second)\n"
tree = ast.parse(source)
value = tree.body[0].value
# 读取节点在原 source 中的范围,保留括号和空格
segment = ast.get_source_segment(source, value)
if segment is None:
raise ValueError("节点缺少完整的源码位置信息")
print(segment) # 输出:first + second
示例中的节点来自这一次 ast.parse(source),因此位置与文本相互匹配。若把节点复制到另一棵树、修改了位置字段,或把 source 换成删过空格的字符串,结果就不再代表原文件。官方定义的四个位置字段只要缺一个,函数就会返回 None,这比静默返回错误片段更容易排查。

多行节点如何选择 padded 参数
单行表达式一般直接使用默认值即可。多行语句则要先问自己:返回值是否还要放回原来的代码列位置?将 padded 设为 True 后,函数会在多行语句的第一行前补空格,使这一行对齐原始起始列;后续行的内容仍然来自原文。它是排版辅助,不是位置修复器。
import ast source = "result = (\n first +\n second\n)\n" tree = ast.parse(source) assign = tree.body[0] # 多行语句需要保留首行所在列时才开启 padded raw = ast.get_source_segment(source, assign, padded=False) aligned = ast.get_source_segment(source, assign, padded=True) print(raw is not None) # 输出:True print(aligned == raw) # 输出:True 或 False 取决于首行原始列位置
不要用 padded=True 来挽救没有 end_lineno 或 end_col_offset 的人工节点;缺字段时函数仍然返回 None。如果节点是转换器新建的,先决定它是否仍然代表原始文本,再考虑用 ast.copy_location 或 ast.fix_missing_locations 处理编译所需的位置,不能把后者当作原文恢复保证。
原始片段和 ast.unparse 的选择边界
两种方法的输出目标不同。原文提取适合代码审计、重构定位、错误高亮和需要保留用户排版的工具;ast.unparse 适合节点已经被修改,需要输出一段可再次解析的 Python 代码。后者可能改变括号、空格和引号风格,所以“语义等价”不等于“字符相同”。
| 需求 | 优先方案 | 要留意的边界 |
|---|---|---|
| 保留原空格和括号 | get_source_segment | source 与节点位置必须同源且完整 |
| 跨行片段保持首行列位 | padded=True | 只补多行首行,不恢复缺失位置 |
| 节点改写后生成代码 | ast.unparse | 格式可能变化,不能当原文切片 |

落地时的检查清单
- 保存解析时使用的原始
source,不要先做strip()、换行归一化或编码转换。 - 调用前检查目标节点的四个位置属性,返回
None时记录节点类型与来源,而不是直接拼接字符串。 - 需要格式保真就保留原片段;需要输出改写后的节点就接受
unparse的格式变化,并重新解析检查语法。
常见问题
为什么 get_source_segment 返回 None?
通常是节点缺少四个位置字段之一,或者节点是手工新建的;也要检查传入的 source 是否确实来自解析该节点的文本。
padded=True 会补全所有缩进吗?
不会。它只对多行语句的第一行补空格,以匹配原始起始列,不能修复节点缺少位置的问题。
什么时候直接用 ast.unparse?
当你关心的是修改后能重新解析的代码,而不是原文字符级还原时使用;若要保留用户的排版和注释,应优先保留原 source。
-
108 收藏
-
267 收藏
-
247 收藏
-
255 收藏
-
文章 · python教程 | 53分钟前 | SQLite · Python教程 · Python SQLite sqlite3 complete_statement 多语句脚本 CREATE TRIGGER140 收藏
-
290 收藏
-
256 收藏
-
299 收藏
-
文章 · python教程 | 1小时前 | 依赖管理 · 故障排查 · Python教程 · Python importlib.metadata packages_distributions 发行包 导入名138 收藏
-
417 收藏
-
235 收藏
-
443 收藏
-
- 前端进阶之JavaScript设计模式
- 设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
- 立即学习 543次学习
-
- GO语言核心编程课程
- 本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
- 立即学习 516次学习
-
- 简单聊聊mysql8与网络通信
- 如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
- 立即学习 500次学习
-
- JavaScript正则表达式基础与实战
- 在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
- 立即学习 487次学习
-
- 从零制作响应式网站—Grid布局
- 本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
- 立即学习 485次学习