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

目录

• 前言
• 一、ast 库的核心功能
• 二、ast 库的核心类与方法
• 三、实际应用场景与示例
• 场景 1：静态代码分析（检查未使用的变量）
• 场景 2：代码自动重构（替换函数名）
• 场景 3：生成代码文档（提取所有函数签名）
• 四、注意事项
• 五、总结

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

1. 解析代码为 AST
   将 Python 代码字符串转换为抽象语法树，结构化表示代码的逻辑（如函数、循环、条件语句）。

2. 遍历和修改 AST
   通过访问者模式（ast.NodeVisitor）或直接操作节点，分析或修改代码结构。

3. 生成代码
   将修改后的 AST 转换回可执行的 Python 代码（需结合第三方库如 astor 或 codegen）。

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

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

实现步骤：

1. 解析代码为 AST。
2. 遍历所有变量赋值节点（ast.Assign），记录变量名。
3. 遍历所有变量引用节点（ast.Name），标记已使用的变量。
4. 对比找出未使用的变量。

代码示例：

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'}

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

1. 使用 ast.NodeTransformer 遍历 AST。
2. 找到所有 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')

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

实现步骤：

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

代码示例：

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'}
# ]

1. 执行动态代码的风险
   直接执行 AST 生成的代码（如 exec(compile(tree, filename='', mode='exec'))）可能存在安全风险，需确保代码来源可信。

2. 语法兼容性
   ast.parse 默认使用当前 Python 版本的语法解析器，处理旧版本代码时可能报错（如 Python 3.8 之前没有 := 运算符）。

3. 代码还原工具
   ast 库本身无法将 AST 转回代码，需结合第三方库：

   • astor: 提供 astor.to_source() 方法。
   • codegen: 轻量级代码生成工具。

ast 库的典型应用场景包括：

• 代码静态分析：检查代码规范、安全漏洞或性能问题。
• 自动化重构：批量修改代码结构（如升级语法、替换 API）。
• 元编程：动态生成代码（如根据配置生成类或函数）。
• 工具开发：构建 IDE 插件、文档生成器或代码格式化工具。

通过灵活操作 AST，开发者可以深度介入 Python 代码的解析和处理过程，实现高度定制化的代码操作逻辑。

到此这篇关于Python内置模块ast详细功能介绍及使用的文章就介绍到这了,更多相关Python内置模块ast使用内容请搜索风君子博客以前的文章或继续浏览下面的相关文章希望大家以后多多支持风君子博客！

您可能感兴趣的文章:

• python 内置模块详解
• python中常用的内置模块汇总
• Python中的两个内置模块介绍
• Python基础之内置模块详解