`ast.md`

291 строк · 20.7 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.5/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.5/library/ast.html#module-ast) – Абстрактные синтаксические деревья89**Исходный код:** [Lib/ast.py](https://python-all.ru/src/3.5/Lib/ast.py)1011---1213Модуль [`ast`](https://python-all.ru/3.5/library/ast.html#module-ast) помогает приложениям Python обрабатывать деревья абстрактного синтаксиса языка Python. Абстрактный синтаксис может меняться от версии к версии; с помощью этого модуля можно программно узнать, как выглядит текущая грамматика.1415Абстрактное синтаксическое дерево можно создать, передав `ast.PyCF_ONLY_AST` в качестве флага встроенной функции [`compile()`](https://python-all.ru/3.5/library/functions.html#compile) или используя вспомогательную функцию [`parse()`](https://python-all.ru/3.5/library/ast.html#ast.parse) из этого модуля. Результатом будет дерево объектов, классы которых наследуют от [`ast.AST`](https://python-all.ru/3.5/library/ast.html#ast.AST). Абстрактное синтаксическое дерево можно скомпилировать в объект кода Python с помощью встроенной функции [`compile()`](https://python-all.ru/3.5/library/functions.html#compile).1617## 32.2.1. Классы узлов1819#### `class ast.AST`2021Это базовый класс всех узлов AST. Конкретные классы узлов порождаются из файла `Parser/Python.asdl`, который воспроизведён [ниже](https://python-all.ru/3.5/library/ast.html#abstract-grammar). Они определены в C-модуле `_ast` и реэкспортированы в [`ast`](https://python-all.ru/3.5/library/ast.html#module-ast).2223Для каждого символа левой части абстрактной грамматики определён один класс (например, `ast.stmt` или `ast.expr`). Кроме того, для каждого конструктора правой части определён один класс; эти классы наследуют от классов для деревьев левой части. Например, `ast.BinOp` наследует от `ast.expr`. Для продукционных правил с альтернативами (так называемых «сумм») класс левой части является абстрактным: создаются только экземпляры конкретных узлов-конструкторов.2425#### `_fields`2627Каждый конкретный класс имеет атрибут [`_fields`](https://python-all.ru/3.5/library/ast.html#ast.AST._fields), который содержит имена всех дочерних узлов.2829Каждый экземпляр конкретного класса имеет по одному атрибуту для каждого дочернего узла, тип которого определён в грамматике. Например, экземпляры `ast.BinOp` имеют атрибут `left` типа `ast.expr`.3031Если эти атрибуты помечены как необязательные в грамматике (с помощью вопросительного знака), значением может быть `None`. Если атрибуты могут иметь ноль или более значений (помечены звёздочкой), значения представляются в виде списков Python. Все возможные атрибуты должны присутствовать и иметь корректные значения при компиляции AST с помощью [`compile()`](https://python-all.ru/3.5/library/functions.html#compile).3233#### `lineno`3435#### `col_offset`3637Экземпляры подклассов `ast.expr` и `ast.stmt` имеют [`lineno`](https://python-all.ru/3.5/library/ast.html#ast.AST.lineno) и [`col_offset`](https://python-all.ru/3.5/library/ast.html#ast.AST.col_offset) атрибуты. [`lineno`](https://python-all.ru/3.5/library/ast.html#ast.AST.lineno) – это номер строки исходного текста (нумерация с 1, то есть первая строка – строка 1), а [`col_offset`](https://python-all.ru/3.5/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 six builtin types are identifier, int, string, bytes, object, singleton7071module Python72{73    mod = Module(stmt* body)74        | Interactive(stmt* body)75        | Expression(expr body)7677        -- not really an actual node but useful in Jython's typesystem.78        | Suite(stmt* body)7980    stmt = FunctionDef(identifier name, arguments args,81                       stmt* body, expr* decorator_list, expr? returns)82          | AsyncFunctionDef(identifier name, arguments args,83                             stmt* body, expr* decorator_list, expr? returns)8485          | ClassDef(identifier name,86             expr* bases,87             keyword* keywords,88             stmt* body,89             expr* decorator_list)90          | Return(expr? value)9192          | Delete(expr* targets)93          | Assign(expr* targets, expr value)94          | AugAssign(expr target, operator op, expr value)9596          -- use 'orelse' because else is a keyword in target languages97          | For(expr target, expr iter, stmt* body, stmt* orelse)98          | AsyncFor(expr target, expr iter, stmt* body, stmt* orelse)99          | While(expr test, stmt* body, stmt* orelse)100          | If(expr test, stmt* body, stmt* orelse)101          | With(withitem* items, stmt* body)102          | AsyncWith(withitem* items, stmt* body)103104          | Raise(expr? exc, expr? cause)105          | Try(stmt* body, excepthandler* handlers, stmt* orelse, stmt* finalbody)106          | Assert(expr test, expr? msg)107108          | Import(alias* names)109          | ImportFrom(identifier? module, alias* names, int? level)110111          | Global(identifier* names)112          | Nonlocal(identifier* names)113          | Expr(expr value)114          | Pass | Break | Continue115116          -- XXX Jython will be different117          -- col_offset is the byte offset in the utf8 string the parser uses118          attributes (int lineno, int col_offset)119120          -- BoolOp() can use left & right?121    expr = BoolOp(boolop op, expr* values)122         | BinOp(expr left, operator op, expr right)123         | UnaryOp(unaryop op, expr operand)124         | Lambda(arguments args, expr body)125         | IfExp(expr test, expr body, expr orelse)126         | Dict(expr* keys, expr* values)127         | Set(expr* elts)128         | ListComp(expr elt, comprehension* generators)129         | SetComp(expr elt, comprehension* generators)130         | DictComp(expr key, expr value, comprehension* generators)131         | GeneratorExp(expr elt, comprehension* generators)132         -- the grammar constrains where yield expressions can occur133         | Await(expr value)134         | Yield(expr? value)135         | YieldFrom(expr value)136         -- need sequences for compare to distinguish between137         -- x < 4 < 3 and (x < 4) < 3138         | Compare(expr left, cmpop* ops, expr* comparators)139         | Call(expr func, expr* args, keyword* keywords)140         | Num(object n) -- a number as a PyObject.141         | Str(string s) -- need to specify raw, unicode, etc?142         | Bytes(bytes s)143         | NameConstant(singleton value)144         | Ellipsis145146         -- the following expression can appear in assignment context147         | Attribute(expr value, identifier attr, expr_context ctx)148         | Subscript(expr value, slice slice, expr_context ctx)149         | Starred(expr value, expr_context ctx)150         | Name(identifier id, expr_context ctx)151         | List(expr* elts, expr_context ctx)152         | Tuple(expr* elts, expr_context ctx)153154          -- col_offset is the byte offset in the utf8 string the parser uses155          attributes (int lineno, int col_offset)156157    expr_context = Load | Store | Del | AugLoad | AugStore | Param158159    slice = Slice(expr? lower, expr? upper, expr? step)160          | ExtSlice(slice* dims)161          | Index(expr value)162163    boolop = And | Or164165    operator = Add | Sub | Mult | MatMult | Div | Mod | Pow | LShift166                 | RShift | BitOr | BitXor | BitAnd | FloorDiv167168    unaryop = Invert | Not | UAdd | USub169170    cmpop = Eq | NotEq | Lt | LtE | Gt | GtE | Is | IsNot | In | NotIn171172    comprehension = (expr target, expr iter, expr* ifs)173174    excepthandler = ExceptHandler(expr? type, identifier? name, stmt* body)175                    attributes (int lineno, int col_offset)176177    arguments = (arg* args, arg? vararg, arg* kwonlyargs, expr* kw_defaults,178                 arg? kwarg, expr* defaults)179180    arg = (identifier arg, expr? annotation)181           attributes (int lineno, int col_offset)182183    -- keyword arguments supplied to call (NULL identifier for **kwargs)184    keyword = (identifier? arg, expr value)185186    -- import name with optional 'as' alias.187    alias = (identifier name, identifier? asname)188189    withitem = (expr context_expr, expr? optional_vars)190}191```192193## 32.2.3. [`ast`](https://python-all.ru/3.5/library/ast.html#module-ast) Вспомогательные функции194195Помимо классов узлов, модуль [`ast`](https://python-all.ru/3.5/library/ast.html#module-ast) определяет следующие служебные функции и классы для обхода абстрактных синтаксических деревьев:196197#### `ast.parse(source, filename='<unknown>', mode='exec')`198199Разбирает исходный код в узел AST. Эквивалентно `compile(source, filename, mode, ast.PyCF_ONLY_AST)`.200201#### `ast.literal_eval(node_or_string)`202203Безопасно вычисляет узел выражения или строку, содержащую литерал Python или отображение контейнера. Предоставленная строка или узел могут состоять только из следующих литеральных структур Python: строки, байты, числа, кортежи, списки, словари, множества, логические значения и `None`.204205Это можно использовать для безопасного вычисления строк, содержащих значения Python из ненадёжных источников, без необходимости разбирать значения самостоятельно. Он не способен вычислять произвольно сложные выражения, например с операторами или индексацией.206207Изменено в версии 3.2: Теперь допускает литералы байтов и множеств.208209#### `ast.get_docstring(node, clean=True)`210211Возвращает докстринг заданного узла *node* (который должен быть узлом `FunctionDef`, `ClassDef` или `Module`), или `None` если у него нет докстринга. Если *clean* истинно, очищает отступы докстринга с помощью [`inspect.cleandoc()`](https://python-all.ru/3.5/library/inspect.html#inspect.cleandoc).212213#### `ast.fix_missing_locations(node)`214215При компиляции дерева узлов с помощью [`compile()`](https://python-all.ru/3.5/library/functions.html#compile) компилятор ожидает атрибуты `lineno` и `col_offset` для каждого узла, который их поддерживает. Заполнять их вручную для сгенерированных узлов довольно утомительно, поэтому эта вспомогательная функция рекурсивно добавляет эти атрибуты, если их ещё нет, устанавливая их равными значениям родительского узла. Работает рекурсивно, начиная с *node*.216217#### `ast.increment_lineno(node, n=1)`218219Увеличить номер строки каждого узла в дереве, начиная с *node*, на *n*. Это полезно для «переноса кода» в другое место в файле.220221#### `ast.copy_location(new_node, old_node)`222223Скопировать местоположение в исходном коде (`lineno` и `col_offset`) из *old\_node* в *new\_node*, если возможно, и вернуть *new\_node*.224225#### `ast.iter_fields(node)`226227Генерирует кортеж из `(fieldname, value)` для каждого поля в `node._fields`, которое присутствует в *node*.228229#### `ast.iter_child_nodes(node)`230231Генерирует все непосредственные дочерние узлы *node*, то есть все поля, являющиеся узлами, и все элементы полей, являющихся списками узлов.232233#### `ast.walk(node)`234235Рекурсивно генерирует все узлы-потомки в дереве, начиная с *node* (включая сам *node*), в произвольном порядке. Это полезно, если требуется только изменить узлы на месте, а контекст не важен.236237#### `class ast.NodeVisitor`238239Базовый класс для обхода узлов, который обходит абстрактное синтаксическое дерево и вызывает функцию-посетитель для каждого найденного узла. Эта функция может вернуть значение, которое передаётся методом [`visit()`](https://python-all.ru/3.5/library/ast.html#ast.NodeVisitor.visit).240241Этот класс предназначен для наследования; в подклассе добавляются методы-посетители.242243#### `visit(node)`244245Посещает узел. Реализация по умолчанию вызывает метод `self.visit_classname`, где *classname* – имя класса узла, или [`generic_visit()`](https://python-all.ru/3.5/library/ast.html#ast.NodeVisitor.generic_visit), если такой метод отсутствует.246247#### `generic_visit(node)`248249Этот посетитель вызывает [`visit()`](https://python-all.ru/3.5/library/ast.html#ast.NodeVisitor.visit) для всех дочерних узлов.250251Обратите внимание, что дочерние узлы тех узлов, для которых определён собственный метод-посетитель, не будут посещены, если посетитель сам не вызовет [`generic_visit()`](https://python-all.ru/3.5/library/ast.html#ast.NodeVisitor.generic_visit) или не обойдёт их самостоятельно.252253Не используйте [`NodeVisitor`](https://python-all.ru/3.5/library/ast.html#ast.NodeVisitor), если требуется вносить изменения в узлы во время обхода. Для этого существует специальный посетитель ([`NodeTransformer`](https://python-all.ru/3.5/library/ast.html#ast.NodeTransformer)), который допускает модификации.254255#### `class ast.NodeTransformer`256257Подкласс [`NodeVisitor`](https://python-all.ru/3.5/library/ast.html#ast.NodeVisitor), который обходит абстрактное синтаксическое дерево и позволяет изменять узлы.258259Метод [`NodeTransformer`](https://python-all.ru/3.5/library/ast.html#ast.NodeTransformer) обходит AST и использует возвращаемое значение методов-посетителей для замены или удаления старого узла. Если возвращаемое значение метода-посетителя равно `None`, узел будет удалён из своего местоположения; в противном случае он заменяется возвращённым значением. Возвращённое значение может быть исходным узлом – в этом случае замена не происходит.260261Вот пример преобразователя, который переписывает все обращения к именам (`foo`) в `data['foo']`:262263```python264class RewriteName(NodeTransformer):265266    def visit_Name(self, node):267        return copy_location(Subscript(268            value=Name(id='data', ctx=Load()),269            slice=Index(value=Str(s=node.id)),270            ctx=node.ctx271        ), node)272```273274Имейте в виду: если у узла, с которым вы работаете, есть дочерние узлы, необходимо либо преобразовать дочерние узлы самостоятельно, либо сначала вызвать для узла метод `generic_visit()`.275276Для узлов, входящих в состав набора инструкций (это относится ко всем узлам инструкций), посетитель может также возвращать список узлов, а не один узел.277278Обычно преобразователь используется следующим образом:279280```python281node = YourTransformer().visit(node)282```283284#### `ast.dump(node, annotate_fields=True, include_attributes=False)`285286Возвращает форматированный дамп дерева в узле *node*. Это в основном полезно для целей отладки. Возвращаемая строка показывает имена и значения полей. Это делает код невычислимым, поэтому если требуется вычисление, *annotate\_fields* должно быть установлено в `False`. Атрибуты, такие как номера строк и смещения столбцов, по умолчанию не дампятся. Если это требуется, *include\_attributes* может быть установлено в `True`.287288> **См. также**289>290> [Green Tree Snakes](https://python-all.ru/3.5/library/ast.html) – внешний ресурс документации, содержащий подробную информацию о работе с AST Python.291