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

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

symtable.symtable(code, filename, compile_type)

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

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

class symtable.SymbolTableType

Перечисление, указывающее тип объекта SymbolTable.

MODULE = "module"

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

FUNCTION = "function"

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

CLASS = "class"

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

Следующие члены относятся к различным вариантам областей видимости аннотаций.

ANNOTATION = "annotation"

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

TYPE_ALIAS = "type alias"

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

TYPE_PARAMETERS = "type parameters"

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

TYPE_VARIABLE = "type variable"

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

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

class symtable.SymbolTable

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

get_type()

Возвращает тип таблицы символов. Возможные значения — члены перечисления SymbolTableType.

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

Изменено в версии 3.13: Значения возврата являются членами перечисления SymbolTableType.

Точные значения возвращаемой строки могут измениться в будущем, поэтому рекомендуется использовать члены SymbolTableType вместо жёстко заданных строк.

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.

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

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

python -m symtable [infile...]

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