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

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

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

inspect.getmembers(object[, predicate])¶

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

Примечание

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

inspect.getmembers_static(object[, predicate])¶

Возвращает все члены объекта в виде списка пар (name, value), отсортированных по имени, без запуска динамического поиска через протокол дескриптора, __getattr__ или __getattribute__. При необходимости возвращает только те члены, которые удовлетворяют заданному предикату.

Примечание

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

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

inspect.getmodulename(path)¶

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

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

Изменено в версии 3.3: Функция теперь основана непосредственно на importlib.

inspect.ismodule(object)¶

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

inspect.isclass(object)¶

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

Эта функция возвращает False для обобщённых псевдонимов классов, таких как list[int].

inspect.ismethod(object)¶

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

Примечание

Например, для такого класса:

>>> class Greeter:
...     def say_hello(self):
...         print('hello!')

Связанный метод (также известный как метод экземпляра) создаётся при обращении к say_hello (функции, определённой в пространстве имён Greeter) через экземпляр класса Greeter:

>>> instance = Greeter()

>>> instance.say_hello
<bound method Greeter.say_hello of <__main__.Greeter object ...>>
>>> ismethod(instance.say_hello)
True
>>> isfunction(instance.say_hello)
False

Обращение к say_hello через класс Greeter вернёт саму функцию. Для этой функции ismethod() вернёт False, но isfunction() вернёт True:

>>> Greeter.say_hello
<function Greeter.say_hello at 0x7f7503854a90>
>>> ismethod(Greeter.say_hello)
False
>>> isfunction(Greeter.say_hello)
True

Подробнее см. в Методы.

inspect.isfunction(object)¶

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

Пример см. в примечании к ismethod().

inspect.ispackage(object)¶

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

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

inspect.isgeneratorfunction(object)¶

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

Она также возвращает True для связанных методов, созданных из функций-генераторов Python (подробнее см. в Методы).

Изменено в версии 3.8: Функции, обёрнутые в functools.partial(), теперь возвращают True, если обёрнутая функция является функцией-генератором Python.

Изменено в версии 3.13: Функции, обёрнутые в functools.partialmethod(), теперь возвращают True, если обёрнутая функция является функцией-генератором Python.

inspect.isgenerator(object)¶

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

inspect.iscoroutinefunction(object)¶

Возвращает True, если объект является корутинной функцией (функция, определённая с синтаксисом async def), functools.partial(), обёртывающей корутинную функцию, или синхронной функцией, помеченной markcoroutinefunction().

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

Изменено в версии 3.8: Функции, обёрнутые в functools.partial(), теперь возвращают True, если обёрнутая функция является корутинной функцией.

Изменено в версии 3.12: Синхронные функции, помеченные markcoroutinefunction(), теперь возвращают True.

Изменено в версии 3.13: Функции, обёрнутые в functools.partialmethod(), теперь возвращают True, если обёрнутая функция является корутинной функцией.

inspect.markcoroutinefunction(func)¶

Декоратор для пометки вызываемого объекта как корутинной функции, если он не будет обнаружен iscoroutinefunction() иным образом.

Это может быть полезно для синхронных функций, которые возвращают корутину, если функция передаётся в API, требующий iscoroutinefunction().

Если возможно, предпочтительнее использовать async def функцию. Также допустимо вызвать функцию и проверить возвращаемое значение с помощью iscoroutine().

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

inspect.iscoroutine(object)¶

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

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

inspect.isawaitable(object)¶

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

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

import types

def gen():
    yield
@types.coroutine
def gen_coro():
    yield

assert not isawaitable(gen())
assert isawaitable(gen_coro())

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

inspect.isasyncgenfunction(object)¶

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

>>> async def agen():
...     yield 1
...
>>> inspect.isasyncgenfunction(agen)
True

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

Изменено в версии 3.8: Функции, обёрнутые в functools.partial(), теперь возвращают True, если обёрнутая функция является функцией асинхронного генератора.

Изменено в версии 3.13: Функции, обёрнутые в functools.partialmethod(), теперь возвращают True, если обёрнутая функция является функцией асинхронного генератора.

inspect.isasyncgen(object)¶

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

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

inspect.istraceback(object)¶

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

inspect.isframe(object)¶

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

inspect.iscode(object)¶

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

inspect.isbuiltin(object)¶

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

inspect.ismethodwrapper(object)¶

Возвращает True, если тип объекта – это MethodWrapperType.

Это экземпляры MethodWrapperType, такие как __str__(), __eq__() и __repr__().

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

inspect.isroutine(object)¶

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

inspect.isabstract(object)¶

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

inspect.ismethoddescriptor(object)¶

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

Это верно, например, для int.__add__. Объект, проходящий эту проверку, имеет метод __get__(), но не имеет метода __set__() или метода __delete__(). Помимо этого, набор атрибутов различается. Атрибут __name__ обычно имеет смысл, и __doc__ часто тоже.

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

Изменено в версии 3.13: Эта функция больше не ошибочно сообщает об объектах с __get__() и __delete__(), но без __set__(), как о дескрипторах метода (такие объекты являются дескрипторами данных, а не дескрипторами метода).

inspect.isdatadescriptor(object)¶

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

Дескрипторы данных имеют метод __set__ или __delete__. Примеры: свойства (определённые в 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.

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

inspect.getdoc(object)¶

Получает строку документации для объекта, очищенную с помощью cleandoc(). Если строка документации для объекта не задана, а объект – это класс, метод, свойство или дескриптор, строка документации извлекается из иерархии наследования. Возвращает None, если строка документации отсутствует или некорректна.

Изменено в версии 3.5: Теперь строки документации наследуются, если не переопределены.

inspect.getcomments(object)¶

Возвращает в виде одной строки все строки комментариев, непосредственно предшествующие исходному коду объекта (для класса, функции или метода), либо в начале Python-файла (если объект – модуль). Если исходный код объекта недоступен, возвращает None. Это может произойти, если объект определён на C или в интерактивной оболочке.

inspect.getfile(object)¶

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

inspect.getmodule(object)¶

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

inspect.getsourcefile(object)¶

Возвращает имя Python-файла с исходным кодом, в котором определён объект, или None, если способ получить исходный код не найден. Вызывает исключение TypeError, если объект – встроенный модуль, класс или функция.

inspect.getsourcelines(object)¶

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

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

inspect.getsource(object)¶

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

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

inspect.cleandoc(doc)¶

Убирает отступы из docstrings, которые выровнены с блоками кода.

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

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

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

inspect.signature(callable, *, follow_wrapped=True, globals=None, locals=None, eval_str=False, annotation_format=Format.VALUE)¶

Возвращает объект 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().

Если некоторые аннотации представлены строками (например, из-за использования from __future__ import annotations), signature() попытается автоматически преобразовать их из строк в обычные аннотации с помощью annotationlib.get_annotations(). Параметры globals, locals и eval_str передаются в annotationlib.get_annotations() при разрешении аннотаций; см. документацию по annotationlib.get_annotations() для получения инструкций по использованию этих параметров. Элемент перечисления annotationlib.Format можно передать в параметр annotation_format для управления форматом возвращаемых аннотаций. Например, используйте annotation_format=annotationlib.Format.STRING для возврата аннотаций в строковом формате.

Вызывает ValueError, если сигнатуру невозможно предоставить, и TypeError, если такой тип объекта не поддерживается. Кроме того, если аннотации преобразованы в строки и eval_str не равен false, вызов(ы) eval() для обратного преобразования аннотаций в annotationlib.get_annotations() могут потенциально вызвать исключения любого типа.

Слеш (/) в сигнатуре функции означает, что параметры до него являются только позиционными. Подробнее см. вопрос FAQ о только позиционных параметрах.

Изменено в версии 3.5: Был добавлен параметр follow_wrapped. Передайте False, чтобы получить сигнатуру именно вызываемого объекта (callable.__wrapped__ не будет использоваться для раскрытия декорированных вызываемых объектов.)

Изменено в версии 3.10: Были добавлены параметры globals, locals и eval_str.

Изменено в версии 3.14: Был добавлен параметр annotation_format.

Примечание

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

Особенности реализации CPython: Если у переданного объекта есть атрибут __signature__, он может использоваться для создания сигнатуры. Точная семантика является деталью реализации и может быть изменена без предварительного уведомления. Обратитесь к исходному коду за актуальной семантикой.

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

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

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

Необязательный аргумент return_annotation может быть произвольным объектом Python. Он представляет аннотацию «return» вызываемого объекта.

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

Изменено в версии 3.5: Объекты Signature теперь являются сериализуемыми и хешируемыми.

empty¶

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

parameters¶

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

Изменено в версии 3.7: Python явно гарантирует сохранение порядка объявления только-ключевых параметров начиная с версии 3.7, хотя на практике этот порядок всегда сохранялся в Python 3.

return_annotation¶

Аннотация «return» вызываемого объекта. Если у вызываемого объекта нет аннотации «return», этот атрибут устанавливается в 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'"

Объекты Signature также поддерживаются универсальной функцией copy.replace().

format(*, max_width=None, quote_annotation_strings=True)¶

Создаёт строковое представление объекта Signature.

Если передан max_width, метод попытается уместить сигнатуру в строки длиной не более max_width символов. Если сигнатура длиннее max_width, все параметры будут размещены на отдельных строках.

Если quote_annotation_strings имеет значение False, аннотации в сигнатуре отображаются без открывающих и закрывающих кавычек, если они являются строками. Это полезно, если сигнатура была создана в формате STRING или если использовался from __future__ import annotations.

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

Изменено в версии 3.14: Был добавлен параметр unquote_annotations.

classmethod from_callable(obj, *, follow_wrapped=True, globals=None, locals=None, eval_str=False)¶

Возвращает объект Signature (или его подкласс) для заданного вызываемого объекта obj.

Этот метод упрощает создание подклассов Signature:

class MySignature(Signature):
    pass
sig = MySignature.from_callable(sum)
assert isinstance(sig, MySignature)

В остальном его поведение идентично signature().

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

Изменено в версии 3.10: Были добавлены параметры globals, locals и eval_str.

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

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

Изменено в версии 3.5: Объекты Parameter теперь сериализуемы и хешируемы.

empty¶

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

name¶

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

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

Изменено в версии 3.6: Теперь этот модуль предоставляет эти имена параметров как имена вида implicit0.

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

kind.description¶

Описывает значение перечисления Parameter.kind.

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

Пример: вывод всех описаний аргументов:

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

>>> sig = signature(foo)
>>> for param in sig.parameters.values():
...     print(param.kind.description)
positional or keyword
positional or keyword
keyword-only
keyword-only

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

Создаёт новый экземпляр Parameter на основе экземпляра, на котором была вызвана операция замены. Чтобы переопределить атрибут Parameter, передайте соответствующий аргумент. Чтобы удалить значение по умолчанию и/или аннотацию из 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'"

Объекты Parameter также поддерживаются универсальной функцией copy.replace().

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

class inspect.BoundArguments¶

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

arguments¶

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

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

Примечание

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

Изменено в версии 3.9: arguments теперь имеет тип dict. Ранее он имел тип collections.OrderedDict.

args¶

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

kwargs¶

Словарь значений именованных аргументов. Динамически вычисляется из атрибута arguments. Аргументы, которые можно передать позиционно, включаются в args вместо этого.

signature¶

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

apply_defaults()¶

Устанавливает значения по умолчанию для отсутствующих аргументов.

Для переменных позиционных аргументов (*args) значением по умолчанию является пустой кортеж.

Для переменных именованных аргументов (**kwargs) значением по умолчанию является пустой словарь.

>>> def foo(a, b='ham', *args): pass
>>> ba = inspect.signature(foo).bind('spam')
>>> ba.apply_defaults()
>>> ba.arguments
{'a': 'spam', 'b': 'ham', 'args': ()}

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

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

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

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

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

inspect.getclasstree(classes, unique=False)¶

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

inspect.getfullargspec(func)¶

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

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

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

Обратите внимание, что signature() и объект Signature предоставляют рекомендуемый API для интроспекции вызываемых объектов и поддерживают дополнительное поведение (например, позиционные аргументы), которое иногда встречается в API модулей расширения. Эта функция сохранена в основном для использования в коде, которому необходима совместимость с API модуля Python 2 inspect.

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

Изменено в версии 3.6: Ранее этот метод был объявлен устаревшим в пользу signature() в Python 3.5, но это решение было отменено, чтобы восстановить чётко поддерживаемый стандартный интерфейс для кода на Python 2/3 из одного источника, который мигрирует от устаревшего API getargspec().

Изменено в версии 3.7: Python явно гарантирует сохранение порядка объявления только-ключевых параметров начиная с версии 3.7, хотя на практике этот порядок всегда сохранялся в Python 3.

inspect.getargvalues(frame)¶

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

Примечание

Эта функция была ошибочно помечена как устаревшая в Python 3.5.

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

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

Примечание

Эта функция была ошибочно помечена как устаревшая в Python 3.5.

inspect.getmro(cls)¶

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

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

Связывает args и kwds с именами аргументов функции или метода Python func, как если бы она была вызвана с ними. Для связанных методов (bound methods) также связывает первый аргумент (обычно названный 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.

Устарело с версии 3.5: Используйте Signature.bind() и Signature.bind_partial() вместо этого.

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.

inspect.get_annotations(obj, *, globals=None, locals=None, eval_str=False, format=annotationlib.Format.VALUE)¶

Вычисляет словарь аннотаций для объекта.

Это псевдоним для annotationlib.get_annotations(); обратитесь к документации этой функции за дополнительной информацией.

Внимание

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

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

Изменено в версии 3.14: Эта функция теперь является псевдонимом для annotationlib.get_annotations(). Вызов её как inspect.get_annotations продолжит работать.

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

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

class inspect.FrameInfo¶

frame¶

Объект фрейма, которому соответствует эта запись.

filename¶

Имя файла, связанное с кодом, выполняемым фреймом, которому соответствует эта запись.

lineno¶

Номер текущей строки, связанной с кодом, выполняемым фреймом, которому соответствует эта запись.

function¶

Имя функции, выполняемой фреймом, соответствующем этой записи.

code_context¶

Список строк контекста из исходного кода, выполняемого фреймом, которому соответствует эта запись.

index¶

Индекс текущей выполняемой строки в списке code_context.

positions¶

Объект dis.Positions, содержащий номер начальной строки, номер конечной строки, смещение начального столбца и смещение конечного столбца, связанные с инструкцией, выполняемой фреймом, соответствующем этой записи.

Изменено в версии 3.5: Возвращает именованный кортеж вместо tuple.

Изменено в версии 3.11: FrameInfo теперь является экземпляром класса (обратно совместим с предыдущим именованным кортежем).

class inspect.Traceback¶

filename¶

Имя файла, связанное с кодом, выполняемым фреймом, которому соответствует этот traceback.

lineno¶

Номер текущей строки, связанной с кодом, выполняемым фреймом, которому соответствует этот traceback.

function¶

Имя функции, выполняемой фреймом, которому соответствует этот traceback.

code_context¶

Список строк контекста из исходного кода, выполняемого фреймом, которому соответствует этот traceback.

index¶

Индекс текущей выполняемой строки в списке code_context.

positions¶

Объект dis.Positions, содержащий номер начальной строки, номер конечной строки, смещение начального столбца и смещение конечного столбца, связанные с инструкцией, выполняемой фреймом, которому соответствует этот traceback.

Изменено в версии 3.11: Traceback теперь является экземпляром класса (обратно совместим с предыдущим именованным кортежем).

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

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

inspect.getframeinfo(frame, context=1)¶

Возвращает информацию об объекте фрейма или traceback. Возвращается объект Traceback.

Изменено в версии 3.11: Возвращается объект Traceback вместо именованного кортежа.

inspect.getouterframes(frame, context=1)¶

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

Изменено в версии 3.5: Возвращается список именованных кортежей FrameInfo(frame, filename, lineno, function, code_context, index).

Изменено в версии 3.11: Возвращается список объектов FrameInfo.

inspect.getinnerframes(traceback, context=1)¶

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

Изменено в версии 3.5: Возвращается список именованных кортежей FrameInfo(frame, filename, lineno, function, code_context, index).

Изменено в версии 3.11: Возвращается список объектов FrameInfo.

inspect.currentframe()¶

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

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

inspect.stack(context=1)¶

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

Изменено в версии 3.5: Возвращается список именованных кортежей FrameInfo(frame, filename, lineno, function, code_context, index).

Изменено в версии 3.11: Возвращается список объектов FrameInfo.

inspect.trace(context=1)¶

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

Изменено в версии 3.5: Возвращается список именованных кортежей FrameInfo(frame, filename, lineno, function, code_context, index).

Изменено в версии 3.11: Возвращается список объектов FrameInfo.

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

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

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

inspect.getattr_static(obj, attr)¶

inspect.getattr_static(obj, attr, default)

Получает атрибуты без запуска динамического поиска через протокол дескрипторов, __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

Текущее состояние генераторов, корутин и асинхронных генераторов¶Current State of Generators, Coroutines, and Asynchronous Generators

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

inspect.getgeneratorstate(generator)¶

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

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

• GEN_CREATED: Ожидание начала выполнения.

• GEN_RUNNING: В настоящее время выполняется интерпретатором.

• GEN_SUSPENDED: в данный момент приостановлена на выражении yield.

• GEN_CLOSED: выполнение завершено.

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

inspect.getcoroutinestate(coroutine)¶

Получить текущее состояние объекта корутины. Эта функция предназначена для использования с объектами корутин, созданными функциями async def, но принимает любой объект, похожий на корутину, который имеет атрибуты cr_running и cr_frame.

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

• CORO_CREATED: ожидает начала выполнения.

• CORO_RUNNING: в данный момент выполняется интерпретатором.

• CORO_SUSPENDED: в данный момент приостановлена на выражении await.

• CORO_CLOSED: выполнение завершено.

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

inspect.getasyncgenstate(agen)¶

Получить текущее состояние асинхронного генератора. Эта функция предназначена для использования с асинхронными итераторами, созданными функциями async def, которые используют оператор yield, но принимает любой объект, похожий на асинхронный генератор, имеющий атрибуты ag_running и ag_frame.

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

• AGEN_CREATED: ожидает начала выполнения.

• AGEN_RUNNING: в данный момент выполняется интерпретатором.

• AGEN_SUSPENDED: в данный момент приостановлена на выражении yield.

• AGEN_CLOSED: выполнение завершено.

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

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

inspect.getgeneratorlocals(generator)¶

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

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

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

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

inspect.getcoroutinelocals(coroutine)¶

Эта функция аналогична getgeneratorlocals(), но работает для объектов корутин, созданных функциями async def.

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

inspect.getasyncgenlocals(agen)¶

Эта функция аналогична getgeneratorlocals(), но работает для объектов асинхронных генераторов, созданных функциями async def, использующими оператор yield.

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

Битовые флаги объектов кода¶Code Objects Bit Flags

Объекты кода Python имеют атрибут co_flags, который представляет собой битовую маску следующих флагов:

inspect.CO_OPTIMIZED¶

Объект кода оптимизирован с использованием быстрых локальных переменных.

inspect.CO_NEWLOCALS¶

Если установлен, при выполнении объекта кода будет создан новый словарь для f_locals фрейма.

inspect.CO_VARARGS¶

Объект кода имеет переменный позиционный параметр (аналог *args).

inspect.CO_VARKEYWORDS¶

Объект кода имеет переменный ключевой параметр (аналог **kwargs).

inspect.CO_NESTED¶

Флаг устанавливается, когда объект кода представляет собой вложенную функцию.

inspect.CO_GENERATOR¶

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

inspect.CO_COROUTINE¶

Флаг устанавливается, когда объект кода является корутинной функцией. При выполнении объекта кода возвращается объект корутины. Подробнее см. PEP 492.

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

inspect.CO_ITERABLE_COROUTINE¶

Флаг используется для преобразования генераторов в корутины на основе генераторов. Объекты-генераторы с этим флагом можно использовать в выражении await, и они могут yield from объекты корутин. Подробнее см. PEP 492.

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

inspect.CO_ASYNC_GENERATOR¶

Флаг устанавливается, когда объект кода является асинхронной функцией-генератором. При выполнении объекта кода возвращается объект асинхронного генератора. Подробнее см. PEP 525.

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

inspect.CO_HAS_DOCSTRING¶

Флаг устанавливается, если для объекта кода есть строка документации в исходном коде. Если флаг установлен, эта строка будет первым элементом в co_consts.

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

inspect.CO_METHOD¶

Флаг устанавливается, когда объект кода является функцией, определённой внутри класса.

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

Флаги буфера¶Buffer flags

class inspect.BufferFlags¶

Это enum.IntFlag, представляющий флаги, которые можно передавать методу __buffer__() объектов, реализующих буферный протокол.

Значение флагов объясняется в разделе Типы запросов буфера.

SIMPLE¶

WRITABLE¶

FORMAT¶

ND¶

STRIDES¶

C_CONTIGUOUS¶

F_CONTIGUOUS¶

ANY_CONTIGUOUS¶

INDIRECT¶

CONTIG¶

CONTIG_RO¶

STRIDED¶

STRIDED_RO¶

RECORDS¶

RECORDS_RO¶

FULL¶

FULL_RO¶

READ¶

WRITE¶

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

Интерфейс командной строки¶Command-line interface

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

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

--details¶

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