`ast.md`

308 строк · 21.7 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.6/library/ast.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 32.2. [`ast`](https://python-all.ru/3.6/library/ast.html#module-ast) – Абстрактные синтаксические деревья89**Исходный код:** [Lib/ast.py](https://python-all.ru/src/3.6/Lib/ast.py)1011---1213Модуль [`ast`](https://python-all.ru/3.6/library/ast.html#module-ast) помогает приложениям Python обрабатывать деревья абстрактного синтаксиса языка Python. Абстрактный синтаксис может меняться от версии к версии; с помощью этого модуля можно программно узнать, как выглядит текущая грамматика.1415Абстрактное синтаксическое дерево можно создать, передав `ast.PyCF_ONLY_AST` в качестве флага встроенной функции [`compile()`](https://python-all.ru/3.6/library/functions.html#compile) или используя вспомогательную функцию [`parse()`](https://python-all.ru/3.6/library/ast.html#ast.parse) из этого модуля. Результатом будет дерево объектов, классы которых наследуют от [`ast.AST`](https://python-all.ru/3.6/library/ast.html#ast.AST). Абстрактное синтаксическое дерево можно скомпилировать в объект кода Python с помощью встроенной функции [`compile()`](https://python-all.ru/3.6/library/functions.html#compile).1617## 32.2.1. Классы узлов1819#### `class ast.AST`2021Это базовый класс всех узлов AST. Конкретные классы узлов порождаются из файла `Parser/Python.asdl`, который воспроизведён [ниже](https://python-all.ru/3.6/library/ast.html#abstract-grammar). Они определены в C-модуле `_ast` и реэкспортированы в [`ast`](https://python-all.ru/3.6/library/ast.html#module-ast).2223Для каждого символа левой части абстрактной грамматики определён один класс (например, `ast.stmt` или `ast.expr`). Кроме того, для каждого конструктора правой части определён один класс; эти классы наследуют от классов для деревьев левой части. Например, `ast.BinOp` наследует от `ast.expr`. Для продукционных правил с альтернативами (так называемых «сумм») класс левой части является абстрактным: создаются только экземпляры конкретных узлов-конструкторов.2425#### `_fields`2627Каждый конкретный класс имеет атрибут [`_fields`](https://python-all.ru/3.6/library/ast.html#ast.AST._fields), который содержит имена всех дочерних узлов.2829Каждый экземпляр конкретного класса имеет по одному атрибуту для каждого дочернего узла, тип которого определён в грамматике. Например, экземпляры `ast.BinOp` имеют атрибут `left` типа `ast.expr`.3031Если эти атрибуты помечены как необязательные в грамматике (с помощью вопросительного знака), значением может быть `None`. Если атрибуты могут иметь ноль или более значений (помечены звёздочкой), значения представляются в виде списков Python. Все возможные атрибуты должны присутствовать и иметь корректные значения при компиляции AST с помощью [`compile()`](https://python-all.ru/3.6/library/functions.html#compile).3233#### `lineno`3435#### `col_offset`3637Экземпляры подклассов `ast.expr` и `ast.stmt` имеют [`lineno`](https://python-all.ru/3.6/library/ast.html#ast.AST.lineno) и [`col_offset`](https://python-all.ru/3.6/library/ast.html#ast.AST.col_offset) атрибуты. [`lineno`](https://python-all.ru/3.6/library/ast.html#ast.AST.lineno) – это номер строки исходного текста (нумерация с 1, то есть первая строка – строка 1), а [`col_offset`](https://python-all.ru/3.6/library/ast.html#ast.AST.col_offset) – смещение в байтах UTF-8 первого токена, который породил узел. Смещение в UTF-8 записывается, потому что синтаксический анализатор использует UTF-8 внутри.3839Конструктор класса `ast.T` разбирает свои аргументы следующим образом:4041- Если есть позиционные аргументы, их должно быть столько же, сколько элементов в `T._fields`; они будут присвоены как атрибуты с этими именами.42- Если есть ключевые аргументы, они установят атрибуты с теми же именами в указанные значения.4344Например, чтобы создать и заполнить узел `ast.UnaryOp`, можно использовать4546```python47node = ast.UnaryOp()48node.op = ast.USub()49node.operand = ast.Num()50node.operand.n = 551node.operand.lineno = 052node.operand.col_offset = 053node.lineno = 054node.col_offset = 055```5657или более компактный5859```python60node = ast.UnaryOp(ast.USub(), ast.Num(5, lineno=0, col_offset=0),61                   lineno=0, col_offset=0)62```6364## 32.2.2. Абстрактная грамматика6566Абстрактная грамматика в настоящее время определяется следующим образом:6768```text69-- ASDL's 7 builtin types are:70-- identifier, int, string, bytes, object, singleton, constant71--72-- singleton: None, True or False73-- constant can be None, whereas None means "no value" for object.7475module Python76{77    mod = Module(stmt* body)78        | Interactive(stmt* body)79        | Expression(expr body)8081        -- not really an actual node but useful in Jython's typesystem.82        | Suite(stmt* body)8384    stmt = FunctionDef(identifier name, arguments args,85                       stmt* body, expr* decorator_list, expr? returns)86          | AsyncFunctionDef(identifier name, arguments args,87                             stmt* body, expr* decorator_list, expr? returns)8889          | ClassDef(identifier name,90             expr* bases,91             keyword* keywords,92             stmt* body,93             expr* decorator_list)94          | Return(expr? value)9596          | Delete(expr* targets)97          | Assign(expr* targets, expr value)98          | AugAssign(expr target, operator op, expr value)99          -- 'simple' indicates that we annotate simple name without parens100          | AnnAssign(expr target, expr annotation, expr? value, int simple)101102          -- use 'orelse' because else is a keyword in target languages103          | For(expr target, expr iter, stmt* body, stmt* orelse)104          | AsyncFor(expr target, expr iter, stmt* body, stmt* orelse)105          | While(expr test, stmt* body, stmt* orelse)106          | If(expr test, stmt* body, stmt* orelse)107          | With(withitem* items, stmt* body)108          | AsyncWith(withitem* items, stmt* body)109110          | Raise(expr? exc, expr? cause)111          | Try(stmt* body, excepthandler* handlers, stmt* orelse, stmt* finalbody)112          | Assert(expr test, expr? msg)113114          | Import(alias* names)115          | ImportFrom(identifier? module, alias* names, int? level)116117          | Global(identifier* names)118          | Nonlocal(identifier* names)119          | Expr(expr value)120          | Pass | Break | Continue121122          -- XXX Jython will be different123          -- col_offset is the byte offset in the utf8 string the parser uses124          attributes (int lineno, int col_offset)125126          -- BoolOp() can use left & right?127    expr = BoolOp(boolop op, expr* values)128         | BinOp(expr left, operator op, expr right)129         | UnaryOp(unaryop op, expr operand)130         | Lambda(arguments args, expr body)131         | IfExp(expr test, expr body, expr orelse)132         | Dict(expr* keys, expr* values)133         | Set(expr* elts)134         | ListComp(expr elt, comprehension* generators)135         | SetComp(expr elt, comprehension* generators)136         | DictComp(expr key, expr value, comprehension* generators)137         | GeneratorExp(expr elt, comprehension* generators)138         -- the grammar constrains where yield expressions can occur139         | Await(expr value)140         | Yield(expr? value)141         | YieldFrom(expr value)142         -- need sequences for compare to distinguish between143         -- x < 4 < 3 and (x < 4) < 3144         | Compare(expr left, cmpop* ops, expr* comparators)145         | Call(expr func, expr* args, keyword* keywords)146         | Num(object n) -- a number as a PyObject.147         | Str(string s) -- need to specify raw, unicode, etc?148         | FormattedValue(expr value, int? conversion, expr? format_spec)149         | JoinedStr(expr* values)150         | Bytes(bytes s)151         | NameConstant(singleton value)152         | Ellipsis153         | Constant(constant value)154155         -- the following expression can appear in assignment context156         | Attribute(expr value, identifier attr, expr_context ctx)157         | Subscript(expr value, slice slice, expr_context ctx)158         | Starred(expr value, expr_context ctx)159         | Name(identifier id, expr_context ctx)160         | List(expr* elts, expr_context ctx)161         | Tuple(expr* elts, expr_context ctx)162163          -- col_offset is the byte offset in the utf8 string the parser uses164          attributes (int lineno, int col_offset)165166    expr_context = Load | Store | Del | AugLoad | AugStore | Param167168    slice = Slice(expr? lower, expr? upper, expr? step)169          | ExtSlice(slice* dims)170          | Index(expr value)171172    boolop = And | Or173174    operator = Add | Sub | Mult | MatMult | Div | Mod | Pow | LShift175                 | RShift | BitOr | BitXor | BitAnd | FloorDiv176177    unaryop = Invert | Not | UAdd | USub178179    cmpop = Eq | NotEq | Lt | LtE | Gt | GtE | Is | IsNot | In | NotIn180181    comprehension = (expr target, expr iter, expr* ifs, int is_async)182183    excepthandler = ExceptHandler(expr? type, identifier? name, stmt* body)184                    attributes (int lineno, int col_offset)185186    arguments = (arg* args, arg? vararg, arg* kwonlyargs, expr* kw_defaults,187                 arg? kwarg, expr* defaults)188189    arg = (identifier arg, expr? annotation)190           attributes (int lineno, int col_offset)191192    -- keyword arguments supplied to call (NULL identifier for **kwargs)193    keyword = (identifier? arg, expr value)194195    -- import name with optional 'as' alias.196    alias = (identifier name, identifier? asname)197198    withitem = (expr context_expr, expr? optional_vars)199}200```201202## 32.2.3. [`ast`](https://python-all.ru/3.6/library/ast.html#module-ast) Вспомогательные функции203204Помимо классов узлов, модуль [`ast`](https://python-all.ru/3.6/library/ast.html#module-ast) определяет следующие служебные функции и классы для обхода абстрактных синтаксических деревьев:205206#### `ast.parse(source, filename='<unknown>', mode='exec')`207208Разбирает исходный код в узел AST. Эквивалентно `compile(source, filename, mode, ast.PyCF_ONLY_AST)`.209210> **Предупреждение**211>212> Можно вызвать сбой интерпретатора Python с помощью достаточно большой/сложной строки из-за ограничений глубины стека в компиляторе AST Python.213214#### `ast.literal_eval(node_or_string)`215216Безопасно вычисляет узел выражения или строку, содержащую литерал Python или отображение контейнера. Предоставленная строка или узел могут состоять только из следующих литеральных структур Python: строки, байты, числа, кортежи, списки, словари, множества, логические значения и `None`.217218Это можно использовать для безопасного вычисления строк, содержащих значения Python из ненадёжных источников, без необходимости разбирать значения самостоятельно. Он не способен вычислять произвольно сложные выражения, например с операторами или индексацией.219220> **Предупреждение**221>222> Можно вызвать сбой интерпретатора Python с помощью достаточно большой/сложной строки из-за ограничений глубины стека в компиляторе AST Python.223224Изменено в версии 3.2: Теперь допускает литералы байтов и множеств.225226#### `ast.get_docstring(node, clean=True)`227228Возвращает докстринг заданного узла *node* (который должен быть узлом `FunctionDef`, `ClassDef` или `Module`), или `None` если у него нет докстринга. Если *clean* истинно, очищает отступы докстринга с помощью [`inspect.cleandoc()`](https://python-all.ru/3.6/library/inspect.html#inspect.cleandoc).229230#### `ast.fix_missing_locations(node)`231232При компиляции дерева узлов с помощью [`compile()`](https://python-all.ru/3.6/library/functions.html#compile) компилятор ожидает атрибуты `lineno` и `col_offset` для каждого узла, который их поддерживает. Заполнять их вручную для сгенерированных узлов довольно утомительно, поэтому эта вспомогательная функция рекурсивно добавляет эти атрибуты, если их ещё нет, устанавливая их равными значениям родительского узла. Работает рекурсивно, начиная с *node*.233234#### `ast.increment_lineno(node, n=1)`235236Увеличить номер строки каждого узла в дереве, начиная с *node*, на *n*. Это полезно для «переноса кода» в другое место в файле.237238#### `ast.copy_location(new_node, old_node)`239240Скопировать местоположение в исходном коде (`lineno` и `col_offset`) из *old\_node* в *new\_node*, если возможно, и вернуть *new\_node*.241242#### `ast.iter_fields(node)`243244Генерирует кортеж из `(fieldname, value)` для каждого поля в `node._fields`, которое присутствует в *node*.245246#### `ast.iter_child_nodes(node)`247248Генерирует все непосредственные дочерние узлы *node*, то есть все поля, являющиеся узлами, и все элементы полей, являющихся списками узлов.249250#### `ast.walk(node)`251252Рекурсивно генерирует все узлы-потомки в дереве, начиная с *node* (включая сам *node*), в произвольном порядке. Это полезно, если требуется только изменить узлы на месте, а контекст не важен.253254#### `class ast.NodeVisitor`255256Базовый класс для обхода узлов, который обходит абстрактное синтаксическое дерево и вызывает функцию-посетитель для каждого найденного узла. Эта функция может вернуть значение, которое передаётся методом [`visit()`](https://python-all.ru/3.6/library/ast.html#ast.NodeVisitor.visit).257258Этот класс предназначен для наследования; в подклассе добавляются методы-посетители.259260#### `visit(node)`261262Посещает узел. Реализация по умолчанию вызывает метод `self.visit_classname`, где *classname* – имя класса узла, или [`generic_visit()`](https://python-all.ru/3.6/library/ast.html#ast.NodeVisitor.generic_visit), если такой метод отсутствует.263264#### `generic_visit(node)`265266Этот посетитель вызывает [`visit()`](https://python-all.ru/3.6/library/ast.html#ast.NodeVisitor.visit) для всех дочерних узлов.267268Обратите внимание, что дочерние узлы тех узлов, для которых определён собственный метод-посетитель, не будут посещены, если посетитель сам не вызовет [`generic_visit()`](https://python-all.ru/3.6/library/ast.html#ast.NodeVisitor.generic_visit) или не обойдёт их самостоятельно.269270Не используйте [`NodeVisitor`](https://python-all.ru/3.6/library/ast.html#ast.NodeVisitor), если требуется вносить изменения в узлы во время обхода. Для этого существует специальный посетитель ([`NodeTransformer`](https://python-all.ru/3.6/library/ast.html#ast.NodeTransformer)), который допускает модификации.271272#### `class ast.NodeTransformer`273274Подкласс [`NodeVisitor`](https://python-all.ru/3.6/library/ast.html#ast.NodeVisitor), который обходит абстрактное синтаксическое дерево и позволяет изменять узлы.275276Метод [`NodeTransformer`](https://python-all.ru/3.6/library/ast.html#ast.NodeTransformer) обходит AST и использует возвращаемое значение методов-посетителей для замены или удаления старого узла. Если возвращаемое значение метода-посетителя равно `None`, узел будет удалён из своего местоположения; в противном случае он заменяется возвращённым значением. Возвращённое значение может быть исходным узлом – в этом случае замена не происходит.277278Вот пример преобразователя, который переписывает все обращения к именам (`foo`) в `data['foo']`:279280```python281class RewriteName(NodeTransformer):282283    def visit_Name(self, node):284        return copy_location(Subscript(285            value=Name(id='data', ctx=Load()),286            slice=Index(value=Str(s=node.id)),287            ctx=node.ctx288        ), node)289```290291Имейте в виду: если у узла, с которым вы работаете, есть дочерние узлы, необходимо либо преобразовать дочерние узлы самостоятельно, либо сначала вызвать для узла метод `generic_visit()`.292293Для узлов, входящих в состав набора инструкций (это относится ко всем узлам инструкций), посетитель может также возвращать список узлов, а не один узел.294295Обычно преобразователь используется следующим образом:296297```python298node = YourTransformer().visit(node)299```300301#### `ast.dump(node, annotate_fields=True, include_attributes=False)`302303Возвращает форматированный дамп дерева в узле *node*. Это в основном полезно для целей отладки. Возвращаемая строка показывает имена и значения полей. Это делает код невычислимым, поэтому если требуется вычисление, *annotate\_fields* должно быть установлено в `False`. Атрибуты, такие как номера строк и смещения столбцов, по умолчанию не дампятся. Если это требуется, *include\_attributes* может быть установлено в `True`.304305> **См. также**306>307> [Green Tree Snakes](https://python-all.ru/3.6/library/ast.html) – внешний ресурс документации, содержащий подробную информацию о работе с AST Python.308