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

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

symtable.symtable(code, filename, compile_type)

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

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

class symtable.SymbolTable

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

get_type()

Возвращает тип таблицы символов. Возможные значения: 'class', 'module', 'function', 'annotation', 'TypeVar bound', 'type alias' и 'type parameter'. Последние четыре значения относятся к разным разновидностям областей видимости аннотаций.

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

get_id()

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

get_name()

Возвращает имя таблицы. Если таблица относится к классу, это имя класса; если к функции — имя функции; если таблица глобальная — 'top' (метод get_type() возвращает 'module'). Для областей видимости параметров типа (используемых для обобщённых классов, функций и псевдонимов типов) это имя соответствующего класса, функции или псевдонима типа. Для областей видимости псевдонимов типов это имя псевдонима типа. Для областей видимости ограничений TypeVar это имя TypeVar.

get_lineno()

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

is_optimized()

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

is_nested()

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

has_children()

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

get_identifiers()

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

lookup(name)

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

get_symbols()

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

get_children()

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

class symtable.Function

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

get_parameters()

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

get_locals()

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

get_globals()

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

get_nonlocals()

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

get_frees()

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

class symtable.Class

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

get_methods()

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

Здесь термин «метод» обозначает любую функцию, определённую в теле класса с помощью def или async def.

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

Например:

>>> 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, A.f всё равно считается функцией, подобной методу.

class symtable.Symbol

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

get_name()

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

is_referenced()

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

is_imported()

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

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, если связывание имени создаёт новое пространство имён.

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

Например:

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

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

get_namespaces()

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

get_namespace()

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