29.12. inspect – Инспекция активных объектов¶inspect – Inspect live objects

29.12.1. Типы и члены¶Types and members

Функция getmembers() извлекает члены объекта, такого как класс или модуль. Шестнадцать функций, имена которых начинаются с «is», в основном предоставляются как удобные варианты для второго аргумента getmembers(). Они также помогают определить, когда можно ожидать следующие специальные атрибуты:

inspect.getmembers(object[, predicate])¶

Возвращает все члены объекта в виде списка пар (имя, значение), отсортированных по имени. Если передан необязательный аргумент predicate, включаются только те члены, для которых предикат возвращает истинное значение.

Примечание

getmembers() возвращает только атрибуты класса, определённые в метаклассе, если аргумент – класс и эти атрибуты перечислены в пользовательском __dir__() метакласса.

inspect.getmoduleinfo(path)¶

Возвращает именованный кортеж ModuleInfo(name, suffix, mode, module_type) со значениями, описывающими, как Python будет интерпретировать файл по path, если это модуль, или None, если он не идентифицируется как модуль. В этом кортеже name – имя модуля без имени оборачивающего пакета, suffix – конечная часть имени файла (которая может быть не расширением, отделённым точкой), mode – режим open(), который будет использован ('r' или 'rb'), а module_type – целое число, представляющее тип модуля. module_type будет иметь значение, которое можно сравнить с константами, определёнными в модуле imp; подробнее о типах модулей см. документацию этого модуля.

Устарело с версии 3.3: Можно проверить суффикс пути к файлу среди поддерживаемых суффиксов, перечисленных в importlib.machinery, чтобы вывести ту же информацию.

inspect.getmodulename(path)¶

Возвращает имя модуля, задаваемое файлом path, без имён оборачивающих пакетов. Расширение файла проверяется по всем записям из importlib.machinery.all_suffixes(). Если совпадение найдено, возвращается последний компонент пути с удалённым расширением. В противном случае возвращается None.

Note that this function only returns a meaningful name for actual Python modules - paths that potentially refer to Python packages will still return None.

Изменено в версии 3.3: Эта функция теперь напрямую основана на importlib, а не на устаревшей getmoduleinfo().

inspect.ismodule(object)¶

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

inspect.isclass(object)¶

Возвращает True, если объект является классом, встроенным или созданным в коде Python.

inspect.ismethod(object)¶

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

inspect.isfunction(object)¶

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

inspect.isgeneratorfunction(object)¶

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

inspect.isgenerator(object)¶

Возвращает True, если объект является генератором.

inspect.istraceback(object)¶

Возвращает True, если объект является трассировкой.

inspect.isframe(object)¶

Возвращает True, если объект является фреймом.

inspect.iscode(object)¶

Возвращает True, если объект является кодом.

inspect.isbuiltin(object)¶

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

inspect.isroutine(object)¶

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

inspect.isabstract(object)¶

Возвращает True, если объект является абстрактным базовым классом.

inspect.ismethoddescriptor(object)¶

Возвращает true, если объект является дескриптором метода, но не если ismethod(), isclass(), isfunction() или isbuiltin() возвращают true.

Например, это верно для int.__add__. Объект, прошедший этот тест, имеет атрибут __get__, но не __set__; однако помимо этого набор атрибутов варьируется. __name__ обычно разумен, и __doc__ тоже часто.

Методы, реализованные через дескрипторы и также проходящие один из других тестов, возвращают false для теста ismethoddescriptor() просто потому, что другие тесты обещают больше – например, можно рассчитывать на наличие атрибута __func__ (и т.д.), когда объект проходит ismethod().

inspect.isdatadescriptor(object)¶

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

Дескрипторы данных имеют как атрибут __get__, так и атрибут __set__. Примеры: свойства (определяемые в Python), getsets и members. Последние два определены в C, и для этих типов существуют более специфичные тесты, что надёжно для разных реализаций Python. Обычно дескрипторы данных также имеют атрибуты __name__ и __doc__ (свойства, getsets и members имеют оба этих атрибута), но это не гарантировано.

inspect.isgetsetdescriptor(object)¶

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

Особенности реализации CPython: getsets – это атрибуты, определённые в модулях расширения через структуры PyGetSetDef. Для реализаций Python без таких типов этот метод всегда возвращает False.

inspect.ismemberdescriptor(object)¶

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

Особенность реализации CPython: Дескрипторы членов – это атрибуты, определяемые в модулях расширения через структуры PyMemberDef. Для реализаций Python без таких типов этот метод всегда возвращает False.

29.12.2. Получение исходного кода¶Retrieving source code

inspect.getdoc(object)¶

Возвращает строку документации объекта, очищенную с помощью cleandoc().

inspect.getcomments(object)¶

Возвращает единой строкой все строки комментариев, непосредственно предшествующие исходному коду объекта (для класса, функции или метода) или находящиеся в начале исходного файла Python (если объект – модуль).

inspect.getfile(object)¶

Возвращает имя (текстового или бинарного) файла, в котором определён объект. Это вызовет TypeError, если объект является встроенным модулем, классом или функцией.

inspect.getmodule(object)¶

Пытается определить модуль, в котором был определён объект.

inspect.getsourcefile(object)¶

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

inspect.getsourcelines(object)¶

Возвращает список строк исходного кода и номер начальной строки для объекта. Аргументом может быть модуль, класс, метод, функция, traceback, frame или code object. Исходный код возвращается в виде списка строк, соответствующих объекту, а номер строки указывает, где в исходном файле находится первая строка кода. Если исходный код не удаётся получить, возбуждается OSError.

Изменено в версии 3.3: OSError возбуждается вместо IOError, который теперь является его псевдонимом.

inspect.getsource(object)¶

Возвращает текст исходного кода объекта. Аргументом может быть модуль, класс, метод, функция, traceback, frame или code object. Исходный код возвращается в виде одной строки. Если исходный код не удаётся получить, возбуждается OSError.

Изменено в версии 3.3: OSError возбуждается вместо IOError, который теперь является его псевдонимом.

inspect.cleandoc(doc)¶

Убирает отступы из строк документации, которые добавлены для выравнивания с блоками кода. Удаляются все пробельные символы, которые можно равномерно убрать, начиная со второй строки. Также все табуляции заменяются пробелами.

29.12.3. Интроспекция вызываемых объектов с помощью объекта Signature¶Introspecting callables with the Signature object

Объект Signature представляет сигнатуру вызова вызываемого объекта и его аннотацию возврата. Чтобы получить объект Signature, используйте функцию signature().

inspect.signature(callable)¶

Возвращает объект Signature для заданного callable:

>>> from inspect import signature
>>> def foo(a, *, b:int, **kwargs):
...     pass

>>> sig = signature(foo)

>>> str(sig)
'(a, *, b:int, **kwargs)'

>>> str(sig.parameters['b'])
'b:int'

>>> sig.parameters['b'].annotation
<class 'int'>

Принимает широкий спектр вызываемых объектов Python: от обычных функций и классов до объектов functools.partial().

Возбуждает ValueError, если сигнатуру невозможно предоставить, и TypeError, если такой тип объекта не поддерживается.

Примечание

Некоторые вызываемые объекты могут быть недоступны для интроспекции в определённых реализациях Python. Например, в CPython некоторые встроенные функции, определённые на C, не предоставляют метаданных о своих аргументах.

class inspect.Signature(parameters=None, *, return_annotation=Signature.empty)¶

Объект Signature представляет сигнатуру вызова функции и её аннотацию возврата. Для каждого параметра, принимаемого функцией, он хранит объект Parameter в своей коллекции parameters.

Необязательный аргумент parameters представляет собой последовательность объектов Parameter, которая проверяется: в ней не должно быть параметров с дублирующимися именами, параметры должны быть в правильном порядке (сначала только позиционные, затем позиционно-ключевые), а параметры со значениями по умолчанию должны следовать после параметров без них.

Необязательный аргумент return_annotation может быть произвольным объектом Python и является аннотацией возвращаемого значения вызываемого объекта.

Объекты Signature являются неизменяемыми. Используйте Signature.replace(), чтобы создать изменённую копию.

empty¶

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

parameters¶

Упорядоченное отображение имён параметров на соответствующие объекты Parameter.

return_annotation¶

Аннотация возврата для вызываемого объекта. Если у вызываемого объекта нет аннотации возврата, этот атрибут устанавливается в Signature.empty.

bind(*args, **kwargs)¶

Создаёт отображение позиционных и именованных аргументов на параметры. Возвращает BoundArguments, если *args и **kwargs соответствуют сигнатуре, или вызывает исключение TypeError.

bind_partial(*args, **kwargs)¶

Работает так же, как Signature.bind(), но допускает пропуск некоторых обязательных аргументов (имитирует поведение functools.partial()). Возвращает BoundArguments или вызывает исключение TypeError, если переданные аргументы не соответствуют сигнатуре.

replace(*[, parameters][, return_annotation])¶

Создаёт новый экземпляр Signature на основе экземпляра, для которого был вызван replace. Можно передать другие parameters и/или return_annotation, чтобы переопределить соответствующие свойства базовой сигнатуры. Чтобы удалить return_annotation из скопированной Signature, передайте Signature.empty.

>>> def test(a, b):
...     pass
>>> sig = signature(test)
>>> new_sig = sig.replace(return_annotation="new return anno")
>>> str(new_sig)
"(a, b) -> 'new return anno'"

class inspect.Parameter(name, kind, *, default=Parameter.empty, annotation=Parameter.empty)¶

Объекты Parameter являются неизменяемыми. Вместо изменения объекта Parameter можно использовать Parameter.replace() для создания изменённой копии.

empty¶

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

name¶

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

default¶

Значение по умолчанию для параметра. Если у параметра нет значения по умолчанию, этот атрибут устанавливается в Parameter.empty.

annotation¶

Аннотация для параметра. Если у параметра нет аннотации, этот атрибут устанавливается в Parameter.empty.

kind¶

Описывает, как значения аргументов привязываются к параметру. Возможные значения (доступны через Parameter, например Parameter.KEYWORD_ONLY):

Имя	Значение
POSITIONAL_ONLY	Значение должно передаваться как позиционный аргумент. В Python нет явного синтаксиса для определения только позиционных параметров, но многие встроенные функции и функции модулей расширения (особенно те, что принимают только один или два параметра) их поддерживают.
POSITIONAL_OR_KEYWORD	Значение может передаваться как ключевой, так и позиционный аргумент (это стандартное поведение привязки для функций, реализованных на Python).
VAR_POSITIONAL	Кортеж позиционных аргументов, которые не привязаны ни к одному другому параметру. Это соответствует параметру *args в определении функции Python.
KEYWORD_ONLY	Значение должно быть передано как именованный аргумент. Параметры, доступные только по ключу, – это те, которые следуют после записи * или *args в определении функции Python.
VAR_KEYWORD	Словарь именованных аргументов, которые не привязаны ни к одному другому параметру. Это соответствует параметру **kwargs в определении функции Python.

Пример: вывод всех аргументов только для ключевой передачи без значений по умолчанию:

>>> def foo(a, b, *, c, d=10):
...     pass

>>> sig = signature(foo)
>>> for param in sig.parameters.values():
...     if (param.kind == param.KEYWORD_ONLY and
...                        param.default is param.empty):
...         print('Parameter:', param)
Parameter: c

replace(*[, name][, kind][, default][, annotation])¶

Создаёт новый экземпляр Parameter на основе экземпляра, на котором был вызван метод replace. Чтобы переопределить атрибут Parameter, передайте соответствующий аргумент. Чтобы удалить значение по умолчанию и/или аннотацию из параметра, передайте Parameter.empty.

>>> from inspect import Parameter
>>> param = Parameter('foo', Parameter.KEYWORD_ONLY, default=42)
>>> str(param)
'foo=42'

>>> str(param.replace()) # Создаст поверхностную копию 'param'
'foo=42'

>>> str(param.replace(default=Parameter.empty, annotation='spam'))
"foo:'spam'"

Изменено в версии 3.4: В Python 3.3 объектам Parameter разрешалось иметь name установленным в None, если их kind был установлен в POSITIONAL_ONLY. Это больше не разрешается.

class inspect.BoundArguments¶

Результат вызова Signature.bind() или Signature.bind_partial(). Содержит отображение аргументов на параметры функции.

arguments¶

Упорядоченное изменяемое отображение (collections.OrderedDict) имён параметров на значения аргументов. Содержит только явно связанные аргументы. Изменения в arguments отразятся в args и kwargs.

Следует использовать вместе с Signature.parameters для любых целей обработки аргументов.

Примечание

Аргументы, для которых Signature.bind() или Signature.bind_partial() полагались на значение по умолчанию, пропускаются. Однако при необходимости их легко включить.

>>> def foo(a, b=10):
...     pass

>>> sig = signature(foo)
>>> ba = sig.bind(5)

>>> ba.args, ba.kwargs
((5,), {})

>>> for param in sig.parameters.values():
...     if (param.name not in ba.arguments
...             and param.default is not param.empty):
...         ba.arguments[param.name] = param.default

>>> ba.args, ba.kwargs
((5, 10), {})

args¶

Кортеж значений позиционных аргументов. Вычисляется динамически из атрибута arguments.

kwargs¶

Словарь значений именованных аргументов. Вычисляется динамически из атрибута arguments.

signature¶

Ссылка на родительский объект Signature.

Свойства args и kwargs можно использовать для вызова функций:

def test(a, *, b):
   ...

sig = signature(test)
ba = sig.bind(10, b=20)
test(*ba.args, **ba.kwargs)

29.12.4. Классы и функции¶Classes and functions

inspect.getclasstree(classes, unique=False)¶

Упорядочивает заданный список классов в иерархию вложенных списков. Если встречается вложенный список, он содержит классы, унаследованные от класса, запись которого непосредственно предшествует этому списку. Каждая запись представляет собой кортеж из двух элементов, содержащий класс и кортеж его базовых классов. Если аргумент unique равен true, в возвращаемой структуре появляется ровно одна запись для каждого класса из заданного списка. В противном случае классы, использующие множественное наследование, и их потомки будут появляться несколько раз.

inspect.getargspec(func)¶

Получает имена и значения по умолчанию аргументов функции Python. Возвращается именованный кортеж ArgSpec(args, varargs, keywords, defaults). args – список имён аргументов. varargs и keywords – имена аргументов * и ** или None. defaults – кортеж значений по умолчанию аргументов или None, если аргументов по умолчанию нет; если этот кортеж содержит n элементов, они соответствуют последним n элементам, перечисленным в args.

Устарело с версии 3.0: Вместо этого используйте getfullargspec(), который предоставляет информацию об именованных аргументах (keyword-only) и аннотациях.

inspect.getfullargspec(func)¶

Возвращает имена и значения по умолчанию аргументов функции Python. Возвращается именованный кортеж:

FullArgSpec(args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, annotations)

args – список имён аргументов. varargs и varkw – имена аргументов * и ** или None. defaults – n-кортеж значений по умолчанию последних n аргументов, или None, если аргументов по умолчанию нет. kwonlyargs – список имён именованных аргументов (keyword-only). kwonlydefaults – словарь, отображающий имена из kwonlyargs в значения по умолчанию. annotations – словарь, отображающий имена аргументов в аннотации.

Первые четыре элемента в кортеже соответствуют getargspec().

Примечание

Рекомендуется использовать новый интерфейс объекта Signature, который предоставляет лучший способ интроспекции функций.

Изменено в версии 3.4: Эта функция теперь основана на signature(), но по-прежнему игнорирует атрибуты __wrapped__ и включает уже привязанный первый параметр в вывод сигнатуры для привязанных методов.

inspect.getargvalues(frame)¶

Получает информацию об аргументах, переданных в конкретный фрейм. Возвращается именованный кортеж ArgInfo(args, varargs, keywords, locals). args – список имён аргументов. varargs и keywords – имена аргументов * и ** или None. locals – словарь локальных переменных данного фрейма.

inspect.formatargspec(args[, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, annotations[, formatarg, formatvarargs, formatvarkw, formatvalue, formatreturns, formatannotations]])¶

Форматирует красивое описание аргументов из значений, возвращаемых getargspec() или getfullargspec().

Первые семь аргументов: (args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, annotations).

Остальные шесть аргументов – это функции, которые вызываются для преобразования имён аргументов, имени аргумента *, имени аргумента **, значений по умолчанию, аннотации возвращаемого значения и отдельных аннотаций в строки соответственно.

Например:

>>> from inspect import formatargspec, getfullargspec
>>> def f(a: int, b: float):
...     pass
...
>>> formatargspec(*getfullargspec(f))
'(a: int, b: float)'

inspect.formatargvalues(args[, varargs, varkw, locals, formatarg, formatvarargs, formatvarkw, formatvalue])¶

Форматирует красивое описание аргументов из четырёх значений, возвращаемых getargvalues(). Аргументы format* – это соответствующие необязательные функции форматирования, которые вызываются для преобразования имён и значений в строки.

inspect.getmro(cls)¶

Возвращает кортеж базовых классов класса cls, включая cls, в порядке разрешения методов (MRO). Ни один класс не встречается в этом кортеже более одного раза. Обратите внимание, что порядок разрешения методов зависит от типа cls. Если не используется особенная пользовательская метатипизация, cls будет первым элементом кортежа.

inspect.getcallargs(func, *args, **kwds)¶

Привязывает args и kwds к именам аргументов функции или метода Python func, как если бы она была вызвана с ними. Для привязанных методов также привязывает первый аргумент (обычно с именем self) к соответствующему экземпляру. Возвращается словарь, отображающий имена аргументов (включая имена аргументов * и **, если они есть) в их значения из args и kwds. В случае некорректного вызова func, т.е. когда func(*args, **kwds) вызвало бы исключение из-за несовместимой сигнатуры, возникает исключение того же типа и с тем же или похожим сообщением. Например:

>>> from inspect import getcallargs
>>> def f(a, b=1, *pos, **named):
...     pass
>>> getcallargs(f, 1, 2, 3) == {'a': 1, 'named': {}, 'b': 2, 'pos': (3,)}
True
>>> getcallargs(f, a=2, x=4) == {'a': 2, 'named': {'x': 4}, 'b': 1, 'pos': ()}
True
>>> getcallargs(f)
Traceback (most recent call last):
...
TypeError: f() missing 1 required positional argument: 'a'

Новое в версии 3.2.

Примечание

Вместо этого рекомендуется использовать новый Signature.bind().

inspect.getclosurevars(func)¶

Получает отображение внешних ссылок на имена в функции или методе Python func на их текущие значения. Возвращается именованный кортеж ClosureVars(nonlocals, globals, builtins, unbound). nonlocals отображает ссылочные имена на лексические переменные замыкания, globals – на глобальные переменные модуля функции, а builtins – на встроенные функции, видимые из тела функции. unbound – это множество имён, на которые есть ссылки в функции, но которые не удалось разрешить при текущих глобальных переменных модуля и встроенных функциях.

TypeError вызывается, если func не является функцией или методом Python.

Новое в версии 3.3.

inspect.unwrap(func, *, stop=None)¶

Возвращает объект, обёрнутый в func. Следует цепочке атрибутов __wrapped__, возвращая последний объект в цепочке.

stop – необязательный колбэк, принимающий один аргумент – объект в цепочке обёрток, и позволяющий досрочно завершить разворачивание, если колбэк возвращает истинное значение. Если колбэк никогда не возвращает истинное значение, возвращается последний объект в цепочке, как обычно. Например, signature() использует это, чтобы остановить разворачивание, если у какого-либо объекта в цепочке определён атрибут __signature__.

ValueError возбуждается, если обнаружен цикл.

Новое в версии 3.4.

29.12.5. Стек интерпретатора¶The interpreter stack

Когда следующие функции возвращают «записи фреймов» (frame records), каждая запись представляет собой кортеж из шести элементов: объект фрейма, имя файла, номер текущей строки, имя функции, список строк контекста из исходного кода и индекс текущей строки в этом списке.

def handle_stackframe_without_leak():
    frame = inspect.currentframe()
    try:
        # Выполнить действие с фреймом
    finally:
        del frame

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

inspect.getframeinfo(frame, context=1)¶

Возвращает информацию об объекте фрейма или traceback. Возвращается именованный кортеж Traceback(filename, lineno, function, code_context, index).

inspect.getouterframes(frame, context=1)¶

Возвращает список записей фреймов для фрейма и всех внешних фреймов. Эти фреймы представляют вызовы, которые привели к созданию frame. Первая запись в возвращаемом списке представляет frame; последняя запись представляет самый внешний вызов в стеке frame.

inspect.getinnerframes(traceback, context=1)¶

Возвращает список записей о фреймах для фрейма traceback и всех внутренних фреймов. Эти фреймы представляют вызовы, являющиеся следствием frame. Первый элемент списка представляет traceback; последний элемент представляет место, где было возбуждено исключение.

inspect.currentframe()¶

Возвращает объект фрейма для фрейма стека вызывающего.

Особенность реализации CPython: Эта функция полагается на поддержку стековых фреймов Python в интерпретаторе, которая не гарантируется во всех реализациях Python. Если запуск происходит в реализации без поддержки стековых фреймов Python, эта функция возвращает None.

inspect.stack(context=1)¶

Возвращает список записей о фреймах для стека вызывающего кода. Первый элемент возвращаемого списка представляет вызывающий код; последний элемент представляет самый внешний вызов в стеке.

inspect.trace(context=1)¶

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

29.12.6. Статическое получение атрибутов¶Fetching attributes statically

Как getattr(), так и hasattr() могут запускать выполнение кода при получении или проверке существования атрибутов. Дескрипторы, такие как свойства, будут вызваны, и __getattr__() и __getattribute__() также могут быть вызваны.

Для случаев, когда требуется пассивная интроспекция, например, в инструментах документации, это может быть неудобно. getattr_static() имеет ту же сигнатуру, что и getattr(), но не выполняет код при получении атрибутов.

inspect.getattr_static(obj, attr, default=None)¶

Извлекает атрибуты без запуска динамического поиска через протокол дескрипторов, __getattr__() или __getattribute__().

Примечание: эта функция может быть не в состоянии получить все атрибуты, которые может получить getattr (например, динамически созданные атрибуты), и может найти атрибуты, которые getattr не может (например, дескрипторы, вызывающие AttributeError). Она также может возвращать объекты дескрипторов вместо членов экземпляра.

Если __dict__ экземпляра затенён другим членом (например, свойством), то эта функция не сможет найти члены экземпляра.

Новое в версии 3.2.

getattr_static() не разрешает дескрипторы, например, дескрипторы слотов или getset-дескрипторы для объектов, реализованных на C. Возвращается объект дескриптора вместо базового атрибута.

С ними можно работать с помощью кода вроде следующего. Обратите внимание, что для произвольных getset-дескрипторов их вызов может запустить выполнение кода:

# Пример кода для разрешения встроенных типов дескрипторов
class _foo:
    __slots__ = ['foo']

slot_descriptor = type(_foo.foo)
getset_descriptor = type(type(open(__file__)).name)
wrapper_descriptor = type(str.__dict__['__add__'])
descriptor_types = (slot_descriptor, getset_descriptor, wrapper_descriptor)

result = getattr_static(some_object, 'foo')
if type(result) in descriptor_types:
    try:
        result = result.__get__()
    except AttributeError:
        # Дескрипторы могут вызывать AttributeError, чтобы
        # указать, что нет нижележащего значения
        # в этом случае сам дескриптор будет
        # придется сделать
        pass

29.12.7. Текущее состояние генератора¶Current State of a Generator

При реализации планировщиков корутин и в других продвинутых применениях генераторов полезно определять, выполняется ли генератор в данный момент, ожидает ли он запуска или возобновления, или уже завершился. getgeneratorstate() позволяет легко определить текущее состояние генератора.

inspect.getgeneratorstate(generator)¶

Возвращает текущее состояние генератора-итератора.

Возможные состояния:

• GEN_CREATED: Ожидание начала выполнения.
• GEN_RUNNING: В настоящее время выполняется интерпретатором.
• GEN_SUSPENDED: в данный момент приостановлена на выражении yield.
• GEN_CLOSED: выполнение завершено.

Новое в версии 3.2.

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

inspect.getgeneratorlocals(generator)¶

Возвращает отображение живых локальных переменных в generator на их текущие значения. Возвращается словарь, отображающий имена переменных в значения. Это эквивалентно вызову locals() в теле генератора, и все те же предостережения действуют.

Если generator – это generator без текущего связанного фрейма, то возвращается пустой словарь. TypeError возбуждается, если generator не является объектом-генератором Python.

Деталь реализации CPython: Эта функция полагается на то, что генератор предоставляет стековый фрейм Python для интроспекции, что не гарантируется во всех реализациях Python. В таких случаях эта функция всегда будет возвращать пустой словарь.

Новое в версии 3.3.

29.12.8. Интерфейс командной строки¶Command Line Interface

Модуль inspect также предоставляет базовую возможность интроспекции из командной строки.

По умолчанию принимает имя модуля и выводит его исходный код. Класс или функцию внутри модуля можно вывести, добавив двоеточие и полное имя целевого объекта.

--details¶

Выводит информацию об указанном объекте, а не его исходный код.