`inspect.md`

904 строк · 83.2 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.10/library/inspect.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# [`inspect`](https://python-all.ru/3.10/library/inspect.html#module-inspect) – Инспекция живых объектов89**Исходный код:** [Lib/inspect.py](https://python-all.ru/src/3.10/Lib/inspect.py)1011---1213Модуль [`inspect`](https://python-all.ru/3.10/library/inspect.html#module-inspect) предоставляет несколько полезных функций для получения информации о живых объектах, таких как модули, классы, методы, функции, трассировки, объекты кадров и объекты кода. Например, он позволяет изучить содержимое класса, получить исходный код метода, извлечь и отформатировать список аргументов функции или получить всю информацию, необходимую для вывода подробной трассировки.1415Этот модуль предоставляет четыре основных вида сервисов: проверка типов, получение исходного кода, инспекция классов и функций, а также анализ стека интерпретатора.1617## Типы и члены1819Функция [`getmembers()`](https://python-all.ru/3.10/library/inspect.html#inspect.getmembers) извлекает члены объекта, например класса или модуля. Функции, имена которых начинаются с «is», в основном предоставляются как удобные варианты для второго аргумента [`getmembers()`](https://python-all.ru/3.10/library/inspect.html#inspect.getmembers). Они также помогают определить, когда можно ожидать появления следующих специальных атрибутов:2021| Тип | Атрибут | Описание |22| --- | --- | --- |23| модуль | doc | строка документации |24|  | file | filename (отсутствует для встроенных модулей) |25| класс | doc | строка документации |26|  | name | имя, под которым был определён этот класс |27|  | qualname | полное имя |28|  | module | имя модуля, в котором был определён этот класс |29| метод | doc | строка документации |30|  | name | имя, под которым был определён этот метод |31|  | qualname | полное имя |32|  | func | объект функции, содержащий реализацию метода |33|  | self | экземпляр, к которому привязан этот метод, или `None` |34|  | module | имя модуля, в котором был определён этот метод |35| функция | doc | строка документации |36|  | name | имя, под которым была определена эта функция |37|  | qualname | полное имя |38|  | code | объект кода, содержащий скомпилированную функцию [байткод](https://python-all.ru/3.10/glossary.html#term-bytecode) |39|  | defaults | кортеж значений по умолчанию для позиционных или именованных параметров |40|  | kwdefaults | отображение значений по умолчанию для параметров, доступных только по ключевым словам |41|  | globals | глобальное пространство имён, в котором была определена эта функция |42|  | builtins | пространство имён builtins |43|  | annotations | отображение имён параметров в аннотации; ключ `"return"` зарезервирован для аннотаций возвращаемого значения. |44|  | module | имя модуля, в котором была определена эта функция |45| traceback | tb\_frame | объект фрейма на этом уровне |46|  | tb\_lasti | индекс последней предпринятой инструкции в байткоде |47|  | tb\_lineno | текущий номер строки в исходном коде Python |48|  | tb\_next | следующий внутренний объект traceback (вызванный на этом уровне) |49| фрейм | f\_back | следующий внешний объект фрейма (вызывающий этот фрейм) |50|  | f\_builtins | пространство имён builtins, видимое этим фреймом |51|  | f\_code | объект кода, выполняющийся в этом фрейме |52|  | f\_globals | глобальное пространство имён, видимое этим фреймом |53|  | f\_lasti | индекс последней предпринятой инструкции в байткоде |54|  | f\_lineno | текущий номер строки в исходном коде Python |55|  | f\_locals | локальное пространство имён, видимое этим фреймом |56|  | f\_trace | функция трассировки для этого фрейма или `None` |57| код | co\_argcount | количество аргументов (не включая только именованные аргументы, \* или \*\* args) |58|  | co\_code | строка сырого скомпилированного байткода |59|  | co\_cellvars | кортеж имён клеточных переменных (используемых в объёмлющих областях видимости) |60|  | co\_consts | кортеж констант, используемых в байткоде |61|  | co\_filename | имя файла, в котором был создан этот объект кода |62|  | co\_firstlineno | номер первой строки в исходном коде Python |63|  | co\_flags | битовая маска флагов `CO_*`, подробнее [здесь](https://python-all.ru/3.10/library/inspect.html#inspect-module-co-flags) |64|  | co\_lnotab | кодированное отображение номеров строк на индексы байт-кода |65|  | co\_freevars | кортеж имён свободных переменных (на которые есть ссылка через замыкание функции) |66|  | co\_posonlyargcount | количество позиционных аргументов |67|  | co\_kwonlyargcount | количество только ключевых аргументов (не включая \*\* arg) |68|  | co\_name | имя, с которым был определён этот объект кода |69|  | co\_names | кортеж имён, отличных от аргументов и локальных переменных функции |70|  | co\_nlocals | количество локальных переменных |71|  | co\_stacksize | требуемый размер стека виртуальной машины |72|  | co\_varnames | кортеж имён аргументов и локальных переменных |73| генератор | name | имя |74|  | qualname | полное имя |75|  | gi\_frame | фрейм |76|  | gi\_running | выполняется ли генератор? |77|  | gi\_code | код |78|  | gi\_yieldfrom | объект, итерируемый `yield from`, или `None` |79| корутина | name | имя |80|  | qualname | полное имя |81|  | cr\_await | ожидаемый объект, или `None` |82|  | cr\_frame | фрейм |83|  | cr\_running | выполняется ли корутина? |84|  | cr\_code | код |85|  | cr\_origin | где была создана корутина, или `None`. См. [`sys.set_coroutine_origin_tracking_depth()`](https://python-all.ru/3.10/library/sys.html#sys.set_coroutine_origin_tracking_depth) |86| встроенный | doc | строка документации |87|  | name | исходное имя этой функции или метода |88|  | qualname | полное имя |89|  | self | экземпляр, к которому привязан метод, или `None` |9091Изменено в версии 3.5: Добавлены атрибуты `__qualname__` и `gi_yieldfrom` для генераторов.9293Атрибут `__name__` генераторов теперь устанавливается из имени функции, а не из имени кода, и его можно изменять.9495Изменено в версии 3.7: Добавлен атрибут `cr_origin` для корутин.9697Изменено в версии 3.10: Добавлен атрибут `__builtins__` для функций.9899#### `inspect.getmembers(object[, predicate])`100101Возвращает все члены объекта в виде списка пар `(name, value)`, отсортированных по имени. Если передан необязательный аргумент *predicate* – который будет вызван с объектом `value` каждого члена, – включаются только те члены, для которых предикат возвращает истинное значение.102103> **Примечание**104>105> [`getmembers()`](https://python-all.ru/3.10/library/inspect.html#inspect.getmembers) возвращает только атрибуты класса, определённые в метаклассе, когда аргумент является классом, и эти атрибуты были перечислены в пользовательском `__dir__()` метакласса.106107#### `inspect.getmodulename(path)`108109Возвращает имя модуля, заданного файлом *path*, без включения имён объемлющих пакетов. Расширение файла проверяется по всем записям в [`importlib.machinery.all_suffixes()`](https://python-all.ru/3.10/library/importlib.html#importlib.machinery.all_suffixes). Если совпадение найдено, возвращается последний компонент пути с удалённым расширением. В противном случае возвращается `None`.110111Обратите внимание, что эта функция *только* возвращает осмысленное имя для реальных модулей Python – пути, которые потенциально относятся к пакетам Python, всё равно вернут `None`.112113Изменено в версии 3.3: Функция теперь основана непосредственно на [`importlib`](https://python-all.ru/3.10/library/importlib.html#module-importlib).114115#### `inspect.ismodule(object)`116117Возвращает `True`, если объект является модулем.118119#### `inspect.isclass(object)`120121Возвращает `True`, если объект является классом, встроенным или созданным в коде Python.122123#### `inspect.ismethod(object)`124125Возвращает `True`, если объект – связанный метод, написанный на Python.126127#### `inspect.isfunction(object)`128129Возвращает `True`, если объект является функцией Python, включая функции, созданные с помощью [lambda](https://python-all.ru/3.10/glossary.html#term-lambda)-выражения.130131#### `inspect.isgeneratorfunction(object)`132133Возвращает `True`, если объект является функцией-генератором Python.134135Изменено в версии 3.8: Функции, обёрнутые в [`functools.partial()`](https://python-all.ru/3.10/library/functools.html#functools.partial), теперь возвращают `True`, если обёрнутая функция является функцией-генератором Python.136137#### `inspect.isgenerator(object)`138139Возвращает `True`, если объект является генератором.140141#### `inspect.iscoroutinefunction(object)`142143Return `True` if the object is a [coroutine function](https://python-all.ru/3.10/glossary.html#term-coroutine-function) (a function defined with an [`async def`](https://python-all.ru/3.10/reference/compound_stmts.html#async-def) syntax).144145Новое в версии 3.5.146147Изменено в версии 3.8: Функции, обёрнутые в [`functools.partial()`](https://python-all.ru/3.10/library/functools.html#functools.partial), теперь возвращают `True`, если обёрнутая функция является [корутинной функцией](https://python-all.ru/3.10/glossary.html#term-coroutine-function).148149#### `inspect.iscoroutine(object)`150151Возвращает `True`, если объект является [корутиной](https://python-all.ru/3.10/glossary.html#term-coroutine), созданной функцией [`async def`](https://python-all.ru/3.10/reference/compound_stmts.html#async-def).152153Новое в версии 3.5.154155#### `inspect.isawaitable(object)`156157Возвращает `True`, если объект может использоваться в выражении [`await`](https://python-all.ru/3.10/reference/expressions.html#await).158159Также может использоваться для отличия корутин на основе генераторов от обычных генераторов:160161```python162def gen():163    yield164@types.coroutine165def gen_coro():166    yield167168assert not isawaitable(gen())169assert isawaitable(gen_coro())170```171172Новое в версии 3.5.173174#### `inspect.isasyncgenfunction(object)`175176Возвращает `True`, если объект является функцией [асинхронного генератора](https://python-all.ru/3.10/glossary.html#term-asynchronous-generator), например:177178```python179>>> async def agen():180...     yield 1181...182>>> inspect.isasyncgenfunction(agen)183True184```185186Новое в версии 3.6.187188Changed in version 3.8: Functions wrapped in [`functools.partial()`](https://python-all.ru/3.10/library/functools.html#functools.partial) now return `True` if the wrapped function is a [asynchronous generator](https://python-all.ru/3.10/glossary.html#term-asynchronous-generator) function.189190#### `inspect.isasyncgen(object)`191192Возвращает `True`, если объект является [итератором асинхронного генератора](https://python-all.ru/3.10/glossary.html#term-asynchronous-generator-iterator), созданным функцией [асинхронного генератора](https://python-all.ru/3.10/glossary.html#term-asynchronous-generator).193194Новое в версии 3.6.195196#### `inspect.istraceback(object)`197198Возвращает `True`, если объект является traceback.199200#### `inspect.isframe(object)`201202Возвращает `True`, если объект является фреймом.203204#### `inspect.iscode(object)`205206Возвращает `True`, если объект является кодом.207208#### `inspect.isbuiltin(object)`209210Возвращает `True`, если объект является встроенной функцией или связанным встроенным методом.211212#### `inspect.isroutine(object)`213214Возвращает `True`, если объект является пользовательской или встроенной функцией или методом.215216#### `inspect.isabstract(object)`217218Возвращает `True`, если объект является абстрактным базовым классом.219220#### `inspect.ismethoddescriptor(object)`221222Возвращает `True`, если объект является дескриптором метода, но не если [`ismethod()`](https://python-all.ru/3.10/library/inspect.html#inspect.ismethod), [`isclass()`](https://python-all.ru/3.10/library/inspect.html#inspect.isclass), [`isfunction()`](https://python-all.ru/3.10/library/inspect.html#inspect.isfunction) или [`isbuiltin()`](https://python-all.ru/3.10/library/inspect.html#inspect.isbuiltin) истинны.223224Это верно, например, для `int.__add__`. Объект, проходящий эту проверку, имеет метод [`__get__()`](https://python-all.ru/3.10/reference/datamodel.html#object.__get__), но не имеет метода [`__set__()`](https://python-all.ru/3.10/reference/datamodel.html#object.__set__), однако помимо этого набор атрибутов различается. Атрибут [`__name__`](https://python-all.ru/3.10/library/stdtypes.html#definition.__name__) обычно имеет смысл, а `__doc__` часто – тоже.225226Методы, реализованные через дескрипторы, которые также проходят один из других тестов, возвращают `False` из теста [`ismethoddescriptor()`](https://python-all.ru/3.10/library/inspect.html#inspect.ismethoddescriptor), просто потому что другие тесты обещают больше – например, можно рассчитывать на наличие атрибута `__func__` (и т.д.), когда объект проходит [`ismethod()`](https://python-all.ru/3.10/library/inspect.html#inspect.ismethod).227228#### `inspect.isdatadescriptor(object)`229230Возвращает `True`, если объект является дескриптором данных.231232Дескрипторы данных имеют метод [`__set__`](https://python-all.ru/3.10/reference/datamodel.html#object.__set__) или [`__delete__`](https://python-all.ru/3.10/reference/datamodel.html#object.__delete__). Примеры: свойства (определённые в Python), getsets и members. Последние два определены в C, и для этих типов существуют более специфичные проверки, которые надёжны в разных реализациях Python. Обычно дескрипторы данных также имеют атрибуты [`__name__`](https://python-all.ru/3.10/library/stdtypes.html#definition.__name__) и `__doc__` (свойства, getsets и members имеют оба этих атрибута), но это не гарантируется.233234#### `inspect.isgetsetdescriptor(object)`235236Возвращает `True`, если объект является дескриптором getset.237238**Особенность реализации CPython:** getsets – это атрибуты, определённые в модулях расширения через структуры [`PyGetSetDef`](https://python-all.ru/3.10/c-api/structures.html#c.PyGetSetDef). Для реализаций Python без таких типов этот метод всегда будет возвращать `False`.239240#### `inspect.ismemberdescriptor(object)`241242Возвращает `True`, если объект является дескриптором члена.243244**Особенности реализации CPython:** Дескрипторы членов – это атрибуты, определённые в модулях расширения через структуры [`PyMemberDef`](https://python-all.ru/3.10/c-api/structures.html#c.PyMemberDef). В реализациях Python без таких типов этот метод всегда возвращает `False`.245246## Получение исходного кода247248#### `inspect.getdoc(object)`249250Получает строку документации для объекта, очищенную с помощью [`cleandoc()`](https://python-all.ru/3.10/library/inspect.html#inspect.cleandoc). Если строка документации для объекта не задана, а объект – это класс, метод, свойство или дескриптор, строка документации извлекается из иерархии наследования. Возвращает `None`, если строка документации отсутствует или некорректна.251252Изменено в версии 3.5: Теперь строки документации наследуются, если не переопределены.253254#### `inspect.getcomments(object)`255256Возвращает в виде одной строки все строки комментариев, непосредственно предшествующие исходному коду объекта (для класса, функции или метода), либо в начале Python-файла (если объект – модуль). Если исходный код объекта недоступен, возвращает `None`. Это может произойти, если объект определён на C или в интерактивной оболочке.257258#### `inspect.getfile(object)`259260Возвращает имя (текстового или бинарного) файла, в котором определён объект. Вызывает исключение [`TypeError`](https://python-all.ru/3.10/library/exceptions.html#TypeError), если объект – встроенный модуль, класс или функция.261262#### `inspect.getmodule(object)`263264Пытается определить модуль, в котором определён объект. Возвращает `None`, если модуль не удаётся определить.265266#### `inspect.getsourcefile(object)`267268Возвращает имя Python-файла с исходным кодом, в котором определён объект, или `None`, если способ получить исходный код не найден. Вызывает исключение [`TypeError`](https://python-all.ru/3.10/library/exceptions.html#TypeError), если объект – встроенный модуль, класс или функция.269270#### `inspect.getsourcelines(object)`271272Возвращает список строк исходного кода и номер начальной строки для объекта. Аргументом может быть модуль, класс, метод, функция, traceback, frame или code-объект. Исходный код возвращается в виде списка строк этого объекта, а номер строки указывает положение первой строки кода в исходном файле. Вызывается исключение [`OSError`](https://python-all.ru/3.10/library/exceptions.html#OSError), если исходный код не удаётся получить. Вызывается [`TypeError`](https://python-all.ru/3.10/library/exceptions.html#TypeError), если объект – встроенный модуль, класс или функция.273274Изменено в версии 3.3: [`OSError`](https://python-all.ru/3.10/library/exceptions.html#OSError) вызывается вместо [`IOError`](https://python-all.ru/3.10/library/exceptions.html#IOError), который теперь является его псевдонимом.275276#### `inspect.getsource(object)`277278Возвращает текст исходного кода для объекта. Аргументом может быть модуль, класс, метод, функция, traceback, frame или code-объект. Исходный код возвращается в виде одной строки. Вызывается [`OSError`](https://python-all.ru/3.10/library/exceptions.html#OSError), если исходный код не удаётся получить. Вызывается [`TypeError`](https://python-all.ru/3.10/library/exceptions.html#TypeError), если объект – встроенный модуль, класс или функция.279280Изменено в версии 3.3: [`OSError`](https://python-all.ru/3.10/library/exceptions.html#OSError) вызывается вместо [`IOError`](https://python-all.ru/3.10/library/exceptions.html#IOError), который теперь является его псевдонимом.281282#### `inspect.cleandoc(doc)`283284Убирает отступы из docstrings, которые выровнены с блоками кода.285286Из первой строки удаляются все начальные пробелы. Все начальные пробелы, которые можно равномерно удалить со второй строки и далее, также удаляются. Пустые строки в начале и конце удаляются. Кроме того, все табуляции заменяются пробелами.287288## Интроспекция вызываемых объектов с помощью объекта Signature289290Новое в версии 3.3.291292Объект Signature представляет сигнатуру вызова вызываемого объекта и его аннотацию возвращаемого значения. Чтобы получить объект Signature, используйте функцию [`signature()`](https://python-all.ru/3.10/library/inspect.html#inspect.signature).293294#### `inspect.signature(callable, *, follow_wrapped=True, globals=None, locals=None, eval_str=False)`295296Возвращает объект [`Signature`](https://python-all.ru/3.10/library/inspect.html#inspect.Signature) для заданного `callable`:297298```python299>>> from inspect import signature300>>> def foo(a, *, b:int, **kwargs):301...     pass302303>>> sig = signature(foo)304305>>> str(sig)306'(a, *, b:int, **kwargs)'307308>>> str(sig.parameters['b'])309'b:int'310311>>> sig.parameters['b'].annotation312<class 'int'>313```314315Принимает широкий спектр вызываемых объектов Python: от обычных функций и классов до объектов [`functools.partial()`](https://python-all.ru/3.10/library/functools.html#functools.partial).316317Для объектов, определённых в модулях, использующих строковые аннотации (`from __future__ import annotations`), [`signature()`](https://python-all.ru/3.10/library/inspect.html#inspect.signature) будет пытаться автоматически преобразовать их из строк с помощью [`inspect.get_annotations()`](https://python-all.ru/3.10/library/inspect.html#inspect.get_annotations). Параметры `global`, `locals` и `eval_str` передаются в [`inspect.get_annotations()`](https://python-all.ru/3.10/library/inspect.html#inspect.get_annotations) при разрешении аннотаций; за инструкциями по использованию этих параметров обращайтесь к документации [`inspect.get_annotations()`](https://python-all.ru/3.10/library/inspect.html#inspect.get_annotations).318319Возбуждает [`ValueError`](https://python-all.ru/3.10/library/exceptions.html#ValueError), если сигнатура не может быть предоставлена, и [`TypeError`](https://python-all.ru/3.10/library/exceptions.html#TypeError), если такой тип объекта не поддерживается. Также, если аннотации строковые и `eval_str` не равно false, вызовы `eval()` для преобразования аннотаций из строк могут потенциально возбудить любое исключение.320321Косая черта (/) в сигнатуре функции означает, что параметры до неё являются только позиционными. За дополнительной информацией обращайтесь к [вопросу FAQ о только позиционных параметрах](https://python-all.ru/3.10/faq/programming.html#faq-positional-only-arguments).322323Новое в версии 3.5: `follow_wrapped` параметр. Передайте `False`, чтобы получить сигнатуру `callable` конкретно (`callable.__wrapped__` не будет использоваться для разворачивания декорированных вызываемых объектов).324325Новое в версии 3.10: `globals`, `locals` и `eval_str` параметры.326327> **Примечание**328>329> Некоторые вызываемые объекты могут быть недоступны для интроспекции в определённых реализациях Python. Например, в CPython некоторые встроенные функции, определённые на C, не предоставляют метаданных о своих аргументах.330331#### `class inspect.Signature(parameters=None, *, return_annotation=Signature.empty)`332333Объект Signature представляет сигнатуру вызова функции и её аннотацию возвращаемого значения. Для каждого параметра, принимаемого функцией, он сохраняет объект [`Parameter`](https://python-all.ru/3.10/library/inspect.html#inspect.Parameter) в своей коллекции [`parameters`](https://python-all.ru/3.10/library/inspect.html#inspect.Signature.parameters).334335Необязательный аргумент *parameters* – это последовательность объектов [`Parameter`](https://python-all.ru/3.10/library/inspect.html#inspect.Parameter), которая проверяется на отсутствие дублирующихся имён параметров и на правильный порядок: сначала только позиционные, затем позиционно-ключевые, а параметры со значениями по умолчанию следуют за параметрами без них.336337Необязательный аргумент *return\_annotation* может быть произвольным объектом Python и является аннотацией возвращаемого значения вызываемого объекта.338339Объекты Signature *неизменяемы*. Используйте [`Signature.replace()`](https://python-all.ru/3.10/library/inspect.html#inspect.Signature.replace) для создания изменённой копии.340341Изменено в версии 3.5: Объекты Signature можно сериализовать и [хешируемы](https://python-all.ru/3.10/glossary.html#term-hashable).342343#### `empty`344345Специальный маркер уровня класса для указания отсутствия аннотации возврата.346347#### `parameters`348349Упорядоченное отображение имён параметров в соответствующие объекты [`Parameter`](https://python-all.ru/3.10/library/inspect.html#inspect.Parameter). Параметры располагаются в строгом порядке определения, включая только ключевые параметры.350351Изменено в версии 3.7: Python явно гарантирует сохранение порядка объявления только-ключевых параметров начиная с версии 3.7, хотя на практике этот порядок всегда сохранялся в Python 3.352353#### `return_annotation`354355Аннотация «return» вызываемого объекта. Если у вызываемого объекта нет аннотации «return», этот атрибут устанавливается в [`Signature.empty`](https://python-all.ru/3.10/library/inspect.html#inspect.Signature.empty).356357#### `bind(*args, **kwargs)`358359Создаёт отображение позиционных и ключевых аргументов в параметры. Возвращает [`BoundArguments`](https://python-all.ru/3.10/library/inspect.html#inspect.BoundArguments), если `*args` и `**kwargs` соответствуют сигнатуре, или вызывает [`TypeError`](https://python-all.ru/3.10/library/exceptions.html#TypeError).360361#### `bind_partial(*args, **kwargs)`362363Работает так же, как [`Signature.bind()`](https://python-all.ru/3.10/library/inspect.html#inspect.Signature.bind), но позволяет опускать некоторые обязательные аргументы (имитирует поведение [`functools.partial()`](https://python-all.ru/3.10/library/functools.html#functools.partial)). Возвращает [`BoundArguments`](https://python-all.ru/3.10/library/inspect.html#inspect.BoundArguments) или вызывает [`TypeError`](https://python-all.ru/3.10/library/exceptions.html#TypeError), если переданные аргументы не соответствуют сигнатуре.364365#### `replace(*[, parameters][, return_annotation])`366367Создаёт новый экземпляр Signature на основе экземпляра, для которого был вызван replace. Можно передать другие `parameters` и/или `return_annotation`, чтобы переопределить соответствующие свойства базовой сигнатуры. Чтобы удалить return\_annotation из скопированной сигнатуры, укажите [`Signature.empty`](https://python-all.ru/3.10/library/inspect.html#inspect.Signature.empty).368369```python370>>> def test(a, b):371...     pass372>>> sig = signature(test)373>>> new_sig = sig.replace(return_annotation="new return anno")374>>> str(new_sig)375"(a, b) -> 'new return anno'"376```377378#### `classmethod from_callable(obj, *, follow_wrapped=True, globalns=None, localns=None)`379380Возвращает объект [`Signature`](https://python-all.ru/3.10/library/inspect.html#inspect.Signature) (или его подкласс) для заданного вызываемого объекта `obj`. Передайте `follow_wrapped=False`, чтобы получить сигнатуру `obj` без разворачивания цепочки `__wrapped__`. `globalns` и `localns` будут использоваться как пространства имён при разрешении аннотаций.381382Этот метод упрощает создание подклассов [`Signature`](https://python-all.ru/3.10/library/inspect.html#inspect.Signature):383384```python385class MySignature(Signature):386    pass387sig = MySignature.from_callable(min)388assert isinstance(sig, MySignature)389```390391Новое в версии 3.5.392393Новое в версии 3.10: `globalns` и `localns` параметры.394395#### `class inspect.Parameter(name, kind, *, default=Parameter.empty, annotation=Parameter.empty)`396397Объекты Parameter являются *неизменяемыми*. Вместо изменения объекта Parameter можно использовать [`Parameter.replace()`](https://python-all.ru/3.10/library/inspect.html#inspect.Parameter.replace) для создания изменённой копии.398399Изменено в версии 3.5: Объекты Parameter стали сериализуемыми (с помощью pickle) и [хешируемыми](https://python-all.ru/3.10/glossary.html#term-hashable).400401#### `empty`402403Специальный маркер уровня класса для указания отсутствия значений по умолчанию и аннотаций.404405#### `name`406407Имя параметра в виде строки. Имя должно быть допустимым идентификатором Python.408409**Особенности реализации CPython:** CPython генерирует неявные имена параметров вида `.0` в объектах кода, используемых для реализации включений (comprehensions) и выражений-генераторов.410411Изменено в версии 3.6: Имена этих параметров предоставляются данным модулем как имена: `implicit0`.412413#### `default`414415Значение параметра по умолчанию. Если у параметра нет значения по умолчанию, этот атрибут устанавливается в [`Parameter.empty`](https://python-all.ru/3.10/library/inspect.html#inspect.Parameter.empty).416417#### `annotation`418419Аннотация параметра. Если у параметра нет аннотации, этот атрибут устанавливается в [`Parameter.empty`](https://python-all.ru/3.10/library/inspect.html#inspect.Parameter.empty).420421#### `kind`422423Описывает, как значения аргументов привязываются к параметру. Возможные значения доступны через [`Parameter`](https://python-all.ru/3.10/library/inspect.html#inspect.Parameter) (например, `Parameter.KEYWORD_ONLY`), и поддерживают сравнение и упорядочивание в следующем порядке:424425| Имя | Значение |426| --- | --- |427| *POSITIONAL\_ONLY* | Значение должно передаваться как позиционный аргумент. Параметры только для позиционной передачи – это те, которые находятся перед записью `/` (если она присутствует) в определении функции Python. |428| *POSITIONAL\_OR\_KEYWORD* | Значение может передаваться как ключевой, так и позиционный аргумент (это стандартное поведение привязки для функций, реализованных на Python). |429| *VAR\_POSITIONAL* | Кортеж позиционных аргументов, которые не привязаны ни к одному другому параметру. Это соответствует параметру `*args` в определении функции Python. |430| *KEYWORD\_ONLY* | Значение должно передаваться как ключевой аргумент. Параметры только для ключевой передачи – это те, которые находятся после записи `*` или `*args` в определении функции Python. |431| *VAR\_KEYWORD* | Словарь ключевых аргументов, которые не привязаны ни к одному другому параметру. Это соответствует параметру `**kwargs` в определении функции Python. |432433Пример: вывод всех аргументов только для ключевой передачи без значений по умолчанию:434435```python436>>> def foo(a, b, *, c, d=10):437...     pass438439>>> sig = signature(foo)440>>> for param in sig.parameters.values():441...     if (param.kind == param.KEYWORD_ONLY and442...                        param.default is param.empty):443...         print('Parameter:', param)444Parameter: c445```446447#### `kind.description`448449Описывает значение перечисления Parameter.kind.450451Новое в версии 3.8.452453Пример: вывод всех описаний аргументов:454455```python456>>> def foo(a, b, *, c, d=10):457...     pass458459>>> sig = signature(foo)460>>> for param in sig.parameters.values():461...     print(param.kind.description)462positional or keyword463positional or keyword464keyword-only465keyword-only466```467468#### `replace(*[, name][, kind][, default][, annotation])`469470Создаёт новый экземпляр Parameter на основе экземпляра, для которого был вызван метод. Чтобы переопределить атрибут [`Parameter`](https://python-all.ru/3.10/library/inspect.html#inspect.Parameter), передайте соответствующий аргумент. Чтобы удалить значение по умолчанию и/или аннотацию из Parameter, передайте [`Parameter.empty`](https://python-all.ru/3.10/library/inspect.html#inspect.Parameter.empty).471472```python473>>> from inspect import Parameter474>>> param = Parameter('foo', Parameter.KEYWORD_ONLY, default=42)475>>> str(param)476'foo=42'477478>>> str(param.replace()) # Создаст поверхностную копию 'param'479'foo=42'480481>>> str(param.replace(default=Parameter.empty, annotation='spam'))482"foo:'spam'"483```484485Изменено в версии 3.4: В Python 3.3 объектам Parameter разрешалось иметь `name`, установленным в `None`, если их `kind` был установлен в `POSITIONAL_ONLY`. Теперь это запрещено.486487#### `class inspect.BoundArguments`488489Результат вызова [`Signature.bind()`](https://python-all.ru/3.10/library/inspect.html#inspect.Signature.bind) или [`Signature.bind_partial()`](https://python-all.ru/3.10/library/inspect.html#inspect.Signature.bind_partial). Содержит отображение аргументов на параметры функции.490491#### `arguments`492493Изменяемое отображение имён параметров на значения аргументов. Содержит только явно привязанные аргументы. Изменения в [`arguments`](https://python-all.ru/3.10/library/inspect.html#inspect.BoundArguments.arguments) отразятся в [`args`](https://python-all.ru/3.10/library/inspect.html#inspect.BoundArguments.args) и [`kwargs`](https://python-all.ru/3.10/library/inspect.html#inspect.BoundArguments.kwargs).494495Следует использовать совместно с [`Signature.parameters`](https://python-all.ru/3.10/library/inspect.html#inspect.Signature.parameters) для любых целей обработки аргументов.496497> **Примечание**498>499> Аргументы, для которых [`Signature.bind()`](https://python-all.ru/3.10/library/inspect.html#inspect.Signature.bind) или [`Signature.bind_partial()`](https://python-all.ru/3.10/library/inspect.html#inspect.Signature.bind_partial) полагались на значение по умолчанию, пропускаются. Однако при необходимости используйте [`BoundArguments.apply_defaults()`](https://python-all.ru/3.10/library/inspect.html#inspect.BoundArguments.apply_defaults), чтобы добавить их.500501Изменено в версии 3.9: [`arguments`](https://python-all.ru/3.10/library/inspect.html#inspect.BoundArguments.arguments) теперь имеет тип [`dict`](https://python-all.ru/3.10/library/stdtypes.html#dict). Ранее он имел тип [`collections.OrderedDict`](https://python-all.ru/3.10/library/collections.html#collections.OrderedDict).502503#### `args`504505Кортеж значений позиционных аргументов. Динамически вычисляется из атрибута [`arguments`](https://python-all.ru/3.10/library/inspect.html#inspect.BoundArguments.arguments).506507#### `kwargs`508509Словарь значений именованных аргументов. Вычисляется динамически из атрибута [`arguments`](https://python-all.ru/3.10/library/inspect.html#inspect.BoundArguments.arguments).510511#### `signature`512513Ссылка на родительский объект [`Signature`](https://python-all.ru/3.10/library/inspect.html#inspect.Signature).514515#### `apply_defaults()`516517Устанавливает значения по умолчанию для отсутствующих аргументов.518519Для переменных позиционных аргументов (`*args`) значением по умолчанию является пустой кортеж.520521Для переменных именованных аргументов (`**kwargs`) значением по умолчанию является пустой словарь.522523```python524>>> def foo(a, b='ham', *args): pass525>>> ba = inspect.signature(foo).bind('spam')526>>> ba.apply_defaults()527>>> ba.arguments528{'a': 'spam', 'b': 'ham', 'args': ()}529```530531Новое в версии 3.5.532533Свойства [`args`](https://python-all.ru/3.10/library/inspect.html#inspect.BoundArguments.args) и [`kwargs`](https://python-all.ru/3.10/library/inspect.html#inspect.BoundArguments.kwargs) можно использовать для вызова функций:534535```python536def test(a, *, b):537    ...538539sig = signature(test)540ba = sig.bind(10, b=20)541test(*ba.args, **ba.kwargs)542```543544> **См. также**545>546> **[**PEP 362**](https://python-all.ru/3.10/library/inspect.html) – объект сигнатуры функции.**547>548> Подробная спецификация, детали реализации и примеры.549550## Классы и функции551552#### `inspect.getclasstree(classes, unique=False)`553554Упорядочивает заданный список классов в иерархию вложенных списков. Если встречается вложенный список, он содержит классы, унаследованные от класса, запись которого непосредственно предшествует этому списку. Каждая запись представляет собой кортеж из двух элементов, содержащий класс и кортеж его базовых классов. Если аргумент *unique* равен true, в возвращаемой структуре появляется ровно одна запись для каждого класса из заданного списка. В противном случае классы, использующие множественное наследование, и их потомки будут появляться несколько раз.555556#### `inspect.getargspec(func)`557558Получает имена и значения по умолчанию параметров функции Python. Возвращается [именованный кортеж](https://python-all.ru/3.10/glossary.html#term-named-tuple) `ArgSpec(args, varargs, keywords, defaults)`. *args* – список имён параметров. *varargs* и *keywords* – это имена параметров `*` и `**`, либо `None`. *defaults* – кортеж значений аргументов по умолчанию или `None`, если аргументов по умолчанию нет; если этот кортеж содержит *n* элементов, они соответствуют последним *n* элементам, перечисленным в *args*.559560Устарело с версии 3.0: Используйте [`getfullargspec()`](https://python-all.ru/3.10/library/inspect.html#inspect.getfullargspec) для обновлённого API, который обычно является взаимозаменяемой заменой, но также корректно обрабатывает аннотации функций и параметры только для ключевых слов.561562Кроме того, используйте [`signature()`](https://python-all.ru/3.10/library/inspect.html#inspect.signature) и [Signature Object](https://python-all.ru/3.10/library/inspect.html#inspect-signature-object), которые предоставляют более структурированный API интроспекции для вызываемых объектов.563564#### `inspect.getfullargspec(func)`565566Возвращает имена и значения по умолчанию параметров функции Python. Возвращается [именованный кортеж](https://python-all.ru/3.10/glossary.html#term-named-tuple):567568`FullArgSpec(args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, annotations)`569570*args* – это список имён позиционных параметров. *varargs* – это имя параметра `*` или `None`, если произвольные позиционные аргументы не принимаются. *varkw* – это имя параметра `**` или `None`, если произвольные именованные аргументы не принимаются. *defaults* – это *n*-кортеж значений аргументов по умолчанию, соответствующих последним *n* позиционным параметрам, или `None`, если такие значения по умолчанию не определены. *kwonlyargs* – это список имён только именованных параметров в порядке объявления. *kwonlydefaults* – это словарь, сопоставляющий имена параметров из *kwonlyargs* со значениями по умолчанию, используемыми, если аргумент не передан. *annotations* – это словарь, сопоставляющий имена параметров с аннотациями. Специальный ключ `"return"` используется для указания аннотации возвращаемого значения функции (если есть).571572Обратите внимание, что [`signature()`](https://python-all.ru/3.10/library/inspect.html#inspect.signature) и [объект Signature](https://python-all.ru/3.10/library/inspect.html#inspect-signature-object) предоставляют рекомендуемый API для интроспекции вызываемых объектов и поддерживают дополнительное поведение (например, позиционные аргументы), которое иногда встречается в API модулей расширения. Эта функция сохранена в основном для использования в коде, которому необходима совместимость с API модуля Python 2 `inspect`.573574Изменено в версии 3.4: Эта функция теперь основана на [`signature()`](https://python-all.ru/3.10/library/inspect.html#inspect.signature), но по-прежнему игнорирует атрибуты `__wrapped__` и включает уже привязанный первый параметр в вывод сигнатуры для связанных методов.575576Изменено в версии 3.6: Ранее этот метод был объявлен устаревшим в пользу [`signature()`](https://python-all.ru/3.10/library/inspect.html#inspect.signature) в Python 3.5, но это решение было отменено, чтобы восстановить чётко поддерживаемый стандартный интерфейс для кода на Python 2/3 из одного источника, который мигрирует от устаревшего API [`getargspec()`](https://python-all.ru/3.10/library/inspect.html#inspect.getargspec).577578Изменено в версии 3.7: Python явно гарантирует сохранение порядка объявления только-ключевых параметров начиная с версии 3.7, хотя на практике этот порядок всегда сохранялся в Python 3.579580#### `inspect.getargvalues(frame)`581582Извлекает информацию об аргументах, переданных в заданный фрейм. Возвращается [именованный кортеж](https://python-all.ru/3.10/glossary.html#term-named-tuple) `ArgInfo(args, varargs, keywords, locals)`. *args* – список имён аргументов. *varargs* и *keywords* – имена аргументов `*` и `**` или `None`. *locals* – это словарь локальных переменных данного фрейма.583584> **Примечание**585>586> Эта функция была ошибочно помечена как устаревшая в Python 3.5.587588#### `inspect.formatargspec(args[, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, annotations[, formatarg, formatvarargs, formatvarkw, formatvalue, formatreturns, formatannotations]])`589590Форматирует красивое описание аргументов на основе значений, возвращённых [`getfullargspec()`](https://python-all.ru/3.10/library/inspect.html#inspect.getfullargspec).591592Первые семь аргументов: (`args`, `varargs`, `varkw`, `defaults`, `kwonlyargs`, `kwonlydefaults`, `annotations`).593594Остальные шесть аргументов – это функции, которые вызываются для преобразования имён аргументов, имени аргумента `*`, имени аргумента `**`, значений по умолчанию, аннотации возвращаемого значения и отдельных аннотаций в строки соответственно.595596Например:597598```python599>>> from inspect import formatargspec, getfullargspec600>>> def f(a: int, b: float):601...     pass602...603>>> formatargspec(*getfullargspec(f))604'(a: int, b: float)'605```606607Устарело с версии 3.5: Используйте [`signature()`](https://python-all.ru/3.10/library/inspect.html#inspect.signature) и [Signature Object](https://python-all.ru/3.10/library/inspect.html#inspect-signature-object), которые предоставляют лучший API интроспекции для вызываемых объектов.608609#### `inspect.formatargvalues(args[, varargs, varkw, locals, formatarg, formatvarargs, formatvarkw, formatvalue])`610611Форматирует красивое описание аргументов из четырёх значений, возвращаемых [`getargvalues()`](https://python-all.ru/3.10/library/inspect.html#inspect.getargvalues). Аргументы format\* – это соответствующие опциональные функции форматирования, которые вызываются для преобразования имён и значений в строки.612613> **Примечание**614>615> Эта функция была ошибочно помечена как устаревшая в Python 3.5.616617#### `inspect.getmro(cls)`618619Возвращает кортеж базовых классов класса cls, включая cls, в порядке разрешения методов (MRO). Ни один класс не встречается в этом кортеже более одного раза. Обратите внимание, что порядок разрешения методов зависит от типа cls. Если не используется особенная пользовательская метатипизация, cls будет первым элементом кортежа.620621#### `inspect.getcallargs(func, /, *args, **kwds)`622623Связывает *args* и *kwds* с именами аргументов функции или метода Python *func*, как если бы она была вызвана с ними. Для связанных методов (bound methods) также связывает первый аргумент (обычно названный `self`) с соответствующим экземпляром. Возвращается словарь, отображающий имена аргументов (включая имена аргументов `*` и `**`, если они есть) на их значения из *args* и *kwds*. В случае неправильного вызова *func*, т.е. когда `func(*args, **kwds)` возбудило бы исключение из-за несовместимой сигнатуры, возбуждается исключение того же типа и с тем же или похожим сообщением. Например:624625```python626>>> from inspect import getcallargs627>>> def f(a, b=1, *pos, **named):628...     pass629>>> getcallargs(f, 1, 2, 3) == {'a': 1, 'named': {}, 'b': 2, 'pos': (3,)}630True631>>> getcallargs(f, a=2, x=4) == {'a': 2, 'named': {'x': 4}, 'b': 1, 'pos': ()}632True633>>> getcallargs(f)634Traceback (most recent call last):635...636TypeError: f() missing 1 required positional argument: 'a'637```638639Новое в версии 3.2.640641Устарело с версии 3.5: Используйте [`Signature.bind()`](https://python-all.ru/3.10/library/inspect.html#inspect.Signature.bind) и [`Signature.bind_partial()`](https://python-all.ru/3.10/library/inspect.html#inspect.Signature.bind_partial) вместо этого.642643#### `inspect.getclosurevars(func)`644645Извлекает отображение ссылок на внешние имена в функции или методе Python *func* на их текущие значения. Возвращается [именованный кортеж](https://python-all.ru/3.10/glossary.html#term-named-tuple) `ClosureVars(nonlocals, globals, builtins, unbound)`. *nonlocals* отображает ссылочные имена на переменные лексического замыкания, *globals* – на глобальные переменные модуля функции, а *builtins* – на встроенные имена, видимые из тела функции. *unbound* – множество имён, на которые есть ссылки в функции, но которые не удалось разрешить при текущих глобальных переменных модуля и встроенных именах.646647[`TypeError`](https://python-all.ru/3.10/library/exceptions.html#TypeError) возбуждается, если *func* не является функцией или методом Python.648649Новое в версии 3.3.650651#### `inspect.unwrap(func, *, stop=None)`652653Получает объект, обёрнутый в *func*. Следует по цепочке атрибутов `__wrapped__`, возвращая последний объект в цепочке.654655*stop* – опциональный колбэк, принимающий объект в цепочке обёрток в качестве единственного аргумента, который позволяет досрочно завершить разворачивание, если колбэк возвращает истинное значение. Если колбэк никогда не возвращает истинное значение, возвращается последний объект в цепочке как обычно. Например, [`signature()`](https://python-all.ru/3.10/library/inspect.html#inspect.signature) использует это, чтобы остановить разворачивание, если какой-либо объект в цепочке имеет определённый атрибут `__signature__`.656657[`ValueError`](https://python-all.ru/3.10/library/exceptions.html#ValueError) возбуждается, если обнаружен цикл.658659Новое в версии 3.4.660661#### `inspect.get_annotations(obj, *, globals=None, locals=None, eval_str=False)`662663Вычисляет словарь аннотаций для объекта.664665`obj` может быть вызываемым объектом, классом или модулем. Передача объекта любого другого типа вызывает [`TypeError`](https://python-all.ru/3.10/library/exceptions.html#TypeError).666667Возвращает словарь. `get_annotations()` каждый раз возвращает новый словарь; два его вызова для одного и того же объекта вернут два разных, но эквивалентных словаря.668669Эта функция обрабатывает несколько деталей:670671- Если `eval_str` истинно, значения типа `str` будут преобразованы из строки с помощью [`eval()`](https://python-all.ru/3.10/library/functions.html#eval). Это предназначено для использования со строковыми аннотациями (`from __future__ import annotations`).672- Если у `obj` нет словаря аннотаций, возвращает пустой словарь. (Функции и методы всегда имеют словарь аннотаций; классы, модули и другие типы вызываемых объектов – не обязательно.)673- Игнорирует унаследованные аннотации классов. Если класс не имеет собственного словаря аннотаций, возвращает пустой словарь.674- Все обращения к членам объекта и значениям словаря выполняются с использованием `getattr()` и `dict.get()` для безопасности.675- Всегда возвращает только что созданный словарь.676677`eval_str` управляет тем, заменяются ли значения типа `str` на результат вызова [`eval()`](https://python-all.ru/3.10/library/functions.html#eval) для этих значений:678679- Если eval\_str истинно, [`eval()`](https://python-all.ru/3.10/library/functions.html#eval) вызывается для значений типа `str`. (Обратите внимание, что `get_annotations` не перехватывает исключения; если [`eval()`](https://python-all.ru/3.10/library/functions.html#eval) выбрасывает исключение, оно раскрутит стек за пределы вызова `get_annotations`.)680- Если eval\_str равен false (по умолчанию), значения типа `str` не изменяются.681682`globals` и `locals` передаются в [`eval()`](https://python-all.ru/3.10/library/functions.html#eval); обратитесь к документации по [`eval()`](https://python-all.ru/3.10/library/functions.html#eval) для получения дополнительной информации. Если `globals` или `locals` равны `None`, эта функция может заменить это значение на контекстно-зависимое значение по умолчанию, в зависимости от `type(obj)`:683684- Если `obj` является модулем, `globals` по умолчанию принимает значение `obj.__dict__`.685- Если `obj` является классом, `globals` по умолчанию принимает значение `sys.modules[obj.__module__].__dict__`, а `locals` по умолчанию принимает пространство имён класса `obj`.686- Если `obj` является вызываемым объектом, `globals` по умолчанию равен `obj.__globals__`, однако если `obj` – это обёрнутая функция (с помощью `functools.update_wrapper()`), то сначала выполняется разворачивание.687688Вызов `get_annotations` является наилучшей практикой для доступа к словарю аннотаций любого объекта. См. [Annotations Best Practices](https://python-all.ru/3.10/howto/annotations.html#annotations-howto) для получения дополнительной информации о лучших практиках работы с аннотациями.689690Новое в версии 3.10.691692## Стек интерпретатора693694Когда следующие функции возвращают «записи о фреймах», каждая запись представляет собой [именованный кортеж](https://python-all.ru/3.10/glossary.html#term-named-tuple) `FrameInfo(frame, filename, lineno, function, code_context, index)`. Кортеж содержит объект фрейма, имя файла, номер текущей строки, имя функции, список строк контекста из исходного кода и индекс текущей строки в этом списке.695696Изменено в версии 3.5: Возвращает именованный кортеж вместо кортежа.697698> **Примечание**699>700> Хранение ссылок на объекты фреймов (как в первом элементе записей фреймов, возвращаемых этими функциями) может привести к созданию циклических ссылок в программе. После создания циклической ссылки время жизни всех объектов, доступных из объектов, образующих цикл, может значительно увеличиться, даже если включён дополнительный детектор циклов Python. Если такие циклы необходимо создать, важно убедиться, что они явно разрываются, чтобы избежать задержки уничтожения объектов и увеличения потребления памяти.701>702> Хотя детектор циклов поймает их, уничтожение фреймов (и локальных переменных) можно сделать детерминированным, удалив цикл в предложении [`finally`](https://python-all.ru/3.10/reference/compound_stmts.html#finally). Это также важно, если детектор циклов был отключён при компиляции Python или с помощью [`gc.disable()`](https://python-all.ru/3.10/library/gc.html#gc.disable). Например:703>704> ```python705> def handle_stackframe_without_leak():706>     frame = inspect.currentframe()707>     try:708>         # Выполнить действие с фреймом709>     finally:710>         del frame711> ```712>713> Если нужно сохранить фрейм (например, для последующего вывода traceback), можно также разорвать циклические ссылки с помощью метода [`frame.clear()`](https://python-all.ru/3.10/reference/datamodel.html#frame.clear).714715Необязательный аргумент *context*, поддерживаемый большинством этих функций, задаёт количество возвращаемых строк контекста, которые располагаются вокруг текущей строки.716717#### `inspect.getframeinfo(frame, context=1)`718719Возвращает информацию об объекте фрейма или traceback. Возвращается [именованный кортеж](https://python-all.ru/3.10/glossary.html#term-named-tuple) `Traceback(filename, lineno, function, code_context, index)`.720721#### `inspect.getouterframes(frame, context=1)`722723Возвращает список записей о фреймах для фрейма и всех внешних фреймов. Эти фреймы представляют вызовы, которые привели к созданию *frame*. Первый элемент возвращаемого списка представляет *frame*; последний элемент представляет самый внешний вызов в стеке *frame*.724725Изменено в версии 3.5: Возвращается список [именованных кортежей](https://python-all.ru/3.10/glossary.html#term-named-tuple) `FrameInfo(frame, filename, lineno, function, code_context, index)`.726727#### `inspect.getinnerframes(traceback, context=1)`728729Возвращает список записей о фреймах для фрейма traceback и всех внутренних фреймов. Эти фреймы представляют вызовы, являющиеся следствием *frame*. Первый элемент списка представляет *traceback*; последний элемент представляет место, где было возбуждено исключение.730731Изменено в версии 3.5: Возвращается список [именованных кортежей](https://python-all.ru/3.10/glossary.html#term-named-tuple) `FrameInfo(frame, filename, lineno, function, code_context, index)`.732733#### `inspect.currentframe()`734735Возвращает объект фрейма для фрейма стека вызывающего.736737**Особенность реализации CPython:** Эта функция полагается на поддержку фреймов стека Python в интерпретаторе, которая не гарантируется во всех реализациях Python. Если запустить в реализации без поддержки фреймов стека Python, эта функция возвращает `None`.738739#### `inspect.stack(context=1)`740741Возвращает список записей о фреймах для стека вызывающего кода. Первый элемент возвращаемого списка представляет вызывающий код; последний элемент представляет самый внешний вызов в стеке.742743Изменено в версии 3.5: Возвращается список [именованных кортежей](https://python-all.ru/3.10/glossary.html#term-named-tuple) `FrameInfo(frame, filename, lineno, function, code_context, index)`.744745#### `inspect.trace(context=1)`746747Возвращает список записей о фреймах для стека между текущим фреймом и фреймом, в котором было возбуждено исключение, обрабатываемое в данный момент. Первый элемент списка представляет вызывающий код; последний элемент представляет место, где было возбуждено исключение.748749Изменено в версии 3.5: Возвращается список [именованных кортежей](https://python-all.ru/3.10/glossary.html#term-named-tuple) `FrameInfo(frame, filename, lineno, function, code_context, index)`.750751## Статическое получение атрибутов752753И [`getattr()`](https://python-all.ru/3.10/library/functions.html#getattr), и [`hasattr()`](https://python-all.ru/3.10/library/functions.html#hasattr) могут инициировать выполнение кода при получении или проверке существования атрибутов. Дескрипторы, такие как свойства, будут вызваны, а `__getattr__()` и `__getattribute__()` могут быть вызваны.754755В случаях, когда нужна пассивная интроспекция (например, для инструментов документирования), это может быть неудобно. [`getattr_static()`](https://python-all.ru/3.10/library/inspect.html#inspect.getattr_static) имеет ту же сигнатуру, что и [`getattr()`](https://python-all.ru/3.10/library/functions.html#getattr), но не выполняет код при получении атрибутов.756757#### `inspect.getattr_static(obj, attr, default=None)`758759Извлекает атрибуты без запуска динамического поиска через протокол дескрипторов, `__getattr__()` или `__getattribute__()`.760761Примечание: эта функция может быть не в состоянии получить все атрибуты, которые может получить getattr (например, динамически созданные атрибуты), и может найти атрибуты, которые getattr не может (например, дескрипторы, вызывающие AttributeError). Она также может возвращать объекты дескрипторов вместо членов экземпляра.762763Если атрибут экземпляра [`__dict__`](https://python-all.ru/3.10/library/stdtypes.html#object.__dict__) скрыт другим членом (например, свойством), то эта функция не сможет найти члены экземпляра.764765Новое в версии 3.2.766767[`getattr_static()`](https://python-all.ru/3.10/library/inspect.html#inspect.getattr_static) не разрешает дескрипторы, например, дескрипторы слотов или getset-дескрипторы объектов, реализованных на C. Возвращается объект дескриптора, а не базовый атрибут.768769С ними можно работать с помощью кода вроде следующего. Обратите внимание, что для произвольных getset-дескрипторов их вызов может запустить выполнение кода:770771```python772# Пример кода для разрешения встроенных типов дескрипторов773class _foo:774    __slots__ = ['foo']775776slot_descriptor = type(_foo.foo)777getset_descriptor = type(type(open(__file__)).name)778wrapper_descriptor = type(str.__dict__['__add__'])779descriptor_types = (slot_descriptor, getset_descriptor, wrapper_descriptor)780781result = getattr_static(some_object, 'foo')782if type(result) in descriptor_types:783    try:784        result = result.__get__()785    except AttributeError:786        # Дескрипторы могут вызывать AttributeError, чтобы787        # указать, что нет нижележащего значения788        # в этом случае сам дескриптор будет789        # придется сделать790        pass791```792793## Текущее состояние генераторов и корутин794795При реализации планировщиков корутин и для других продвинутых случаев использования генераторов полезно определять, выполняется ли генератор в данный момент, ожидает запуска или возобновления, или уже завершился. [`getgeneratorstate()`](https://python-all.ru/3.10/library/inspect.html#inspect.getgeneratorstate) позволяет легко определить текущее состояние генератора.796797#### `inspect.getgeneratorstate(generator)`798799Возвращает текущее состояние генератора-итератора.800801**Возможные состояния:**802803- GEN\_CREATED: Ожидание начала выполнения.804- GEN\_RUNNING: В настоящее время выполняется интерпретатором.805- GEN\_SUSPENDED: в данный момент приостановлена на выражении yield.806- GEN\_CLOSED: выполнение завершено.807808Новое в версии 3.2.809810#### `inspect.getcoroutinestate(coroutine)`811812Получить текущее состояние объекта корутины. Эта функция предназначена для использования с объектами корутин, созданными функциями [`async def`](https://python-all.ru/3.10/reference/compound_stmts.html#async-def), но принимает любой объект, похожий на корутину, который имеет атрибуты `cr_running` и `cr_frame`.813814**Возможные состояния:**815816- CORO\_CREATED: ожидает начала выполнения.817- CORO\_RUNNING: в данный момент выполняется интерпретатором.818- CORO\_SUSPENDED: в данный момент приостановлена на выражении await.819- CORO\_CLOSED: выполнение завершено.820821Новое в версии 3.5.822823Текущее внутреннее состояние генератора также можно запросить. Это полезно в основном для целей тестирования, чтобы убедиться, что внутреннее состояние обновляется должным образом:824825#### `inspect.getgeneratorlocals(generator)`826827Получить соответствие текущих значений активных локальных переменных в *generator*. Возвращается словарь, отображающий имена переменных в их значения. Это эквивалентно вызову [`locals()`](https://python-all.ru/3.10/library/functions.html#locals) в теле генератора, и действуют все те же предостережения.828829Если *generator* является [генератором](https://python-all.ru/3.10/glossary.html#term-generator) без текущего связанного фрейма, возвращается пустой словарь. [`TypeError`](https://python-all.ru/3.10/library/exceptions.html#TypeError) возникает, если *generator* не является объектом генератора Python.830831**Деталь реализации CPython:** Эта функция полагается на то, что генератор предоставляет стековый фрейм Python для интроспекции, что не гарантируется во всех реализациях Python. В таких случаях эта функция всегда будет возвращать пустой словарь.832833Новое в версии 3.3.834835#### `inspect.getcoroutinelocals(coroutine)`836837Эта функция аналогична [`getgeneratorlocals()`](https://python-all.ru/3.10/library/inspect.html#inspect.getgeneratorlocals), но работает для объектов корутин, созданных функциями [`async def`](https://python-all.ru/3.10/reference/compound_stmts.html#async-def).838839Новое в версии 3.5.840841## Битовые флаги объектов кода842843Объекты кода Python имеют атрибут `co_flags`, представляющий собой битовую маску следующих флагов:844845#### `inspect.CO_OPTIMIZED`846847Объект кода оптимизирован с использованием быстрых локальных переменных.848849#### `inspect.CO_NEWLOCALS`850851Если установлен, при выполнении объекта кода будет создан новый словарь для `f_locals` фрейма.852853#### `inspect.CO_VARARGS`854855Объект кода имеет переменный позиционный параметр (аналог `*args`).856857#### `inspect.CO_VARKEYWORDS`858859Объект кода имеет переменный ключевой параметр (аналог `**kwargs`).860861#### `inspect.CO_NESTED`862863Флаг устанавливается, когда объект кода представляет собой вложенную функцию.864865#### `inspect.CO_GENERATOR`866867Флаг устанавливается, когда объект кода является функцией-генератором, т.е. при выполнении объекта кода возвращается объект генератора.868869#### `inspect.CO_NOFREE`870871Флаг установлен, если нет свободных переменных или переменных ячейки.872873#### `inspect.CO_COROUTINE`874875Флаг устанавливается, когда объект кода является корутинной функцией. При выполнении объекта кода возвращается объект корутины. Подробнее см. [**PEP 492**](https://python-all.ru/3.10/library/inspect.html).876877Новое в версии 3.5.878879#### `inspect.CO_ITERABLE_COROUTINE`880881Флаг используется для преобразования генераторов в корутины на основе генераторов. Объекты-генераторы с этим флагом можно использовать в выражении `await`, и они могут `yield from` объекты корутин. Подробнее см. [**PEP 492**](https://python-all.ru/3.10/library/inspect.html).882883Новое в версии 3.5.884885#### `inspect.CO_ASYNC_GENERATOR`886887Флаг устанавливается, когда объект кода является асинхронной функцией-генератором. При выполнении объекта кода возвращается объект асинхронного генератора. Подробнее см. [**PEP 525**](https://python-all.ru/3.10/library/inspect.html).888889Новое в версии 3.6.890891> **Примечание**892>893> Эти флаги специфичны для CPython и могут быть не определены в других реализациях Python. Кроме того, флаги являются деталью реализации и могут быть удалены или объявлены устаревшими в будущих версиях Python. Для любых задач интроспекции рекомендуется использовать публичные API из модуля [`inspect`](https://python-all.ru/3.10/library/inspect.html#module-inspect).894895## Интерфейс командной строки896897Модуль [`inspect`](https://python-all.ru/3.10/library/inspect.html#module-inspect) также предоставляет базовые возможности интроспекции из командной строки.898899По умолчанию принимает имя модуля и выводит его исходный код. Класс или функцию внутри модуля можно вывести, добавив двоеточие и полное имя целевого объекта.900901#### `--details`902903Выводит информацию об указанном объекте, а не его исходный код.904