> **Источник:** https://python-all.ru/3.13/library/symtable.html
>
> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.

---

# `symtable` – доступ к таблицам символов компилятора

**Исходный код:** [Lib/symtable.py](https://python-all.ru/src/3.13/Lib/symtable.py)

---

Таблицы символов создаются компилятором из AST непосредственно перед генерацией байт-кода. Таблица символов отвечает за вычисление области видимости каждого идентификатора в коде. `symtable` предоставляет интерфейс для просмотра этих таблиц.

## Генерация таблиц символов

#### `symtable.symtable(code, filename, compile_type)`

Возвращает корневую [`SymbolTable`](https://python-all.ru/3.13/library/symtable.html#symtable.SymbolTable) для исходного кода Python *code*. *filename* – имя файла, содержащего код. *compile\_type* аналогичен аргументу *mode* функции [`compile()`](https://python-all.ru/3.13/library/functions.html#compile).

## Изучение таблиц символов

#### `class symtable.SymbolTableType`

Перечисление, указывающее тип объекта [`SymbolTable`](https://python-all.ru/3.13/library/symtable.html#symtable.SymbolTable).

#### `MODULE = "module"`

Используется для таблицы символов модуля.

#### `FUNCTION = "function"`

Используется для таблицы символов функции.

#### `CLASS = "class"`

Используется для таблицы символов класса.

Следующие элементы относятся к разным видам [областей видимости аннотаций](https://python-all.ru/3.13/reference/executionmodel.html#annotation-scopes).

#### `ANNOTATION = "annotation"`

Используется для аннотаций, если активно `from __future__ import annotations`.

#### `TYPE_ALIAS = "type alias"`

Используется для таблицы символов конструкций [`type`](https://python-all.ru/3.13/reference/simple_stmts.html#type).

#### `TYPE_PARAMETERS = "type parameters"`

Используется для таблицы символов [обобщённых функций](https://python-all.ru/3.13/reference/compound_stmts.html#generic-functions) или [обобщённых классов](https://python-all.ru/3.13/reference/compound_stmts.html#generic-classes).

#### `TYPE_VARIABLE = "type variable"`

Используется для таблицы символов границы, кортежа ограничений или значения по умолчанию отдельной переменной типа в формальном смысле, т.е. объекта TypeVar, TypeVarTuple или ParamSpec (последние два не поддерживают границу или кортеж ограничений).

Добавлено в версии 3.13.

#### `class symtable.SymbolTable`

Таблица пространства имён для блока. Конструктор не является открытым.

#### `get_type()`

Возвращает тип таблицы символов. Возможные значения – элементы перечисления [`SymbolTableType`](https://python-all.ru/3.13/library/symtable.html#symtable.SymbolTableType).

Изменено в версии 3.12: Добавлены `'annotation'`, `'TypeVar bound'`, `'type alias'` и `'type parameter'` в качестве возможных возвращаемых значений.

Изменено в версии 3.13: Возвращаемые значения – элементы перечисления [`SymbolTableType`](https://python-all.ru/3.13/library/symtable.html#symtable.SymbolTableType).

Точные значения возвращаемой строки могут измениться в будущем, поэтому рекомендуется использовать элементы [`SymbolTableType`](https://python-all.ru/3.13/library/symtable.html#symtable.SymbolTableType) вместо жёстко заданных строк.

#### `get_id()`

Возвращает идентификатор таблицы.

#### `get_name()`

Возвращает имя таблицы. Это имя класса, если таблица предназначена для класса, имя функции, если таблица для функции, или `'top'`, если таблица глобальная ([`get_type()`](https://python-all.ru/3.13/library/symtable.html#symtable.SymbolTable.get_type) возвращает `'module'`). Для областей видимости параметров типа (используются для обобщённых классов, функций и псевдонимов типов) это имя базового класса, функции или псевдонима типа. Для областей видимости псевдонимов типов это имя псевдонима типа. Для областей видимости, привязанных к [`TypeVar`](https://python-all.ru/3.13/library/typing.html#typing.TypeVar), это имя `TypeVar`.

#### `get_lineno()`

Возвращает номер первой строки в блоке, который представляет эта таблица.

#### `is_optimized()`

Возвращает `True`, если локальные переменные в этой таблице можно оптимизировать.

#### `is_nested()`

Возвращает `True`, если блок является вложенным классом или функцией.

#### `has_children()`

Возвращает `True`, если блок содержит вложенные пространства имён. Их можно получить с помощью [`get_children()`](https://python-all.ru/3.13/library/symtable.html#symtable.SymbolTable.get_children).

#### `get_identifiers()`

Возвращает объект представления, содержащий имена символов в таблице. См. [документацию по объектам представления](https://python-all.ru/3.13/library/stdtypes.html#dict-views).

#### `lookup(name)`

Выполняет поиск *name* в таблице и возвращает экземпляр [`Symbol`](https://python-all.ru/3.13/library/symtable.html#symtable.Symbol).

#### `get_symbols()`

Возвращает список экземпляров [`Symbol`](https://python-all.ru/3.13/library/symtable.html#symtable.Symbol) для имён в таблице.

#### `get_children()`

Возвращает список вложенных таблиц символов.

#### `class symtable.Function`

Пространство имён для функции или метода. Этот класс наследует от [`SymbolTable`](https://python-all.ru/3.13/library/symtable.html#symtable.SymbolTable).

#### `get_parameters()`

Возвращает кортеж, содержащий имена параметров этой функции.

#### `get_locals()`

Возвращает кортеж с именами локальных переменных этой функции.

#### `get_globals()`

Возвращает кортеж с именами глобальных переменных этой функции.

#### `get_nonlocals()`

Возвращает кортеж с именами явно объявленных нелокальных переменных этой функции.

#### `get_frees()`

Возвращает кортеж с именами [свободных (замыкающих) переменных](https://python-all.ru/3.13/glossary.html#term-closure-variable) в этой функции.

#### `class symtable.Class`

Пространство имён класса. Этот класс наследует от [`SymbolTable`](https://python-all.ru/3.13/library/symtable.html#symtable.SymbolTable).

#### `get_methods()`

Возвращает кортеж, содержащий имена функций, похожих на методы, объявленных в классе.

Здесь термин «метод» обозначает *любую* функцию, определённую в теле класса с помощью [`def`](https://python-all.ru/3.13/reference/compound_stmts.html#def) или [`async def`](https://python-all.ru/3.13/reference/compound_stmts.html#async-def).

Функции, определённые в более глубокой области видимости (например, во внутреннем классе), не обнаруживаются с помощью `get_methods()`.

Например:

```python
>>> import symtable
>>> st = symtable.symtable('''
... def outer(): pass
...
... class A:
...    def f():
...        def w(): pass
...
...    def g(self): pass
...
...    @classmethod
...    async def h(cls): pass
...
...    global outer
...    def outer(self): pass
... ''', 'test', 'exec')
>>> class_A = st.get_children()[1]
>>> class_A.get_methods()
('f', 'g', 'h')
```

Хотя `A().f()` вызывает [`TypeError`](https://python-all.ru/3.13/library/exceptions.html#TypeError) во время выполнения, `A.f` по-прежнему считается методоподобной функцией.

#### `class symtable.Symbol`

Запись в [`SymbolTable`](https://python-all.ru/3.13/library/symtable.html#symtable.SymbolTable), соответствующая идентификатору в исходном коде. Конструктор не является публичным.

#### `get_name()`

Возвращает имя символа.

#### `is_referenced()`

Возвращает `True`, если символ используется в своём блоке.

#### `is_imported()`

Возвращает `True`, если символ создан оператором import.

#### `is_parameter()`

Возвращает `True`, если символ является параметром.

#### `is_global()`

Возвращает `True`, если символ является глобальным.

#### `is_nonlocal()`

Возвращает `True`, если символ является нелокальным.

#### `is_declared_global()`

Возвращает `True`, если символ объявлен глобальным с помощью инструкции global.

#### `is_local()`

Возвращает `True`, если символ является локальным для своего блока.

#### `is_annotated()`

Возвращает `True`, если символ аннотирован.

Добавлено в версии 3.6.

#### `is_free()`

Возвращает `True`, если символ используется (на него ссылаются) в своём блоке, но не присваивается ему.

#### `is_assigned()`

Возвращает `True`, если символу присваивается значение в его блоке.

#### `is_namespace()`

Возвращает `True`, если связывание имени вводит новое пространство имён.

Если имя используется как цель в инструкции функции или класса, это будет истинно.

Например:

```python
>>> table = symtable.symtable("def some_func(): pass", "string", "exec")
>>> table.lookup("some_func").is_namespace()
True
```

Обратите внимание, что одно имя может быть связано с несколькими объектами. Если результат равен `True`, имя также может быть связано с другими объектами, такими как int или list, которые не вводят новое пространство имён.

#### `get_namespaces()`

Возвращает список пространств имён, связанных с этим именем.

#### `get_namespace()`

Возвращает пространство имён, связанное с этим именем. Если с этим именем связано более одного пространства имён или ни одного, вызывается [`ValueError`](https://python-all.ru/3.13/library/exceptions.html#ValueError).

## Использование командной строки

Добавлено в версии 3.13.

Модуль `symtable` можно запускать как скрипт из командной строки.

```sh
python -m symtable [infile...]
```

Таблицы символов создаются для указанных исходных файлов Python и выводятся в stdout. Если входной файл не указан, содержимое читается из stdin.
