Skip to main content

32.2. ast —抽象语法树

源代码: Lib/ast.py


ast 模块帮助Python应用程序处理Python抽象语法语法的树。抽象语法本身可能随每个Python版本而改变;这个模块有助于以编程方式找出当前语法的样子。

可以通过将 ast.PyCF_ONLY_AST 作为标志传递到 compile() 内置函数,或使用此模块中提供的 parse() 助手来生成抽象语法树。结果将是一个对象的树,其类都继承自 ast.AST。可以使用内置的 compile() 函数将抽象语法树编译为Python代码对象。

32.2.1. 节点类

class ast.AST

这是所有AST节点类的基础。实际的节点类派生自 Parser/Python.asdl 文件,该文件由 下面 再现。它们在 _ast C模块中定义,并在 ast 中重新导出。

为抽象语法中的每个左侧符号定义了一个类(例如,ast.stmtast.expr)。此外,右侧为每个构造函数定义了一个类;这些类继承自左侧树的类。例如,ast.BinOpast.expr 继承。对于具有替代的生产规则(也称为“sums”),左侧类是抽象的:只有特定构造函数节点的实例被创建。

_fields

每个具体类都有一个属性 _fields,它给出所有子节点的名称。

具体类的每个实例对于每个子节点具有在语法中定义的类型的一个属性。例如,ast.BinOp 实例具有类型 ast.expr 的属性 left

如果这些属性在语法中标记为可选(使用问号),则值可能为 None。如果属性可以具有零个或多个值(标有星号),那么值将表示为Python列表。当用 compile() 编译AST时,所有可能的属性必须存在并具有有效值。

lineno
col_offset

ast.exprast.stmt 子类的实例具有 linenocol_offset 属性。 lineno 是源文本的行号(1索引,因此第一行是行1),col_offset 是生成节点的第一个令牌的UTF-8字节偏移量。记录UTF-8偏移,因为解析器在内部使用UTF-8。

ast.T 类的构造函数按如下方式解析其参数:

  • 如果有位置参数,必须有与 T._fields 中的项目一样多;它们将被分配为这些名称的属性。

  • 如果有关键字参数,它们将把相同名称的属性设置为给定的值。

例如,要创建和填充 ast.UnaryOp 节点,您可以使用

node = ast.UnaryOp()
node.op = ast.USub()
node.operand = ast.Num()
node.operand.n = 5
node.operand.lineno = 0
node.operand.col_offset = 0
node.lineno = 0
node.col_offset = 0

或更紧凑

node = ast.UnaryOp(ast.USub(), ast.Num(5, lineno=0, col_offset=0),
                   lineno=0, col_offset=0)

32.2.2. 抽象语法

抽象语法目前定义如下:

-- ASDL's 7 builtin types are:
-- identifier, int, string, bytes, object, singleton, constant
--
-- singleton: None, True or False
-- constant can be None, whereas None means "no value" for object.

module Python
{
    mod = Module(stmt* body)
        | Interactive(stmt* body)
        | Expression(expr body)

        -- not really an actual node but useful in Jython's typesystem.
        | Suite(stmt* body)

    stmt = FunctionDef(identifier name, arguments args,
                       stmt* body, expr* decorator_list, expr? returns)
          | AsyncFunctionDef(identifier name, arguments args,
                             stmt* body, expr* decorator_list, expr? returns)

          | ClassDef(identifier name,
             expr* bases,
             keyword* keywords,
             stmt* body,
             expr* decorator_list)
          | Return(expr? value)

          | Delete(expr* targets)
          | Assign(expr* targets, expr value)
          | AugAssign(expr target, operator op, expr value)
          -- 'simple' indicates that we annotate simple name without parens
          | AnnAssign(expr target, expr annotation, expr? value, int simple)

          -- use 'orelse' because else is a keyword in target languages
          | For(expr target, expr iter, stmt* body, stmt* orelse)
          | AsyncFor(expr target, expr iter, stmt* body, stmt* orelse)
          | While(expr test, stmt* body, stmt* orelse)
          | If(expr test, stmt* body, stmt* orelse)
          | With(withitem* items, stmt* body)
          | AsyncWith(withitem* items, stmt* body)

          | Raise(expr? exc, expr? cause)
          | Try(stmt* body, excepthandler* handlers, stmt* orelse, stmt* finalbody)
          | Assert(expr test, expr? msg)

          | Import(alias* names)
          | ImportFrom(identifier? module, alias* names, int? level)

          | Global(identifier* names)
          | Nonlocal(identifier* names)
          | Expr(expr value)
          | Pass | Break | Continue

          -- XXX Jython will be different
          -- col_offset is the byte offset in the utf8 string the parser uses
          attributes (int lineno, int col_offset)

          -- BoolOp() can use left & right?
    expr = BoolOp(boolop op, expr* values)
         | BinOp(expr left, operator op, expr right)
         | UnaryOp(unaryop op, expr operand)
         | Lambda(arguments args, expr body)
         | IfExp(expr test, expr body, expr orelse)
         | Dict(expr* keys, expr* values)
         | Set(expr* elts)
         | ListComp(expr elt, comprehension* generators)
         | SetComp(expr elt, comprehension* generators)
         | DictComp(expr key, expr value, comprehension* generators)
         | GeneratorExp(expr elt, comprehension* generators)
         -- the grammar constrains where yield expressions can occur
         | Await(expr value)
         | Yield(expr? value)
         | YieldFrom(expr value)
         -- need sequences for compare to distinguish between
         -- x < 4 < 3 and (x < 4) < 3
         | Compare(expr left, cmpop* ops, expr* comparators)
         | Call(expr func, expr* args, keyword* keywords)
         | Num(object n) -- a number as a PyObject.
         | Str(string s) -- need to specify raw, unicode, etc?
         | FormattedValue(expr value, int? conversion, expr? format_spec)
         | JoinedStr(expr* values)
         | Bytes(bytes s)
         | NameConstant(singleton value)
         | Ellipsis
         | Constant(constant value)

         -- the following expression can appear in assignment context
         | Attribute(expr value, identifier attr, expr_context ctx)
         | Subscript(expr value, slice slice, expr_context ctx)
         | Starred(expr value, expr_context ctx)
         | Name(identifier id, expr_context ctx)
         | List(expr* elts, expr_context ctx)
         | Tuple(expr* elts, expr_context ctx)

          -- col_offset is the byte offset in the utf8 string the parser uses
          attributes (int lineno, int col_offset)

    expr_context = Load | Store | Del | AugLoad | AugStore | Param

    slice = Slice(expr? lower, expr? upper, expr? step)
          | ExtSlice(slice* dims)
          | Index(expr value)

    boolop = And | Or

    operator = Add | Sub | Mult | MatMult | Div | Mod | Pow | LShift
                 | RShift | BitOr | BitXor | BitAnd | FloorDiv

    unaryop = Invert | Not | UAdd | USub

    cmpop = Eq | NotEq | Lt | LtE | Gt | GtE | Is | IsNot | In | NotIn

    comprehension = (expr target, expr iter, expr* ifs, int is_async)

    excepthandler = ExceptHandler(expr? type, identifier? name, stmt* body)
                    attributes (int lineno, int col_offset)

    arguments = (arg* args, arg? vararg, arg* kwonlyargs, expr* kw_defaults,
                 arg? kwarg, expr* defaults)

    arg = (identifier arg, expr? annotation)
           attributes (int lineno, int col_offset)

    -- keyword arguments supplied to call (NULL identifier for **kwargs)
    keyword = (identifier? arg, expr value)

    -- import name with optional 'as' alias.
    alias = (identifier name, identifier? asname)

    withitem = (expr context_expr, expr? optional_vars)
}

32.2.3. ast 助手

除了节点类,ast 模块定义了这些效用函数和类来遍历抽象语法树:

ast.parse(source, filename='<unknown>', mode='exec')

将源解析为AST节点。相当于 compile(source, filename, mode, ast.PyCF_ONLY_AST)

ast.literal_eval(node_or_string)

安全地计算表达式节点或包含Python字面值或容器显示的字符串。提供的字符串或节点只能由以下Python字面结构组成:字符串,字节,数字,元组,列表,dicts,集合,布尔和 None

这可以用于安全地评估包含来自不可信来源的Python值的字符串,而不需要解析值自己。它不能够评估任意复杂的表达式,例如涉及运算符或索引。

在 3.2 版更改: 现在允许字节和设置文字。

ast.get_docstring(node, clean=True)

返回给定 node (它必须是 FunctionDefClassDefModule 节点)的docstring,如果没有docstring,则返回 None。如果 clean 为true,请使用 inspect.cleandoc() 清除docstring的缩进。

ast.fix_missing_locations(node)

当您使用 compile() 编译节点树时,编译器需要为支持它们的每个节点提供 linenocol_offset 属性。这是非常繁琐的填充生成的节点,所以此助手通过将其设置为父节点的值,递归地添加这些属性尚未设置。它从 node 开始递归。

ast.increment_lineno(node, n=1)

node 开始,通过 n 增加树中每个节点的行号。这对于“将代码移动到文件中的其他位置很有用。

ast.copy_location(new_node, old_node)

如果可能,将源位置(linenocol_offset)从 old_node 复制到 new_node,并返回 new_node

ast.iter_fields(node)

对存在于 node 上的 node._fields 中的每个字段产生 (fieldname, value) 的元组。

ast.iter_child_nodes(node)

产生 node 的所有直接子节点,即作为节点的所有字段和作为节点列表的所有字段项。

ast.walk(node)

递归地以 node (包括 node 本身)开始,以没有指定的顺序产生树中的所有后代节点。如果您只想要修改节点并且不关心上下文,这将非常有用。

class ast.NodeVisitor

一个节点访问者基类,它遍历抽象语法树并为找到的每个节点调用一个访问者函数。该函数可以返回由 visit() 方法转发的值。

这个类是子类化的,子类添加了访问者方法。

visit(node)

访问节点。默认实现调用称为 self.visit_classname 的方法,其中 classname 是节点类的名称,如果该方法不存在,则为 generic_visit()

generic_visit(node)

此访问者对节点的所有子代调用 visit()

注意,除非访问者调用 generic_visit() 或访问它们本身,否则不会访问具有自定义访问者方法的节点的子节点。

如果要在遍历期间将更改应用于节点,请不要使用 NodeVisitor。为此,存在允许修改的特殊访问者(NodeTransformer)。

class ast.NodeTransformer

NodeVisitor 子类,它遍历抽象语法树并允许修改节点。

NodeTransformer 将遍历AST并使用访问者方法的返回值来替换或删除旧节点。如果访问者方法的返回值为 None,则节点将从其位置删除,否则将替换为返回值。返回值可以是原始节点,在这种情况下不发生替换。

下面是一个将所有出现的名称查找(foo)重写为 data['foo'] 的示例变换器:

class RewriteName(NodeTransformer):

    def visit_Name(self, node):
        return copy_location(Subscript(
            value=Name(id='data', ctx=Load()),
            slice=Index(value=Str(s=node.id)),
            ctx=node.ctx
        ), node)

请记住,如果您操作的节点具有子节点,则必须自己变换子节点,或者首先为该节点调用 generic_visit() 方法。

对于作为语句集合(适用于所有语句节点)的一部分的节点,访问者还可以返回节点列表,而不仅仅是单个节点。

通常你使用这样的变压器:

node = YourTransformer().visit(node)
ast.dump(node, annotate_fields=True, include_attributes=False)

node 中返回树的格式化转储。这主要用于调试目的。返回的字符串将显示字段的名称和值。这使得代码不可能评估,因此如果评估是想要 annotate_fields 必须设置为 False。默认情况下,不转储行号和列偏移等属性。如果需要,include_attributes 可以设置为 True

参见

绿色树蛇 是一个外部文档资源,具有使用Python AST的良好细节。