`symtable.md`

277 строк · 14.4 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.16/library/symtable.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# `symtable` – доступ к таблицам символов компилятора89**Исходный код:** [Lib/symtable.py](https://python-all.ru/src/main/Lib/symtable.py)1011---1213Таблицы символов создаются компилятором из AST непосредственно перед генерацией байт-кода. Таблица символов отвечает за вычисление области видимости каждого идентификатора в коде. `symtable` предоставляет интерфейс для просмотра этих таблиц.1415## Генерация таблиц символов1617#### `symtable.symtable(code, filename, compile_type, *, module=None)`1819Возвращает верхнеуровневый [`SymbolTable`](https://python-all.ru/3.16/library/symtable.html#symtable.SymbolTable) для исходного кода Python *code*. *filename* – это имя файла, содержащего код. *compile\_type* – это как аргумент *mode* для [`compile()`](https://python-all.ru/3.16/library/functions.html#compile). Необязательный аргумент *module* задаёт имя модуля. Он нужен, чтобы однозначно [фильтровать](https://python-all.ru/3.16/library/warnings.html#warning-filter) предупреждения синтаксиса по имени модуля.2021Добавлено в версии 3.15: Добавлен параметр *module*.2223## Изучение таблиц символов2425#### `class symtable.SymbolTableType`2627Перечисление, указывающее тип объекта [`SymbolTable`](https://python-all.ru/3.16/library/symtable.html#symtable.SymbolTable).2829#### `MODULE = "module"`3031Используется для таблицы символов модуля.3233#### `FUNCTION = "function"`3435Используется для таблицы символов функции.3637#### `CLASS = "class"`3839Используется для таблицы символов класса.4041Следующие элементы относятся к разным видам [областей видимости аннотаций](https://python-all.ru/3.16/reference/executionmodel.html#annotation-scopes).4243#### `ANNOTATION = "annotation"`4445Используется для аннотаций, если активно `from __future__ import annotations`.4647#### `TYPE_ALIAS = "type alias"`4849Используется для таблицы символов конструкций [`type`](https://python-all.ru/3.16/reference/simple_stmts.html#type).5051#### `TYPE_PARAMETERS = "type parameters"`5253Используется для таблицы символов [обобщённых функций](https://python-all.ru/3.16/reference/compound_stmts.html#generic-functions) или [обобщённых классов](https://python-all.ru/3.16/reference/compound_stmts.html#generic-classes).5455#### `TYPE_VARIABLE = "type variable"`5657Используется для таблицы символов границы, кортежа ограничений или значения по умолчанию отдельной переменной типа в формальном смысле, т.е. объекта TypeVar, TypeVarTuple или ParamSpec (последние два не поддерживают границу или кортеж ограничений).5859Добавлено в версии 3.13.6061#### `class symtable.SymbolTable`6263Таблица пространства имён для блока. Конструктор не является открытым.6465#### `get_type()`6667Возвращает тип таблицы символов. Возможные значения – элементы перечисления [`SymbolTableType`](https://python-all.ru/3.16/library/symtable.html#symtable.SymbolTableType).6869Изменено в версии 3.12: Добавлены `'annotation'`, `'TypeVar bound'`, `'type alias'` и `'type parameter'` в качестве возможных возвращаемых значений.7071Изменено в версии 3.13: Возвращаемые значения – элементы перечисления [`SymbolTableType`](https://python-all.ru/3.16/library/symtable.html#symtable.SymbolTableType).7273Точные значения возвращаемой строки могут измениться в будущем, поэтому рекомендуется использовать элементы [`SymbolTableType`](https://python-all.ru/3.16/library/symtable.html#symtable.SymbolTableType) вместо жёстко заданных строк.7475#### `get_id()`7677Возвращает идентификатор таблицы.7879#### `get_name()`8081Возвращает имя таблицы. Это имя класса, если таблица предназначена для класса, имя функции, если таблица для функции, или `'top'`, если таблица глобальная ([`get_type()`](https://python-all.ru/3.16/library/symtable.html#symtable.SymbolTable.get_type) возвращает `'module'`). Для областей видимости параметров типа (используются для обобщённых классов, функций и псевдонимов типов) это имя базового класса, функции или псевдонима типа. Для областей видимости псевдонимов типов это имя псевдонима типа. Для областей видимости, привязанных к [`TypeVar`](https://python-all.ru/3.16/library/typing.html#typing.TypeVar), это имя `TypeVar`.8283#### `get_lineno()`8485Возвращает номер первой строки в блоке, который представляет эта таблица.8687#### `is_optimized()`8889Возвращает `True`, если локальные переменные в этой таблице можно оптимизировать.9091#### `is_nested()`9293Возвращает `True`, если блок является вложенным классом или функцией.9495#### `has_children()`9697Возвращает `True`, если блок содержит вложенные пространства имён. Их можно получить с помощью [`get_children()`](https://python-all.ru/3.16/library/symtable.html#symtable.SymbolTable.get_children).9899#### `get_identifiers()`100101Возвращает объект представления, содержащий имена символов в таблице. См. [документацию по объектам представления](https://python-all.ru/3.16/library/stdtypes.html#dict-views).102103#### `lookup(name)`104105Выполняет поиск *name* в таблице и возвращает экземпляр [`Symbol`](https://python-all.ru/3.16/library/symtable.html#symtable.Symbol).106107#### `get_symbols()`108109Возвращает список экземпляров [`Symbol`](https://python-all.ru/3.16/library/symtable.html#symtable.Symbol) для имён в таблице.110111#### `get_children()`112113Возвращает список вложенных таблиц символов.114115#### `class symtable.Function`116117Пространство имён для функции или метода. Этот класс наследует от [`SymbolTable`](https://python-all.ru/3.16/library/symtable.html#symtable.SymbolTable).118119#### `get_parameters()`120121Возвращает кортеж, содержащий имена параметров этой функции.122123#### `get_locals()`124125Возвращает кортеж с именами локальных переменных этой функции.126127#### `get_globals()`128129Возвращает кортеж с именами глобальных переменных этой функции.130131#### `get_nonlocals()`132133Возвращает кортеж с именами явно объявленных нелокальных переменных этой функции.134135#### `get_frees()`136137Возвращает кортеж с именами [свободных (замыкающих) переменных](https://python-all.ru/3.16/glossary.html#term-closure-variable) в этой функции.138139#### `get_cells()`140141Возвращает кортеж, содержащий имена [переменных-ячеек](https://python-all.ru/3.16/glossary.html#term-closure-variable) в этой таблице.142143Добавлено в версии 3.15.144145#### `class symtable.Class`146147Пространство имён класса. Этот класс наследует от [`SymbolTable`](https://python-all.ru/3.16/library/symtable.html#symtable.SymbolTable).148149#### `class symtable.Symbol`150151Запись в [`SymbolTable`](https://python-all.ru/3.16/library/symtable.html#symtable.SymbolTable), соответствующая идентификатору в исходном коде. Конструктор не является публичным.152153#### `get_name()`154155Возвращает имя символа.156157#### `is_referenced()`158159Возвращает `True`, если символ используется в своём блоке.160161#### `is_imported()`162163Возвращает `True`, если символ создан оператором import.164165#### `is_parameter()`166167Возвращает `True`, если символ является параметром.168169#### `is_type_parameter()`170171Возвращает `True`, если символ является параметром типа.172173Добавлено в версии 3.14.174175#### `is_global()`176177Возвращает `True`, если символ является глобальным.178179#### `is_nonlocal()`180181Возвращает `True`, если символ является нелокальным.182183#### `is_declared_global()`184185Возвращает `True`, если символ объявлен глобальным с помощью инструкции global.186187#### `is_local()`188189Возвращает `True`, если символ является локальным для своего блока.190191#### `is_annotated()`192193Возвращает `True`, если символ аннотирован.194195Добавлено в версии 3.6.196197#### `is_free()`198199Возвращает `True`, если символ используется (на него ссылаются) в своём блоке, но не присваивается ему.200201#### `is_cell()`202203Возвращает `True`, если на символ есть ссылка, но не присваивается во вложенном блоке.204205Добавлено в версии 3.15.206207#### `is_free_class()`208209Возвращает *True*, если символ в области видимости класса является свободным с точки зрения метода.210211Рассмотрим следующий пример:212213```python214def f():215    x = 1  # область видимости функции216    class C:217        x = 2  # область видимости класса218        def method(self):219            return x220```221222В этом примере символ в области видимости класса `x` считается свободным с точки зрения `C.method`, что позволяет последнему возвращать *1* во время выполнения, а не *2*.223224Добавлено в версии 3.14.225226#### `is_assigned()`227228Возвращает `True`, если символу присваивается значение в его блоке.229230#### `is_comp_iter()`231232Возвращает `True`, если символ является переменной итерации в генераторном выражении.233234Добавлено в версии 3.14.235236#### `is_comp_cell()`237238Возвращает `True`, если символ является ячейкой во встроенном генераторном выражении.239240Добавлено в версии 3.14.241242#### `is_namespace()`243244Возвращает `True`, если связывание имени вводит новое пространство имён.245246Если имя используется как цель в инструкции функции или класса, это будет истинно.247248Например:249250```python251>>> table = symtable.symtable("def some_func(): pass", "string", "exec")252>>> table.lookup("some_func").is_namespace()253True254```255256Обратите внимание, что одно имя может быть связано с несколькими объектами. Если результат равен `True`, имя также может быть связано с другими объектами, такими как int или list, которые не вводят новое пространство имён.257258#### `get_namespaces()`259260Возвращает список пространств имён, связанных с этим именем.261262#### `get_namespace()`263264Возвращает пространство имён, связанное с этим именем. Если с этим именем связано более одного пространства имён или ни одного, вызывается [`ValueError`](https://python-all.ru/3.16/library/exceptions.html#ValueError).265266## Использование командной строки267268Добавлено в версии 3.13.269270Модуль `symtable` можно запускать как скрипт из командной строки.271272```sh273python -m symtable [infile...]274```275276Таблицы символов создаются для указанных исходных файлов Python и выводятся в stdout. Если входной файл не указан, содержимое читается из stdin.277