深入理解Python语法树（AST）

什么是抽象语法树（AST）？

抽象语法树是一种树形数据结构，它以层次化的方式表示源代码的语法结构。例如，表达式 1 + 2 * 3 在AST中会表现为一个树，其中乘法节点是加法节点的子节点，这反映了运算符优先级。

Python如何生成AST？

Python标准库提供了 ast 模块，可以轻松将源代码解析为AST。下面是一个最简单的例子：

import astcode = "print('Hello, AST!')"tree = ast.parse(code)# 打印AST结构print(ast.dump(tree, indent=4))

运行上述代码，你会看到类似如下的输出（格式化后）：

Module(    body=[        Expr(            value=Call(                func=Name(id='print', ctx=Load()),                args=[                    Constant(value='Hello, AST!')                ],                keywords=[]            )        )    ],    type_ignores=[])

这个结构清晰地展示了代码的组成：一个模块（Module），包含一个表达式（Expr），该表达式是一个函数调用（Call），调用了 print 函数，并传入一个字符串常量。

遍历和修改AST

要分析或修改AST，我们可以使用 ast.NodeVisitor 或 ast.NodeTransformer。前者用于读取，后者用于修改。

下面是一个使用 NodeVisitor 打印所有函数调用的例子：

import astclass CallVisitor(ast.NodeVisitor):    def visit_Call(self, node):        if isinstance(node.func, ast.Name):            print(f"Found function call: {node.func.id}")        self.generic_visit(node)  # 继续遍历子节点code = """print("Start")result = max(1, 2, 3)"""tree = ast.parse(code)visitor = CallVisitor()visitor.visit(tree)

输出：

Found function call: printFound function call: max

实战：自动添加注释

假设我们想为每个函数定义自动添加一个注释。可以使用 NodeTransformer 修改AST：

import astimport astunparse  # 需要安装: pip install astunparseclass AddDocstringTransformer(ast.NodeTransformer):    def visit_FunctionDef(self, node):        if not ast.get_docstring(node):            docstring = ast.Expr(value=ast.Constant(value=f"Auto-generated doc for {node.name}"))            node.body.insert(0, docstring)        return nodecode = """def greet(name):    return f'Hello, {name}!'"""tree = ast.parse(code)transformer = AddDocstringTransformer()new_tree = transformer.visit(tree)# 将AST转回源代码print(astunparse.unparse(new_tree))

输出结果会包含自动生成的文档字符串：

def greet(name):    'Auto-generated doc for greet'    return f'Hello, {name}!'

总结

通过本文，你已经掌握了Python代码分析的核心工具——抽象语法树（AST）。无论是做代码质量检查、自动重构，还是教学演示，AST都能提供强大的底层支持。记住，抽象语法树教程只是起点，真正的能力在于动手实践。

希望这篇教程能帮助你开启Python语法树的探索之旅！