Python内置模块ast详细功能介绍及使用示例_Python

前言

python 的 ast 库（abstract syntax tree，抽象语法树库）是一个用于解析和操作 python 代码结构的标准库。它的核心功能是将 python 代码转换为树状数据结构（ast），从而允许开发者以编程方式分析、修改或生成代码。以下是 ast 库的详细说明及实际应用场景示例：

一、ast 库的核心功能

解析代码为 ast
将 python 代码字符串转换为抽象语法树，结构化表示代码的逻辑（如函数、循环、条件语句）。
遍历和修改 ast
通过访问者模式（ast.nodevisitor）或直接操作节点，分析或修改代码结构。
生成代码
将修改后的 ast 转换回可执行的 python 代码（需结合第三方库如 astor 或 codegen）。

二、ast 库的核心类与方法

类/方法	说明
`ast.parse(code)`	解析字符串代码为 ast 对象（返回 `ast.module` 节点）
`ast.dump(node)`	将 ast 节点转换为可读的字符串表示（调试用）
`ast.nodevisitor`	基类，用于遍历 ast 节点（通过重写 `visit_<nodetype>` 方法处理节点）
`ast.nodetransformer`	基类，用于修改 ast 节点（通过返回新节点替换原节点）

三、实际应用场景与示例

场景 1：静态代码分析（检查未使用的变量）

需求：检查代码中是否有定义但未使用的变量（类似 pylint 的功能）。

实现步骤：

解析代码为 ast。
遍历所有变量赋值节点（ast.assign），记录变量名。
遍历所有变量引用节点（ast.name），标记已使用的变量。
对比找出未使用的变量。

代码示例：

import ast

class unusedvarchecker(ast.nodevisitor):
    def __init__(self):
        self.defined_vars = set()  # 存储已定义的变量
        self.used_vars = set()     # 存储已使用的变量

    def visit_assign(self, node):
        # 记录赋值语句左侧的变量名（如 x = 10）
        for target in node.targets:
            if isinstance(target, ast.name):
                self.defined_vars.add(target.id)
        self.generic_visit(node)  # 继续遍历子节点

    def visit_name(self, node):
        # 记录变量被引用的情况（如 print(x)）
        if isinstance(node.ctx, ast.load):  # 仅统计读取操作
            self.used_vars.add(node.id)
        self.generic_visit(node)

    def report(self):
        unused = self.defined_vars - self.used_vars
        print(f"未使用的变量: {unused}")

# 测试代码
code = """
x = 10
y = 20
print(y)
"""

tree = ast.parse(code)
checker = unusedvarchecker()
checker.visit(tree)
checker.report()  # 输出：未使用的变量: {'x'}

场景 2：代码自动重构（替换函数名）

需求：将代码中所有 print 函数调用替换为 logger.info。
实现步骤：

使用 ast.nodetransformer 遍历 ast。
找到所有 ast.call 节点，若函数名为 print，则替换为 logger.info。

代码示例：

import ast
import astor  # 第三方库，用于将 ast 转回代码

class printtologgertransformer(ast.nodetransformer):
    def visit_call(self, node):
        # 检查是否是 print 函数调用
        if isinstance(node.func, ast.name) and node.func.id == 'print':
            # 构造新的函数调用节点：logger.info(*args)
            new_func = ast.attribute(
                value=ast.name(id='logger', ctx=ast.load()),
                attr='info',
                ctx=ast.load()
            )
            node.func = new_func
        return node

# 原始代码
code = """
print('hello')
x = 5
print('world')
"""

tree = ast.parse(code)
transformer = printtologgertransformer()
new_tree = transformer.visit(tree)

# 生成修改后的代码
new_code = astor.to_source(new_tree)
print(new_code)
# 输出：
# logger.info('hello')
# x = 5
# logger.info('world')

场景 3：生成代码文档（提取所有函数签名）

需求：从代码中提取所有函数的名称、参数和返回值类型。

实现步骤：

遍历 ast 中的 ast.functiondef 节点。
解析函数名、参数列表及返回类型注解。

代码示例：

import ast

class functionextractor(ast.nodevisitor):
    def __init__(self):
        self.functions = []

    def visit_functiondef(self, node):
        # 提取函数名
        func_name = node.name
        # 提取参数列表
        args = [arg.arg for arg in node.args.args]
        # 提取返回类型注解
        returns = ast.unparse(node.returns) if node.returns else none
        self.functions.append({
            'name': func_name,
            'args': args,
            'returns': returns
        })
        self.generic_visit(node)

# 测试代码
code = """
def add(a: int, b: int) -> int:
    return a + b

def greet(name: str) -> none:
    print(f"hello, {name}!")
"""

tree = ast.parse(code)
extractor = functionextractor()
extractor.visit(tree)
print(extractor.functions)
# 输出：
# [
#   {'name': 'add', 'args': ['a', 'b'], 'returns': 'int'},
#   {'name': 'greet', 'args': ['name'], 'returns': 'none'}
# ]

四、注意事项

执行动态代码的风险
直接执行 ast 生成的代码（如 exec(compile(tree, filename='', mode='exec'))）可能存在安全风险，需确保代码来源可信。
语法兼容性
ast.parse 默认使用当前 python 版本的语法解析器，处理旧版本代码时可能报错（如 python 3.8 之前没有 := 运算符）。
代码还原工具
ast 库本身无法将 ast 转回代码，需结合第三方库：
- astor: 提供 astor.to_source() 方法。
- codegen: 轻量级代码生成工具。