symtable — Доступ к таблицам символов компилятора

Исходный код: Lib/symtable.py

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

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

symtable.symtable(code, filename, compile_type): Возвращает корневую SymbolTable для Python-кода code. filename — имя файла, содержащего код. compile_type подобен аргументу mode функции compile().

Просмотр таблиц символов

class symtable.SymbolTable

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

get_type(): Возвращает тип таблицы символов. Возможные значения — 'class', 'module', и 'function'.

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

get_name(): Возвращает имя таблицы. Это имя класса, если таблица относится к классу, имя функции, если таблица относится к функции, или 'top', если таблица глобальная (get_type() возвращает 'module').

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

is_optimized(): Возвращает True, если локальные переменные в этой таблице могут быть оптимизированы.

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

has_children(): Возвращает True, если блок имеет вложенные пространства имен. Их можно получить с помощью get_children().

has_exec(): Возвращает True, если блок использует exec.

get_identifiers(): Возвращает список имён символов в этой таблице.

lookup(name): Ищет name в таблице и возвращает экземпляр Symbol.

get_symbols(): Возвращает список экземпляров Symbol для имён в таблице.

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

class symtable.Function

Пространство имён для функции или метода. Этот класс наследует SymbolTable.

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

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

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

get_frees(): Возвращает кортеж, содержащий имена свободных переменных в этой функции.

class symtable.Class

Пространство имён класса. Этот класс наследует SymbolTable.

get_methods(): Возвращает кортеж, содержащий имена методов, объявленных в классе.

class symtable.Symbol

Элемент в SymbolTable, соответствующий идентификатору в исходном коде. Конструктор не является публичным.

get_name(): Возвращает имя символа.

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

is_imported(): Возвращает True, если символ создан из инструкции import.

is_parameter(): Возвращает True, если символ является параметром.

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

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

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

is_free(): Возвращает True, если символ используется в своём блоке, но ему не присваивается значение.

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

is_namespace()

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

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

Например:

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

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

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

get_namespace(): Возвращает пространство имён, привязанное к этому имени. Если привязано более одного пространства имён, возбуждается ValueError.