pyclbr — Поддержка обозревателя модулей Python

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

Модуль pyclbr предоставляет ограниченную информацию о функциях, классах и методах, определённых в модуле, написанном на Python. Информация достаточна для реализации обозревателя модулей. Информация извлекается из исходного кода Python, а не путём импорта модуля, поэтому данный модуль безопасно использовать с ненадежным кодом. Это ограничение делает невозможным использование данного модуля с модулями, не реализованными на Python, включая все стандартные и дополнительные модули расширения.

pyclbr.readmodule(module, path=None)

Возвращает словарь, сопоставляющий имена классов на уровне модуля их описателям. Если возможно, включаются описатели импортированных базовых классов. Параметр module — строка с именем модуля для чтения; это может быть имя модуля в пакете. Если указан, path — последовательность путей к каталогам, добавляемых перед sys.path, используемыми для поиска исходного кода модуля.

Эта функция является исходным интерфейсом и сохраняется только для обратной совместимости. Она возвращает отфильтрованную версию следующего.

pyclbr.readmodule_ex(module, path=None): Возвращает древовидную структуру на основе словаря, содержащую описатели функций или классов для каждой функции и класса, определённой в модуле с инструкцией def или class. Возвращаемый словарь сопоставляет имена функций и классов на уровне модуля их описателям. Вложенные объекты записываются в словарь children своего родителя. Как и в readmodule, module задаёт модуль для чтения, а path добавляется в sys.path. Если модуль, который читается, является пакетом, возвращаемый словарь имеет ключ '__path__', значение которого — список, содержащий путь поиска в пакете.

В версии 3.7: Описатели вложенных определений. К ним можно получить доступ через новое атрибут children. У каждого есть новый атрибут parent.

Описатели, возвращаемые этими функциями, являются экземплярами классов Function и Class. От пользователя не ожидается создание экземпляров этих классов.

Объекты функций

Экземпляры класса Function описывают функции, определённые инструкциями def. У них есть следующие атрибуты:

Function.file: Имя файла, в котором определена функция.

Function.module: Имя модуля, определяющего описываемую функцию.

Function.name: Имя функции.

Function.lineno: Номер строки в файле, где начинается определение.

Function.parent: Для функций верхнего уровня — None. Для вложенных функций — родитель.

В версии 3.7.

Function.children: Словарь, сопоставляющий имена описателям вложенных функций и классов.

В версии 3.7.

Объекты классов

Экземпляры класса Class описывают классы, определённые инструкциями class. У них те же атрибуты, что и у функций, плюс ещё два:

Class.file: Имя файла, в котором определён класс.

Class.module: Имя модуля, определяющего описываемый класс.

Class.name: Имя класса.

Class.lineno: Номер строки в файле, где начинается определение.

Class.parent: Для классов верхнего уровня — None. Для вложенных классов — родитель.

В версии 3.7.

Class.children: Словарь, сопоставляющий имена описателям вложенных функций и классов.

В версии 3.7.

Class.super: Список объектов Class, описывающих непосредственные базовые классы описываемого класса. Классы, которые указаны в качестве суперклассов, но которые не могут быть обнаружены функцией readmodule_ex(), перечисляются как строки с именем класса вместо объектов Class.

Class.methods: Словарь, сопоставляющий имена методов номерам строк. Это можно получить из нового словаря children, но он сохраняется для обратной совместимости.