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

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

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

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

symtable.symtable(code, filename, compile_type)

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

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

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, имя может быть также привязано к другим объектам, например, к int или списку, которые не создают нового пространства имен.

get_namespaces()

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

get_namespace()

Возвращает пространство имён, связанное с этим именем. Если привязано более одного пространства имён, поднимается ValueError.