`inspect.md`

1053 строк · 93.8 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.12/library/inspect.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# `inspect` – Инспекция живых объектов89**Исходный код:** [Lib/inspect.py](https://python-all.ru/src/3.12/Lib/inspect.py)1011---1213Модуль [`inspect`](https://python-all.ru/3.12/library/inspect.html#module-inspect) предоставляет несколько полезных функций для получения информации о живых объектах, таких как модули, классы, методы, функции, трассировки, объекты кадров и объекты кода. Например, он позволяет изучить содержимое класса, получить исходный код метода, извлечь и отформатировать список аргументов функции или получить всю информацию, необходимую для вывода подробной трассировки.1415Этот модуль предоставляет четыре основных вида сервисов: проверка типов, получение исходного кода, инспекция классов и функций, а также анализ стека интерпретатора.1617## Типы и члены1819Функция [`getmembers()`](https://python-all.ru/3.12/library/inspect.html#inspect.getmembers) получает члены объекта, например класса или модуля. Функции, имена которых начинаются с «is», в основном предоставляются как удобный выбор для второго аргумента [`getmembers()`](https://python-all.ru/3.12/library/inspect.html#inspect.getmembers). Они также помогают определить, когда можно ожидать следующие специальные атрибуты (см. [Атрибуты, связанные с импортом, у объектов модулей](https://python-all.ru/3.12/reference/datamodel.html#import-mod-attrs) для атрибутов модуля):2021| Тип | Атрибут | Описание |22| --- | --- | --- |23| класс | doc | строка документации |24|  | name | имя, под которым был определён этот класс |25|  | qualname | полное имя |26|  | module | имя модуля, в котором был определён этот класс |27|  | type\_params | Кортеж, содержащий [параметры типа](https://python-all.ru/3.12/reference/compound_stmts.html#type-params) обобщённого класса |28| метод | doc | строка документации |29|  | name | имя, под которым был определён этот метод |30|  | qualname | полное имя |31|  | func | объект функции, содержащий реализацию метода |32|  | self | экземпляр, к которому привязан этот метод, или `None` |33|  | module | имя модуля, в котором был определён этот метод |34| функция | doc | строка документации |35|  | name | имя, под которым была определена эта функция |36|  | qualname | полное имя |37|  | code | объект кода, содержащий скомпилированную функцию [байткод](https://python-all.ru/3.12/glossary.html#term-bytecode) |38|  | defaults | кортеж значений по умолчанию для позиционных или именованных параметров |39|  | kwdefaults | отображение значений по умолчанию для параметров, доступных только по ключевым словам |40|  | globals | глобальное пространство имён, в котором была определена эта функция |41|  | builtins | пространство имён builtins |42|  | annotations | отображение имён параметров в аннотации; ключ `"return"` зарезервирован для аннотаций возвращаемого значения. |43|  | type\_params | Кортеж, содержащий [параметры типа](https://python-all.ru/3.12/reference/compound_stmts.html#type-params) обобщённой функции |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.12/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\_qualname | полное квалифицированное имя, с которым был определён этот объект кода |70|  | co\_names | кортеж имён, отличных от аргументов и локальных переменных функции |71|  | co\_nlocals | количество локальных переменных |72|  | co\_stacksize | требуемый размер стека виртуальной машины |73|  | co\_varnames | кортеж имён аргументов и локальных переменных |74| генератор | name | имя |75|  | qualname | полное имя |76|  | gi\_frame | фрейм |77|  | gi\_running | выполняется ли генератор? |78|  | gi\_code | код |79|  | gi\_yieldfrom | объект, итерируемый `yield from`, или `None` |80| асинхронный генератор | name | имя |81|  | qualname | полное имя |82|  | ag\_await | ожидаемый объект, или `None` |83|  | ag\_frame | фрейм |84|  | ag\_running | выполняется ли генератор? |85|  | ag\_code | код |86| корутина | name | имя |87|  | qualname | полное имя |88|  | cr\_await | ожидаемый объект, или `None` |89|  | cr\_frame | фрейм |90|  | cr\_running | выполняется ли корутина? |91|  | cr\_code | код |92|  | cr\_origin | где была создана корутина, или `None`. См. [`sys.set_coroutine_origin_tracking_depth()`](https://python-all.ru/3.12/library/sys.html#sys.set_coroutine_origin_tracking_depth) |93| встроенный | doc | строка документации |94|  | name | исходное имя этой функции или метода |95|  | qualname | полное имя |96|  | self | экземпляр, к которому привязан метод, или `None` |9798Изменено в версии 3.5: Добавлены атрибуты `__qualname__` и `gi_yieldfrom` для генераторов.99100Атрибут `__name__` генераторов теперь устанавливается из имени функции, а не из имени кода, и его можно изменять.101102Изменено в версии 3.7: Добавлен атрибут `cr_origin` для корутин.103104Изменено в версии 3.10: Добавлен атрибут `__builtins__` для функций.105106#### `inspect.getmembers(object[, predicate])`107108Возвращает все члены объекта в виде списка пар `(name, value)`, отсортированных по имени. Если передан необязательный аргумент *predicate* – который будет вызван с объектом `value` каждого члена, – включаются только те члены, для которых предикат возвращает истинное значение.109110> **Примечание**111>112> [`getmembers()`](https://python-all.ru/3.12/library/inspect.html#inspect.getmembers) возвращает только атрибуты класса, определённые в метаклассе, когда аргумент является классом, и эти атрибуты были перечислены в пользовательском [`__dir__()`](https://python-all.ru/3.12/reference/datamodel.html#object.__dir__) метакласса.113114#### `inspect.getmembers_static(object[, predicate])`115116Возвращает все члены объекта в виде списка пар `(name, value)`, отсортированных по имени, без запуска динамического поиска через протокол дескриптора, \_\_getattr\_\_ или \_\_getattribute\_\_. При необходимости возвращает только те члены, которые удовлетворяют заданному предикату.117118> **Примечание**119>120> [`getmembers_static()`](https://python-all.ru/3.12/library/inspect.html#inspect.getmembers_static) может не смочь получить все члены, которые может получить getmembers (например, динамически созданные атрибуты), и может найти члены, которые getmembers не может (например, дескрипторы, вызывающие AttributeError). В некоторых случаях она также может возвращать объекты дескрипторов вместо членов экземпляра.121122Добавлено в версии 3.12.123124#### `inspect.getmodulename(path)`125126Возвращает имя модуля, заданного файлом *path*, без включения имён объемлющих пакетов. Расширение файла проверяется по всем записям в [`importlib.machinery.all_suffixes()`](https://python-all.ru/3.12/library/importlib.html#importlib.machinery.all_suffixes). Если совпадение найдено, возвращается последний компонент пути с удалённым расширением. В противном случае возвращается `None`.127128Обратите внимание, что эта функция *только* возвращает осмысленное имя для реальных модулей Python – пути, которые потенциально относятся к пакетам Python, всё равно вернут `None`.129130Изменено в версии 3.3: Функция теперь основана непосредственно на [`importlib`](https://python-all.ru/3.12/library/importlib.html#module-importlib).131132#### `inspect.ismodule(object)`133134Возвращает `True`, если объект является модулем.135136#### `inspect.isclass(object)`137138Возвращает `True`, если объект является классом, встроенным или созданным в коде Python.139140#### `inspect.ismethod(object)`141142Возвращает `True`, если объект – связанный метод, написанный на Python.143144#### `inspect.isfunction(object)`145146Возвращает `True`, если объект является функцией Python, включая функции, созданные с помощью [lambda](https://python-all.ru/3.12/glossary.html#term-lambda)-выражения.147148#### `inspect.isgeneratorfunction(object)`149150Возвращает `True`, если объект является функцией-генератором Python.151152Изменено в версии 3.8: Функции, обёрнутые в [`functools.partial()`](https://python-all.ru/3.12/library/functools.html#functools.partial), теперь возвращают `True`, если обёрнутая функция является функцией-генератором Python.153154#### `inspect.isgenerator(object)`155156Возвращает `True`, если объект является генератором.157158#### `inspect.iscoroutinefunction(object)`159160Возвращает `True`, если объект является [корутинной функцией](https://python-all.ru/3.12/glossary.html#term-coroutine-function) (функцией, определённой с синтаксисом [`async def`](https://python-all.ru/3.12/reference/compound_stmts.html#async-def)), [`functools.partial()`](https://python-all.ru/3.12/library/functools.html#functools.partial), обёртывающей [корутинную функцию](https://python-all.ru/3.12/glossary.html#term-coroutine-function), или синхронной функцией, помеченной [`markcoroutinefunction()`](https://python-all.ru/3.12/library/inspect.html#inspect.markcoroutinefunction).161162Добавлено в версии 3.5.163164Изменено в версии 3.8: Функции, обёрнутые в [`functools.partial()`](https://python-all.ru/3.12/library/functools.html#functools.partial), теперь возвращают `True`, если обёрнутая функция является [корутинной функцией](https://python-all.ru/3.12/glossary.html#term-coroutine-function).165166Изменено в версии 3.12: Синхронные функции, помеченные [`markcoroutinefunction()`](https://python-all.ru/3.12/library/inspect.html#inspect.markcoroutinefunction), теперь возвращают `True`.167168#### `inspect.markcoroutinefunction(func)`169170Декоратор для пометки вызываемого объекта как [корутинной функции](https://python-all.ru/3.12/glossary.html#term-coroutine-function), если он не будет обнаружен [`iscoroutinefunction()`](https://python-all.ru/3.12/library/inspect.html#inspect.iscoroutinefunction) иным образом.171172Это может быть полезно для синхронных функций, которые возвращают [корутину](https://python-all.ru/3.12/glossary.html#term-coroutine), если функция передаётся в API, требующий [`iscoroutinefunction()`](https://python-all.ru/3.12/library/inspect.html#inspect.iscoroutinefunction).173174Если возможно, предпочтительнее использовать [`async def`](https://python-all.ru/3.12/reference/compound_stmts.html#async-def) функцию. Также допустимо вызвать функцию и проверить возвращаемое значение с помощью [`iscoroutine()`](https://python-all.ru/3.12/library/inspect.html#inspect.iscoroutine).175176Добавлено в версии 3.12.177178#### `inspect.iscoroutine(object)`179180Возвращает `True`, если объект является [корутиной](https://python-all.ru/3.12/glossary.html#term-coroutine), созданной функцией [`async def`](https://python-all.ru/3.12/reference/compound_stmts.html#async-def).181182Добавлено в версии 3.5.183184#### `inspect.isawaitable(object)`185186Возвращает `True`, если объект может использоваться в выражении [`await`](https://python-all.ru/3.12/reference/expressions.html#await).187188Также может использоваться для отличия корутин на основе генераторов от обычных генераторов:189190```python191import types192193def gen():194    yield195@types.coroutine196def gen_coro():197    yield198199assert not isawaitable(gen())200assert isawaitable(gen_coro())201```202203Добавлено в версии 3.5.204205#### `inspect.isasyncgenfunction(object)`206207Возвращает `True`, если объект является функцией [асинхронного генератора](https://python-all.ru/3.12/glossary.html#term-asynchronous-generator), например:208209```pycon210>>> async def agen():211...     yield 1212...213>>> inspect.isasyncgenfunction(agen)214True215```216217Добавлено в версии 3.6.218219Изменено в версии 3.8: Функции, обёрнутые в [`functools.partial()`](https://python-all.ru/3.12/library/functools.html#functools.partial), теперь возвращают `True`, если обёрнутая функция является функцией [асинхронного генератора](https://python-all.ru/3.12/glossary.html#term-asynchronous-generator).220221#### `inspect.isasyncgen(object)`222223Возвращает `True`, если объект является [итератором асинхронного генератора](https://python-all.ru/3.12/glossary.html#term-asynchronous-generator-iterator), созданным функцией [асинхронного генератора](https://python-all.ru/3.12/glossary.html#term-asynchronous-generator).224225Добавлено в версии 3.6.226227#### `inspect.istraceback(object)`228229Возвращает `True`, если объект является traceback.230231#### `inspect.isframe(object)`232233Возвращает `True`, если объект является фреймом.234235#### `inspect.iscode(object)`236237Возвращает `True`, если объект является кодом.238239#### `inspect.isbuiltin(object)`240241Возвращает `True`, если объект является встроенной функцией или связанным встроенным методом.242243#### `inspect.ismethodwrapper(object)`244245Возвращает `True`, если тип объекта – это [`MethodWrapperType`](https://python-all.ru/3.12/library/types.html#types.MethodWrapperType).246247Это экземпляры [`MethodWrapperType`](https://python-all.ru/3.12/library/types.html#types.MethodWrapperType), такие как [`__str__()`](https://python-all.ru/3.12/reference/datamodel.html#object.__str__), [`__eq__()`](https://python-all.ru/3.12/reference/datamodel.html#object.__eq__) и [`__repr__()`](https://python-all.ru/3.12/reference/datamodel.html#object.__repr__).248249Добавлено в версии 3.12.250251#### `inspect.isroutine(object)`252253Возвращает `True`, если объект является пользовательской или встроенной функцией или методом.254255#### `inspect.isabstract(object)`256257Возвращает `True`, если объект является абстрактным базовым классом.258259#### `inspect.ismethoddescriptor(object)`260261Возвращает `True`, если объект является дескриптором метода, но не если [`ismethod()`](https://python-all.ru/3.12/library/inspect.html#inspect.ismethod), [`isclass()`](https://python-all.ru/3.12/library/inspect.html#inspect.isclass), [`isfunction()`](https://python-all.ru/3.12/library/inspect.html#inspect.isfunction) или [`isbuiltin()`](https://python-all.ru/3.12/library/inspect.html#inspect.isbuiltin) истинны.262263Это верно, например, для `int.__add__`. Объект, проходящий эту проверку, имеет метод [`__get__()`](https://python-all.ru/3.12/reference/datamodel.html#object.__get__), но не имеет метода [`__set__()`](https://python-all.ru/3.12/reference/datamodel.html#object.__set__), однако помимо этого набор атрибутов различается. Атрибут [`__name__`](https://python-all.ru/3.12/library/stdtypes.html#definition.__name__) обычно имеет смысл, а [`__doc__`](https://python-all.ru/3.12/library/stdtypes.html#definition.__doc__) часто – тоже.264265Методы, реализованные через дескрипторы и также проходящие одну из других проверок, возвращают `False` из проверки [`ismethoddescriptor()`](https://python-all.ru/3.12/library/inspect.html#inspect.ismethoddescriptor), просто потому что другие проверки обещают больше – например, можно рассчитывать на наличие атрибута [`__func__`](https://python-all.ru/3.12/reference/datamodel.html#method.__func__) (и т.д.), когда объект проходит [`ismethod()`](https://python-all.ru/3.12/library/inspect.html#inspect.ismethod).266267#### `inspect.isdatadescriptor(object)`268269Возвращает `True`, если объект является дескриптором данных.270271Дескрипторы данных имеют метод [`__set__`](https://python-all.ru/3.12/reference/datamodel.html#object.__set__) или [`__delete__`](https://python-all.ru/3.12/reference/datamodel.html#object.__delete__). Примеры: свойства (определённые в Python), getsets и members. Последние два определены в C, и для этих типов существуют более специфичные проверки, которые надёжны в разных реализациях Python. Обычно дескрипторы данных также имеют атрибуты [`__name__`](https://python-all.ru/3.12/library/stdtypes.html#definition.__name__) и `__doc__` (свойства, getsets и members имеют оба этих атрибута), но это не гарантируется.272273#### `inspect.isgetsetdescriptor(object)`274275Возвращает `True`, если объект является дескриптором getset.276277**Особенность реализации CPython:** getsets – это атрибуты, определённые в модулях расширения через структуры [`PyGetSetDef`](https://python-all.ru/3.12/c-api/structures.html#c.PyGetSetDef). Для реализаций Python без таких типов этот метод всегда будет возвращать `False`.278279#### `inspect.ismemberdescriptor(object)`280281Возвращает `True`, если объект является дескриптором члена.282283**Особенности реализации CPython:** Дескрипторы членов – это атрибуты, определённые в модулях расширения через структуры [`PyMemberDef`](https://python-all.ru/3.12/c-api/structures.html#c.PyMemberDef). В реализациях Python без таких типов этот метод всегда возвращает `False`.284285## Получение исходного кода286287#### `inspect.getdoc(object)`288289Получает строку документации для объекта, очищенную с помощью [`cleandoc()`](https://python-all.ru/3.12/library/inspect.html#inspect.cleandoc). Если строка документации для объекта не задана, а объект – это класс, метод, свойство или дескриптор, строка документации извлекается из иерархии наследования. Возвращает `None`, если строка документации отсутствует или некорректна.290291Изменено в версии 3.5: Теперь строки документации наследуются, если не переопределены.292293#### `inspect.getcomments(object)`294295Возвращает в виде одной строки все строки комментариев, непосредственно предшествующие исходному коду объекта (для класса, функции или метода), либо в начале Python-файла (если объект – модуль). Если исходный код объекта недоступен, возвращает `None`. Это может произойти, если объект определён на C или в интерактивной оболочке.296297#### `inspect.getfile(object)`298299Возвращает имя (текстового или бинарного) файла, в котором определён объект. Вызывает исключение [`TypeError`](https://python-all.ru/3.12/library/exceptions.html#TypeError), если объект – встроенный модуль, класс или функция.300301#### `inspect.getmodule(object)`302303Пытается определить модуль, в котором определён объект. Возвращает `None`, если модуль не удаётся определить.304305#### `inspect.getsourcefile(object)`306307Возвращает имя Python-файла с исходным кодом, в котором определён объект, или `None`, если способ получить исходный код не найден. Вызывает исключение [`TypeError`](https://python-all.ru/3.12/library/exceptions.html#TypeError), если объект – встроенный модуль, класс или функция.308309#### `inspect.getsourcelines(object)`310311Возвращает список строк исходного кода и номер начальной строки для объекта. Аргументом может быть модуль, класс, метод, функция, traceback, frame или code-объект. Исходный код возвращается в виде списка строк этого объекта, а номер строки указывает положение первой строки кода в исходном файле. Вызывается исключение [`OSError`](https://python-all.ru/3.12/library/exceptions.html#OSError), если исходный код не удаётся получить. Вызывается [`TypeError`](https://python-all.ru/3.12/library/exceptions.html#TypeError), если объект – встроенный модуль, класс или функция.312313Изменено в версии 3.3: [`OSError`](https://python-all.ru/3.12/library/exceptions.html#OSError) вызывается вместо [`IOError`](https://python-all.ru/3.12/library/exceptions.html#IOError), который теперь является его псевдонимом.314315#### `inspect.getsource(object)`316317Возвращает текст исходного кода для объекта. Аргументом может быть модуль, класс, метод, функция, traceback, frame или code-объект. Исходный код возвращается в виде одной строки. Вызывается [`OSError`](https://python-all.ru/3.12/library/exceptions.html#OSError), если исходный код не удаётся получить. Вызывается [`TypeError`](https://python-all.ru/3.12/library/exceptions.html#TypeError), если объект – встроенный модуль, класс или функция.318319Изменено в версии 3.3: [`OSError`](https://python-all.ru/3.12/library/exceptions.html#OSError) вызывается вместо [`IOError`](https://python-all.ru/3.12/library/exceptions.html#IOError), который теперь является его псевдонимом.320321#### `inspect.cleandoc(doc)`322323Убирает отступы из docstrings, которые выровнены с блоками кода.324325Из первой строки удаляются все начальные пробелы. Все начальные пробелы, которые можно равномерно удалить со второй строки и далее, также удаляются. Пустые строки в начале и конце удаляются. Кроме того, все табуляции заменяются пробелами.326327## Интроспекция вызываемых объектов с помощью объекта Signature328329Добавлено в версии 3.3.330331Объект [`Signature`](https://python-all.ru/3.12/library/inspect.html#inspect.Signature) представляет сигнатуру вызова вызываемого объекта и аннотацию его возвращаемого значения. Для получения объекта `Signature` используйте функцию `signature()`.332333#### `inspect.signature(callable, *, follow_wrapped=True, globals=None, locals=None, eval_str=False)`334335Возвращает объект [`Signature`](https://python-all.ru/3.12/library/inspect.html#inspect.Signature) для заданного *callable*:336337```pycon338>>> from inspect import signature339>>> def foo(a, *, b:int, **kwargs):340...     pass341342>>> sig = signature(foo)343344>>> str(sig)345'(a, *, b: int, **kwargs)'346347>>> str(sig.parameters['b'])348'b: int'349350>>> sig.parameters['b'].annotation351<class 'int'>352```353354Принимает широкий спектр вызываемых объектов Python: от обычных функций и классов до объектов [`functools.partial()`](https://python-all.ru/3.12/library/functools.html#functools.partial).355356Для объектов, определённых в модулях с использованием строковых аннотаций (`from __future__ import annotations`), [`signature()`](https://python-all.ru/3.12/library/inspect.html#inspect.signature) будет пытаться автоматически преобразовывать аннотации обратно из строк с помощью [`get_annotations()`](https://python-all.ru/3.12/library/inspect.html#inspect.get_annotations). Параметры *globals*, *locals* и *eval\_str* передаются в [`get_annotations()`](https://python-all.ru/3.12/library/inspect.html#inspect.get_annotations) при разрешении аннотаций; за инструкциями по использованию этих параметров обращайтесь к документации [`get_annotations()`](https://python-all.ru/3.12/library/inspect.html#inspect.get_annotations) .357358Вызывает [`ValueError`](https://python-all.ru/3.12/library/exceptions.html#ValueError), если сигнатуру невозможно предоставить, и [`TypeError`](https://python-all.ru/3.12/library/exceptions.html#TypeError), если такой тип объекта не поддерживается. Кроме того, если аннотации преобразованы в строки и *eval\_str* не равен false, вызов(ы) `eval()` для обратного преобразования аннотаций в [`get_annotations()`](https://python-all.ru/3.12/library/inspect.html#inspect.get_annotations) могут потенциально вызвать исключения любого типа.359360Косая черта (/) в сигнатуре функции означает, что параметры до неё являются только позиционными. За дополнительной информацией обращайтесь к [вопросу FAQ о только позиционных параметрах](https://python-all.ru/3.12/faq/programming.html#faq-positional-only-arguments).361362Изменено в версии 3.5: Был добавлен параметр *follow\_wrapped*. Передайте `False`, чтобы получить сигнатуру именно *вызываемого объекта* (`callable.__wrapped__` не будет использоваться для раскрытия декорированных вызываемых объектов.)363364Изменено в версии 3.10: Были добавлены параметры *globals*, *locals* и *eval\_str*.365366> **Примечание**367>368> Некоторые вызываемые объекты могут быть недоступны для интроспекции в определённых реализациях Python. Например, в CPython некоторые встроенные функции, определённые на C, не предоставляют метаданных о своих аргументах.369370**Особенности реализации CPython:** Если у переданного объекта есть атрибут `__signature__`, он может использоваться для создания сигнатуры. Точная семантика является деталью реализации и может быть изменена без предварительного уведомления. Обратитесь к исходному коду за актуальной семантикой.371372#### `class inspect.Signature(parameters=None, *, return_annotation=Signature.empty)`373374Объект `Signature` представляет сигнатуру вызова функции и её аннотацию возврата. Для каждого параметра, принимаемого функцией, он хранит объект [`Parameter`](https://python-all.ru/3.12/library/inspect.html#inspect.Parameter) в своей коллекции [`parameters`](https://python-all.ru/3.12/library/inspect.html#inspect.Signature.parameters).375376Необязательный аргумент *parameters* – это последовательность объектов [`Parameter`](https://python-all.ru/3.12/library/inspect.html#inspect.Parameter), которая проверяется на отсутствие дублирующихся имён параметров и на правильный порядок: сначала только позиционные, затем позиционно-ключевые, а параметры со значениями по умолчанию следуют за параметрами без них.377378Необязательный аргумент *return\_annotation* может быть произвольным объектом Python. Он представляет аннотацию «return» вызываемого объекта.379380Объекты `Signature` *неизменяемы*. Используйте [`Signature.replace()`](https://python-all.ru/3.12/library/inspect.html#inspect.Signature.replace) для создания изменённой копии.381382Изменено в версии 3.5: Объекты `Signature` теперь являются сериализуемыми и [хешируемыми](https://python-all.ru/3.12/glossary.html#term-hashable).383384#### `empty`385386Специальный маркер уровня класса для указания отсутствия аннотации возврата.387388#### `parameters`389390Упорядоченное отображение имён параметров в соответствующие объекты [`Parameter`](https://python-all.ru/3.12/library/inspect.html#inspect.Parameter). Параметры располагаются в строгом порядке определения, включая только ключевые параметры.391392Изменено в версии 3.7: Python явно гарантирует сохранение порядка объявления только-ключевых параметров начиная с версии 3.7, хотя на практике этот порядок всегда сохранялся в Python 3.393394#### `return_annotation`395396Аннотация «return» вызываемого объекта. Если у вызываемого объекта нет аннотации «return», этот атрибут устанавливается в [`Signature.empty`](https://python-all.ru/3.12/library/inspect.html#inspect.Signature.empty).397398#### `bind(*args, **kwargs)`399400Создаёт отображение позиционных и ключевых аргументов в параметры. Возвращает [`BoundArguments`](https://python-all.ru/3.12/library/inspect.html#inspect.BoundArguments), если `*args` и `**kwargs` соответствуют сигнатуре, или вызывает [`TypeError`](https://python-all.ru/3.12/library/exceptions.html#TypeError).401402#### `bind_partial(*args, **kwargs)`403404Работает так же, как [`Signature.bind()`](https://python-all.ru/3.12/library/inspect.html#inspect.Signature.bind), но позволяет опускать некоторые обязательные аргументы (имитирует поведение [`functools.partial()`](https://python-all.ru/3.12/library/functools.html#functools.partial)). Возвращает [`BoundArguments`](https://python-all.ru/3.12/library/inspect.html#inspect.BoundArguments) или вызывает [`TypeError`](https://python-all.ru/3.12/library/exceptions.html#TypeError), если переданные аргументы не соответствуют сигнатуре.405406#### `replace(*[, parameters][, return_annotation])`407408Создаёт новый экземпляр [`Signature`](https://python-all.ru/3.12/library/inspect.html#inspect.Signature) на основе экземпляра, для которого был вызван [`replace()`](https://python-all.ru/3.12/library/inspect.html#inspect.Signature.replace). Можно передать другие значения *parameters* и/или *return\_annotation*, чтобы переопределить соответствующие свойства исходной сигнатуры. Чтобы удалить `return_annotation` из скопированной `Signature`, передайте [`Signature.empty`](https://python-all.ru/3.12/library/inspect.html#inspect.Signature.empty).409410```pycon411>>> def test(a, b):412...     pass413...414>>> sig = signature(test)415>>> new_sig = sig.replace(return_annotation="new return anno")416>>> str(new_sig)417"(a, b) -> 'new return anno'"418```419420#### `classmethod from_callable(obj, *, follow_wrapped=True, globals=None, locals=None, eval_str=False)`421422Возвращает объект [`Signature`](https://python-all.ru/3.12/library/inspect.html#inspect.Signature) (или его подкласс) для заданного вызываемого объекта *obj*.423424Этот метод упрощает создание подклассов [`Signature`](https://python-all.ru/3.12/library/inspect.html#inspect.Signature):425426```python427class MySignature(Signature):428    pass429sig = MySignature.from_callable(sum)430assert isinstance(sig, MySignature)431```432433В остальном его поведение идентично [`signature()`](https://python-all.ru/3.12/library/inspect.html#inspect.signature).434435Добавлено в версии 3.5.436437Изменено в версии 3.10: Были добавлены параметры *globals*, *locals* и *eval\_str*.438439#### `class inspect.Parameter(name, kind, *, default=Parameter.empty, annotation=Parameter.empty)`440441Объекты `Parameter` *неизменяемы*. Вместо изменения объекта `Parameter` можно использовать [`Parameter.replace()`](https://python-all.ru/3.12/library/inspect.html#inspect.Parameter.replace) для создания изменённой копии.442443Изменено в версии 3.5: Объекты Parameter теперь сериализуемы и [хешируемы](https://python-all.ru/3.12/glossary.html#term-hashable).444445#### `empty`446447Специальный маркер уровня класса для указания отсутствия значений по умолчанию и аннотаций.448449#### `name`450451Имя параметра в виде строки. Имя должно быть допустимым идентификатором Python.452453**Особенности реализации CPython:** CPython генерирует неявные имена параметров вида `.0` в объектах кода, используемых для реализации включений (comprehensions) и выражений-генераторов.454455Изменено в версии 3.6: Теперь этот модуль предоставляет эти имена параметров как имена вида `implicit0`.456457#### `default`458459Значение параметра по умолчанию. Если у параметра нет значения по умолчанию, этот атрибут устанавливается в [`Parameter.empty`](https://python-all.ru/3.12/library/inspect.html#inspect.Parameter.empty).460461#### `annotation`462463Аннотация параметра. Если у параметра нет аннотации, этот атрибут устанавливается в [`Parameter.empty`](https://python-all.ru/3.12/library/inspect.html#inspect.Parameter.empty).464465#### `kind`466467Описывает, как значения аргументов привязываются к параметру. Возможные значения доступны через [`Parameter`](https://python-all.ru/3.12/library/inspect.html#inspect.Parameter) (например, `Parameter.KEYWORD_ONLY`), и поддерживают сравнение и упорядочивание в следующем порядке:468469| Имя | Значение |470| --- | --- |471| *POSITIONAL\_ONLY* | Значение должно передаваться как позиционный аргумент. Параметры только для позиционной передачи – это те, которые находятся перед записью `/` (если она присутствует) в определении функции Python. |472| *POSITIONAL\_OR\_KEYWORD* | Значение может передаваться как ключевой, так и позиционный аргумент (это стандартное поведение привязки для функций, реализованных на Python). |473| *VAR\_POSITIONAL* | Кортеж позиционных аргументов, которые не привязаны ни к одному другому параметру. Это соответствует параметру `*args` в определении функции Python. |474| *KEYWORD\_ONLY* | Значение должно передаваться как ключевой аргумент. Параметры только для ключевой передачи – это те, которые находятся после записи `*` или `*args` в определении функции Python. |475| *VAR\_KEYWORD* | Словарь ключевых аргументов, которые не привязаны ни к одному другому параметру. Это соответствует параметру `**kwargs` в определении функции Python. |476477Пример: вывод всех аргументов только для ключевой передачи без значений по умолчанию:478479```pycon480>>> def foo(a, b, *, c, d=10):481...     pass482483>>> sig = signature(foo)484>>> for param in sig.parameters.values():485...     if (param.kind == param.KEYWORD_ONLY and486...                        param.default is param.empty):487...         print('Parameter:', param)488Parameter: c489```490491#### `kind.description`492493Описывает значение перечисления [`Parameter.kind`](https://python-all.ru/3.12/library/inspect.html#inspect.Parameter.kind).494495Добавлено в версии 3.8.496497Пример: вывод всех описаний аргументов:498499```pycon500>>> def foo(a, b, *, c, d=10):501...     pass502503>>> sig = signature(foo)504>>> for param in sig.parameters.values():505...     print(param.kind.description)506positional or keyword507positional or keyword508keyword-only509keyword-only510```511512#### `replace(*[, name][, kind][, default][, annotation])`513514Создаёт новый экземпляр [`Parameter`](https://python-all.ru/3.12/library/inspect.html#inspect.Parameter) на основе экземпляра, на котором была вызвана операция замены. Чтобы переопределить атрибут `Parameter`, передайте соответствующий аргумент. Чтобы удалить значение по умолчанию и/или аннотацию из `Parameter`, передайте [`Parameter.empty`](https://python-all.ru/3.12/library/inspect.html#inspect.Parameter.empty).515516```pycon517>>> from inspect import Parameter518>>> param = Parameter('foo', Parameter.KEYWORD_ONLY, default=42)519>>> str(param)520'foo=42'521522>>> str(param.replace()) # Создаст поверхностную копию 'param'523'foo=42'524525>>> str(param.replace(default=Parameter.empty, annotation='spam'))526"foo: 'spam'"527```528529Изменено в версии 3.4: В Python 3.3 объектам [`Parameter`](https://python-all.ru/3.12/library/inspect.html#inspect.Parameter) разрешалось иметь `name`, установленное в `None`, если их `kind` было установлено в `POSITIONAL_ONLY`. Это больше не допускается.530531#### `class inspect.BoundArguments`532533Результат вызова [`Signature.bind()`](https://python-all.ru/3.12/library/inspect.html#inspect.Signature.bind) или [`Signature.bind_partial()`](https://python-all.ru/3.12/library/inspect.html#inspect.Signature.bind_partial). Содержит отображение аргументов на параметры функции.534535#### `arguments`536537Изменяемое отображение имён параметров на значения аргументов. Содержит только явно привязанные аргументы. Изменения в [`arguments`](https://python-all.ru/3.12/library/inspect.html#inspect.BoundArguments.arguments) отразятся в [`args`](https://python-all.ru/3.12/library/inspect.html#inspect.BoundArguments.args) и [`kwargs`](https://python-all.ru/3.12/library/inspect.html#inspect.BoundArguments.kwargs).538539Следует использовать совместно с [`Signature.parameters`](https://python-all.ru/3.12/library/inspect.html#inspect.Signature.parameters) для любых целей обработки аргументов.540541> **Примечание**542>543> Аргументы, для которых [`Signature.bind()`](https://python-all.ru/3.12/library/inspect.html#inspect.Signature.bind) или [`Signature.bind_partial()`](https://python-all.ru/3.12/library/inspect.html#inspect.Signature.bind_partial) полагались на значение по умолчанию, пропускаются. Однако при необходимости используйте [`BoundArguments.apply_defaults()`](https://python-all.ru/3.12/library/inspect.html#inspect.BoundArguments.apply_defaults), чтобы добавить их.544545Изменено в версии 3.9: [`arguments`](https://python-all.ru/3.12/library/inspect.html#inspect.BoundArguments.arguments) теперь имеет тип [`dict`](https://python-all.ru/3.12/library/stdtypes.html#dict). Ранее он имел тип [`collections.OrderedDict`](https://python-all.ru/3.12/library/collections.html#collections.OrderedDict).546547#### `args`548549Кортеж значений позиционных аргументов. Динамически вычисляется из атрибута [`arguments`](https://python-all.ru/3.12/library/inspect.html#inspect.BoundArguments.arguments).550551#### `kwargs`552553Словарь значений именованных аргументов. Динамически вычисляется из атрибута [`arguments`](https://python-all.ru/3.12/library/inspect.html#inspect.BoundArguments.arguments). Аргументы, которые можно передать позиционно, включаются в [`args`](https://python-all.ru/3.12/library/inspect.html#inspect.BoundArguments.args) вместо этого.554555#### `signature`556557Ссылка на родительский объект [`Signature`](https://python-all.ru/3.12/library/inspect.html#inspect.Signature).558559#### `apply_defaults()`560561Устанавливает значения по умолчанию для отсутствующих аргументов.562563Для переменных позиционных аргументов (`*args`) значением по умолчанию является пустой кортеж.564565Для переменных именованных аргументов (`**kwargs`) значением по умолчанию является пустой словарь.566567```pycon568>>> def foo(a, b='ham', *args): pass569>>> ba = inspect.signature(foo).bind('spam')570>>> ba.apply_defaults()571>>> ba.arguments572{'a': 'spam', 'b': 'ham', 'args': ()}573```574575Добавлено в версии 3.5.576577Свойства [`args`](https://python-all.ru/3.12/library/inspect.html#inspect.BoundArguments.args) и [`kwargs`](https://python-all.ru/3.12/library/inspect.html#inspect.BoundArguments.kwargs) можно использовать для вызова функций:578579```python580def test(a, *, b):581    ...582583sig = signature(test)584ba = sig.bind(10, b=20)585test(*ba.args, **ba.kwargs)586```587588> **См. также**589>590> **[**PEP 362**](https://python-all.ru/3.12/library/inspect.html) – объект сигнатуры функции.**591>592> Подробная спецификация, детали реализации и примеры.593594## Классы и функции595596#### `inspect.getclasstree(classes, unique=False)`597598Упорядочивает заданный список классов в иерархию вложенных списков. Если встречается вложенный список, он содержит классы, унаследованные от класса, запись которого непосредственно предшествует этому списку. Каждая запись представляет собой кортеж из двух элементов, содержащий класс и кортеж его базовых классов. Если аргумент *unique* равен true, в возвращаемой структуре появляется ровно одна запись для каждого класса из заданного списка. В противном случае классы, использующие множественное наследование, и их потомки будут появляться несколько раз.599600#### `inspect.getfullargspec(func)`601602Возвращает имена и значения по умолчанию параметров функции Python. Возвращается [именованный кортеж](https://python-all.ru/3.12/glossary.html#term-named-tuple):603604`FullArgSpec(args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, annotations)`605606*args* – это список имён позиционных параметров. *varargs* – это имя параметра `*` или `None`, если произвольные позиционные аргументы не принимаются. *varkw* – это имя параметра `**` или `None`, если произвольные именованные аргументы не принимаются. *defaults* – это *n*-кортеж значений аргументов по умолчанию, соответствующих последним *n* позиционным параметрам, или `None`, если такие значения по умолчанию не определены. *kwonlyargs* – это список имён только именованных параметров в порядке объявления. *kwonlydefaults* – это словарь, сопоставляющий имена параметров из *kwonlyargs* со значениями по умолчанию, используемыми, если аргумент не передан. *annotations* – это словарь, сопоставляющий имена параметров с аннотациями. Специальный ключ `"return"` используется для указания аннотации возвращаемого значения функции (если есть).607608Обратите внимание, что [`signature()`](https://python-all.ru/3.12/library/inspect.html#inspect.signature) и [объект Signature](https://python-all.ru/3.12/library/inspect.html#inspect-signature-object) предоставляют рекомендуемый API для интроспекции вызываемых объектов и поддерживают дополнительное поведение (например, позиционные аргументы), которое иногда встречается в API модулей расширения. Эта функция сохранена в основном для использования в коде, которому необходима совместимость с API модуля Python 2 `inspect`.609610Изменено в версии 3.4: Эта функция теперь основана на [`signature()`](https://python-all.ru/3.12/library/inspect.html#inspect.signature), но по-прежнему игнорирует атрибуты `__wrapped__` и включает уже привязанный первый параметр в вывод сигнатуры для связанных методов.611612Изменено в версии 3.6: Ранее этот метод был объявлен устаревшим в пользу [`signature()`](https://python-all.ru/3.12/library/inspect.html#inspect.signature) в Python 3.5, но это решение было отменено, чтобы восстановить чётко поддерживаемый стандартный интерфейс для кода на Python 2/3 из одного источника, который мигрирует от устаревшего API `getargspec()`.613614Изменено в версии 3.7: Python явно гарантирует сохранение порядка объявления только-ключевых параметров начиная с версии 3.7, хотя на практике этот порядок всегда сохранялся в Python 3.615616#### `inspect.getargvalues(frame)`617618Извлекает информацию об аргументах, переданных в заданный фрейм. Возвращается [именованный кортеж](https://python-all.ru/3.12/glossary.html#term-named-tuple) `ArgInfo(args, varargs, keywords, locals)`. *args* – список имён аргументов. *varargs* и *keywords* – имена аргументов `*` и `**` или `None`. *locals* – это словарь локальных переменных данного фрейма.619620> **Примечание**621>622> Эта функция была ошибочно помечена как устаревшая в Python 3.5.623624#### `inspect.formatargvalues(args[, varargs, varkw, locals, formatarg, formatvarargs, formatvarkw, formatvalue])`625626Форматирует красивое описание аргументов из четырёх значений, возвращаемых [`getargvalues()`](https://python-all.ru/3.12/library/inspect.html#inspect.getargvalues). Аргументы format\* – это соответствующие опциональные функции форматирования, которые вызываются для преобразования имён и значений в строки.627628> **Примечание**629>630> Эта функция была ошибочно помечена как устаревшая в Python 3.5.631632#### `inspect.getmro(cls)`633634Возвращает кортеж базовых классов класса cls, включая cls, в порядке разрешения методов (MRO). Ни один класс не встречается в этом кортеже более одного раза. Обратите внимание, что порядок разрешения методов зависит от типа cls. Если не используется особенная пользовательская метатипизация, cls будет первым элементом кортежа.635636#### `inspect.getcallargs(func, /, *args, **kwds)`637638Связывает *args* и *kwds* с именами аргументов функции или метода Python *func*, как если бы она была вызвана с ними. Для связанных методов (bound methods) также связывает первый аргумент (обычно названный `self`) с соответствующим экземпляром. Возвращается словарь, отображающий имена аргументов (включая имена аргументов `*` и `**`, если они есть) на их значения из *args* и *kwds*. В случае неправильного вызова *func*, т.е. когда `func(*args, **kwds)` возбудило бы исключение из-за несовместимой сигнатуры, возбуждается исключение того же типа и с тем же или похожим сообщением. Например:639640```pycon641>>> from inspect import getcallargs642>>> def f(a, b=1, *pos, **named):643...     pass644...645>>> getcallargs(f, 1, 2, 3) == {'a': 1, 'named': {}, 'b': 2, 'pos': (3,)}646True647>>> getcallargs(f, a=2, x=4) == {'a': 2, 'named': {'x': 4}, 'b': 1, 'pos': ()}648True649>>> getcallargs(f)650Traceback (most recent call last):651...652TypeError: f() missing 1 required positional argument: 'a'653```654655Добавлено в версии 3.2.656657Устарело с версии 3.5: Используйте [`Signature.bind()`](https://python-all.ru/3.12/library/inspect.html#inspect.Signature.bind) и [`Signature.bind_partial()`](https://python-all.ru/3.12/library/inspect.html#inspect.Signature.bind_partial) вместо этого.658659#### `inspect.getclosurevars(func)`660661Извлекает отображение ссылок на внешние имена в функции или методе Python *func* на их текущие значения. Возвращается [именованный кортеж](https://python-all.ru/3.12/glossary.html#term-named-tuple) `ClosureVars(nonlocals, globals, builtins, unbound)`. *nonlocals* отображает ссылочные имена на переменные лексического замыкания, *globals* – на глобальные переменные модуля функции, а *builtins* – на встроенные имена, видимые из тела функции. *unbound* – множество имён, на которые есть ссылки в функции, но которые не удалось разрешить при текущих глобальных переменных модуля и встроенных именах.662663[`TypeError`](https://python-all.ru/3.12/library/exceptions.html#TypeError) возбуждается, если *func* не является функцией или методом Python.664665Добавлено в версии 3.3.666667#### `inspect.unwrap(func, *, stop=None)`668669Получает объект, обёрнутый в *func*. Следует по цепочке атрибутов `__wrapped__`, возвращая последний объект в цепочке.670671*stop* – опциональный колбэк, принимающий объект в цепочке обёрток в качестве единственного аргумента, который позволяет досрочно завершить разворачивание, если колбэк возвращает истинное значение. Если колбэк никогда не возвращает истинное значение, возвращается последний объект в цепочке как обычно. Например, [`signature()`](https://python-all.ru/3.12/library/inspect.html#inspect.signature) использует это, чтобы остановить разворачивание, если какой-либо объект в цепочке имеет определённый атрибут `__signature__`.672673[`ValueError`](https://python-all.ru/3.12/library/exceptions.html#ValueError) возбуждается, если обнаружен цикл.674675Добавлено в версии 3.4.676677#### `inspect.get_annotations(obj, *, globals=None, locals=None, eval_str=False)`678679Вычисляет словарь аннотаций для объекта.680681`obj` может быть вызываемым объектом, классом или модулем. Передача объекта любого другого типа вызывает [`TypeError`](https://python-all.ru/3.12/library/exceptions.html#TypeError).682683Возвращает словарь. `get_annotations()` каждый раз возвращает новый словарь; два его вызова для одного и того же объекта вернут два разных, но эквивалентных словаря.684685Эта функция обрабатывает несколько деталей:686687- Если `eval_str` истинно, значения типа `str` будут преобразованы из строки с помощью [`eval()`](https://python-all.ru/3.12/library/functions.html#eval). Это предназначено для использования со строковыми аннотациями (`from __future__ import annotations`).688- Если у `obj` нет словаря аннотаций, возвращает пустой словарь. (Функции и методы всегда имеют словарь аннотаций; классы, модули и другие типы вызываемых объектов – не обязательно.)689- Игнорирует унаследованные аннотации классов. Если класс не имеет собственного словаря аннотаций, возвращает пустой словарь.690- Все обращения к членам объекта и значениям словаря выполняются с использованием `getattr()` и `dict.get()` для безопасности.691- Всегда возвращает только что созданный словарь.692693`eval_str` управляет тем, заменяются ли значения типа `str` на результат вызова [`eval()`](https://python-all.ru/3.12/library/functions.html#eval) для этих значений:694695- Если eval\_str истинно, [`eval()`](https://python-all.ru/3.12/library/functions.html#eval) вызывается для значений типа `str`. (Обратите внимание, что `get_annotations` не перехватывает исключения; если [`eval()`](https://python-all.ru/3.12/library/functions.html#eval) выбрасывает исключение, оно раскрутит стек за пределы вызова `get_annotations`.)696- Если eval\_str равен false (по умолчанию), значения типа `str` не изменяются.697698`globals` и `locals` передаются в [`eval()`](https://python-all.ru/3.12/library/functions.html#eval); обратитесь к документации по [`eval()`](https://python-all.ru/3.12/library/functions.html#eval) для получения дополнительной информации. Если `globals` или `locals` равны `None`, эта функция может заменить это значение на контекстно-зависимое значение по умолчанию, в зависимости от `type(obj)`:699700- Если `obj` является модулем, `globals` по умолчанию принимает значение `obj.__dict__`.701- Если `obj` является классом, `globals` по умолчанию принимает значение `sys.modules[obj.__module__].__dict__`, а `locals` по умолчанию принимает пространство имён класса `obj`.702- Если `obj` является вызываемым объектом, `globals` по умолчанию принимает значение [`obj.__globals__`](https://python-all.ru/3.12/reference/datamodel.html#function.__globals__), хотя если `obj` является обёрнутой функцией (с использованием [`functools.update_wrapper()`](https://python-all.ru/3.12/library/functools.html#functools.update_wrapper)), она сначала разворачивается.703704Вызов `get_annotations` является наилучшей практикой для доступа к словарю аннотаций любого объекта. См. [Annotations Best Practices](https://python-all.ru/3.12/howto/annotations.html#annotations-howto) для получения дополнительной информации о лучших практиках работы с аннотациями.705706Добавлено в версии 3.10.707708## Стек интерпретатора709710Некоторые из следующих функций возвращают объекты [`FrameInfo`](https://python-all.ru/3.12/library/inspect.html#inspect.FrameInfo). Для обратной совместимости эти объекты допускают операции, подобные кортежу, над всеми атрибутами, кроме `positions`. Это поведение считается устаревшим и может быть удалено в будущем.711712#### `class inspect.FrameInfo`713714#### `frame`715716[Объект фрейма](https://python-all.ru/3.12/reference/datamodel.html#frame-objects), которому соответствует эта запись.717718#### `filename`719720Имя файла, связанное с кодом, выполняемым фреймом, которому соответствует эта запись.721722#### `lineno`723724Номер текущей строки, связанной с кодом, выполняемым фреймом, которому соответствует эта запись.725726#### `function`727728Имя функции, выполняемой фреймом, соответствующем этой записи.729730#### `code_context`731732Список строк контекста из исходного кода, выполняемого фреймом, которому соответствует эта запись.733734#### `index`735736Индекс текущей выполняемой строки в списке [`code_context`](https://python-all.ru/3.12/library/inspect.html#inspect.FrameInfo.code_context).737738#### `positions`739740Объект [`dis.Positions`](https://python-all.ru/3.12/library/dis.html#dis.Positions), содержащий номер начальной строки, номер конечной строки, смещение начального столбца и смещение конечного столбца, связанные с инструкцией, выполняемой фреймом, соответствующем этой записи.741742Изменено в версии 3.5: Возвращает [именованный кортеж](https://python-all.ru/3.12/glossary.html#term-named-tuple) вместо [`tuple`](https://python-all.ru/3.12/library/stdtypes.html#tuple).743744Изменено в версии 3.11: `FrameInfo` теперь является экземпляром класса (обратно совместим с предыдущим [именованным кортежем](https://python-all.ru/3.12/glossary.html#term-named-tuple)).745746#### `class inspect.Traceback`747748#### `filename`749750Имя файла, связанное с кодом, выполняемым фреймом, которому соответствует этот traceback.751752#### `lineno`753754Номер текущей строки, связанной с кодом, выполняемым фреймом, которому соответствует этот traceback.755756#### `function`757758Имя функции, выполняемой фреймом, которому соответствует этот traceback.759760#### `code_context`761762Список строк контекста из исходного кода, выполняемого фреймом, которому соответствует этот traceback.763764#### `index`765766Индекс текущей выполняемой строки в списке [`code_context`](https://python-all.ru/3.12/library/inspect.html#inspect.Traceback.code_context).767768#### `positions`769770Объект [`dis.Positions`](https://python-all.ru/3.12/library/dis.html#dis.Positions), содержащий номер начальной строки, номер конечной строки, смещение начального столбца и смещение конечного столбца, связанные с инструкцией, выполняемой фреймом, которому соответствует этот traceback.771772Изменено в версии 3.11: `Traceback` теперь является экземпляром класса (обратно совместим с предыдущим [именованным кортежем](https://python-all.ru/3.12/glossary.html#term-named-tuple)).773774> **Примечание**775>776> Хранение ссылок на объекты фреймов (как в первом элементе записей фреймов, возвращаемых этими функциями) может привести к созданию циклических ссылок в программе. После создания циклической ссылки время жизни всех объектов, доступных из объектов, образующих цикл, может значительно увеличиться, даже если включён дополнительный детектор циклов Python. Если такие циклы необходимо создать, важно убедиться, что они явно разрываются, чтобы избежать задержки уничтожения объектов и увеличения потребления памяти.777>778> Хотя детектор циклов поймает их, уничтожение фреймов (и локальных переменных) можно сделать детерминированным, удалив цикл в предложении [`finally`](https://python-all.ru/3.12/reference/compound_stmts.html#finally). Это также важно, если детектор циклов был отключён при компиляции Python или с помощью [`gc.disable()`](https://python-all.ru/3.12/library/gc.html#gc.disable). Например:779>780> ```python781> def handle_stackframe_without_leak():782>     frame = inspect.currentframe()783>     try:784>         # Выполнить действие с фреймом785>     finally:786>         del frame787> ```788>789> Если нужно сохранить фрейм (например, для последующего вывода traceback), можно также разорвать циклические ссылки с помощью метода [`frame.clear()`](https://python-all.ru/3.12/reference/datamodel.html#frame.clear).790791Необязательный аргумент *context*, поддерживаемый большинством этих функций, задаёт количество возвращаемых строк контекста, которые располагаются вокруг текущей строки.792793#### `inspect.getframeinfo(frame, context=1)`794795Возвращает информацию об объекте фрейма или traceback. Возвращается объект [`Traceback`](https://python-all.ru/3.12/library/inspect.html#inspect.Traceback).796797Изменено в версии 3.11: Возвращается объект [`Traceback`](https://python-all.ru/3.12/library/inspect.html#inspect.Traceback) вместо именованного кортежа.798799#### `inspect.getouterframes(frame, context=1)`800801Возвращает список объектов [`FrameInfo`](https://python-all.ru/3.12/library/inspect.html#inspect.FrameInfo) для фрейма и всех внешних фреймов. Эти фреймы представляют вызовы, которые привели к созданию *frame*. Первый элемент возвращаемого списка представляет *frame*; последний элемент представляет самый внешний вызов в стеке *frame*.802803Изменено в версии 3.5: Возвращается список [именованных кортежей](https://python-all.ru/3.12/glossary.html#term-named-tuple) `FrameInfo(frame, filename, lineno, function, code_context, index)`.804805Изменено в версии 3.11: Возвращается список объектов [`FrameInfo`](https://python-all.ru/3.12/library/inspect.html#inspect.FrameInfo).806807#### `inspect.getinnerframes(traceback, context=1)`808809Получить список объектов [`FrameInfo`](https://python-all.ru/3.12/library/inspect.html#inspect.FrameInfo) для фрейма traceback и всех внутренних фреймов. Эти фреймы представляют вызовы, сделанные в результате *frame*. Первый элемент в списке представляет *traceback*; последний элемент представляет место, где было возбуждено исключение.810811Изменено в версии 3.5: Возвращается список [именованных кортежей](https://python-all.ru/3.12/glossary.html#term-named-tuple) `FrameInfo(frame, filename, lineno, function, code_context, index)`.812813Изменено в версии 3.11: Возвращается список объектов [`FrameInfo`](https://python-all.ru/3.12/library/inspect.html#inspect.FrameInfo).814815#### `inspect.currentframe()`816817Возвращает объект фрейма для фрейма стека вызывающего.818819**Особенность реализации CPython:** Эта функция полагается на поддержку фреймов стека Python в интерпретаторе, которая не гарантируется во всех реализациях Python. Если запустить в реализации без поддержки фреймов стека Python, эта функция возвращает `None`.820821#### `inspect.stack(context=1)`822823Возвращает список объектов [`FrameInfo`](https://python-all.ru/3.12/library/inspect.html#inspect.FrameInfo) для стека вызывающего. Первый элемент возвращаемого списка представляет вызывающего; последний элемент представляет самый внешний вызов в стеке.824825Изменено в версии 3.5: Возвращается список [именованных кортежей](https://python-all.ru/3.12/glossary.html#term-named-tuple) `FrameInfo(frame, filename, lineno, function, code_context, index)`.826827Изменено в версии 3.11: Возвращается список объектов [`FrameInfo`](https://python-all.ru/3.12/library/inspect.html#inspect.FrameInfo).828829#### `inspect.trace(context=1)`830831Возвращает список объектов [`FrameInfo`](https://python-all.ru/3.12/library/inspect.html#inspect.FrameInfo) для стека между текущим фреймом и фреймом, в котором было возбуждено исключение, обрабатываемое в данный момент. Первый элемент списка представляет вызывающего; последний элемент представляет место, где было возбуждено исключение.832833Изменено в версии 3.5: Возвращается список [именованных кортежей](https://python-all.ru/3.12/glossary.html#term-named-tuple) `FrameInfo(frame, filename, lineno, function, code_context, index)`.834835Изменено в версии 3.11: Возвращается список объектов [`FrameInfo`](https://python-all.ru/3.12/library/inspect.html#inspect.FrameInfo).836837## Статическое получение атрибутов838839Как [`getattr()`](https://python-all.ru/3.12/library/functions.html#getattr), так и [`hasattr()`](https://python-all.ru/3.12/library/functions.html#hasattr) могут запускать выполнение кода при получении или проверке существования атрибутов. Дескрипторы, такие как свойства, будут вызваны, а [`__getattr__()`](https://python-all.ru/3.12/reference/datamodel.html#object.__getattr__) и [`__getattribute__()`](https://python-all.ru/3.12/reference/datamodel.html#object.__getattribute__) могут быть вызваны.840841В случаях, когда нужна пассивная интроспекция (например, для инструментов документирования), это может быть неудобно. [`getattr_static()`](https://python-all.ru/3.12/library/inspect.html#inspect.getattr_static) имеет ту же сигнатуру, что и [`getattr()`](https://python-all.ru/3.12/library/functions.html#getattr), но не выполняет код при получении атрибутов.842843#### `inspect.getattr_static(obj, attr, default=None)`844845Получает атрибуты без запуска динамического поиска через протокол дескрипторов, [`__getattr__()`](https://python-all.ru/3.12/reference/datamodel.html#object.__getattr__) или [`__getattribute__()`](https://python-all.ru/3.12/reference/datamodel.html#object.__getattribute__).846847Примечание: эта функция может быть не в состоянии получить все атрибуты, которые может получить getattr (например, динамически созданные атрибуты), и может найти атрибуты, которые getattr не может (например, дескрипторы, вызывающие AttributeError). Она также может возвращать объекты дескрипторов вместо членов экземпляра.848849Если атрибут экземпляра [`__dict__`](https://python-all.ru/3.12/reference/datamodel.html#object.__dict__) скрыт другим членом (например, свойством), то эта функция не сможет найти члены экземпляра.850851Добавлено в версии 3.2.852853[`getattr_static()`](https://python-all.ru/3.12/library/inspect.html#inspect.getattr_static) не разрешает дескрипторы, например, дескрипторы слотов или getset-дескрипторы объектов, реализованных на C. Возвращается объект дескриптора, а не базовый атрибут.854855С ними можно работать с помощью кода вроде следующего. Обратите внимание, что для произвольных getset-дескрипторов их вызов может запустить выполнение кода:856857```python858# Пример кода для разрешения встроенных типов дескрипторов859class _foo:860    __slots__ = ['foo']861862slot_descriptor = type(_foo.foo)863getset_descriptor = type(type(open(__file__)).name)864wrapper_descriptor = type(str.__dict__['__add__'])865descriptor_types = (slot_descriptor, getset_descriptor, wrapper_descriptor)866867result = getattr_static(some_object, 'foo')868if type(result) in descriptor_types:869    try:870        result = result.__get__()871    except AttributeError:872        # Дескрипторы могут вызывать AttributeError, чтобы873        # указать, что нет нижележащего значения874        # в этом случае сам дескриптор будет875        # придется сделать876        pass877```878879## Текущее состояние генераторов, корутин и асинхронных генераторов880881При реализации планировщиков корутин и для других продвинутых случаев использования генераторов полезно определять, выполняется ли генератор в данный момент, ожидает запуска или возобновления, или уже завершился. [`getgeneratorstate()`](https://python-all.ru/3.12/library/inspect.html#inspect.getgeneratorstate) позволяет легко определить текущее состояние генератора.882883#### `inspect.getgeneratorstate(generator)`884885Возвращает текущее состояние генератора-итератора.886887Возможные состояния:888889- GEN\_CREATED: Ожидание начала выполнения.890- GEN\_RUNNING: В настоящее время выполняется интерпретатором.891- GEN\_SUSPENDED: в данный момент приостановлена на выражении yield.892- GEN\_CLOSED: выполнение завершено.893894Добавлено в версии 3.2.895896#### `inspect.getcoroutinestate(coroutine)`897898Получить текущее состояние объекта корутины. Эта функция предназначена для использования с объектами корутин, созданными функциями [`async def`](https://python-all.ru/3.12/reference/compound_stmts.html#async-def), но принимает любой объект, похожий на корутину, который имеет атрибуты `cr_running` и `cr_frame`.899900Возможные состояния:901902- CORO\_CREATED: ожидает начала выполнения.903- CORO\_RUNNING: в данный момент выполняется интерпретатором.904- CORO\_SUSPENDED: в данный момент приостановлена на выражении await.905- CORO\_CLOSED: выполнение завершено.906907Добавлено в версии 3.5.908909#### `inspect.getasyncgenstate(agen)`910911Получить текущее состояние асинхронного генератора. Эта функция предназначена для использования с асинхронными итераторами, созданными функциями [`async def`](https://python-all.ru/3.12/reference/compound_stmts.html#async-def), которые используют оператор [`yield`](https://python-all.ru/3.12/reference/simple_stmts.html#yield), но принимает любой объект, похожий на асинхронный генератор, имеющий атрибуты `ag_running` и `ag_frame`.912913Возможные состояния:914915- AGEN\_CREATED: ожидает начала выполнения.916- AGEN\_RUNNING: в данный момент выполняется интерпретатором.917- AGEN\_SUSPENDED: в данный момент приостановлена на выражении yield.918- AGEN\_CLOSED: выполнение завершено.919920Добавлено в версии 3.12.921922Текущее внутреннее состояние генератора также можно запросить. Это полезно в основном для целей тестирования, чтобы убедиться, что внутреннее состояние обновляется должным образом:923924#### `inspect.getgeneratorlocals(generator)`925926Получить соответствие текущих значений активных локальных переменных в *generator*. Возвращается словарь, отображающий имена переменных в их значения. Это эквивалентно вызову [`locals()`](https://python-all.ru/3.12/library/functions.html#locals) в теле генератора, и действуют все те же предостережения.927928Если *generator* является [генератором](https://python-all.ru/3.12/glossary.html#term-generator) без текущего связанного фрейма, возвращается пустой словарь. [`TypeError`](https://python-all.ru/3.12/library/exceptions.html#TypeError) возникает, если *generator* не является объектом генератора Python.929930**Деталь реализации CPython:** Эта функция полагается на то, что генератор предоставляет стековый фрейм Python для интроспекции, что не гарантируется во всех реализациях Python. В таких случаях эта функция всегда будет возвращать пустой словарь.931932Добавлено в версии 3.3.933934#### `inspect.getcoroutinelocals(coroutine)`935936Эта функция аналогична [`getgeneratorlocals()`](https://python-all.ru/3.12/library/inspect.html#inspect.getgeneratorlocals), но работает для объектов корутин, созданных функциями [`async def`](https://python-all.ru/3.12/reference/compound_stmts.html#async-def).937938Добавлено в версии 3.5.939940#### `inspect.getasyncgenlocals(agen)`941942Эта функция аналогична [`getgeneratorlocals()`](https://python-all.ru/3.12/library/inspect.html#inspect.getgeneratorlocals), но работает для объектов асинхронных генераторов, созданных функциями [`async def`](https://python-all.ru/3.12/reference/compound_stmts.html#async-def), использующими оператор [`yield`](https://python-all.ru/3.12/reference/simple_stmts.html#yield).943944Добавлено в версии 3.12.945946## Битовые флаги объектов кода947948Объекты кода Python имеют атрибут [`co_flags`](https://python-all.ru/3.12/reference/datamodel.html#codeobject.co_flags), который представляет собой битовую маску следующих флагов:949950#### `inspect.CO_OPTIMIZED`951952Объект кода оптимизирован с использованием быстрых локальных переменных.953954#### `inspect.CO_NEWLOCALS`955956Если установлен, при выполнении объекта кода будет создан новый словарь для [`f_locals`](https://python-all.ru/3.12/reference/datamodel.html#frame.f_locals) фрейма.957958#### `inspect.CO_VARARGS`959960Объект кода имеет переменный позиционный параметр (аналог `*args`).961962#### `inspect.CO_VARKEYWORDS`963964Объект кода имеет переменный ключевой параметр (аналог `**kwargs`).965966#### `inspect.CO_NESTED`967968Флаг устанавливается, когда объект кода представляет собой вложенную функцию.969970#### `inspect.CO_GENERATOR`971972Флаг устанавливается, когда объект кода является функцией-генератором, т.е. при выполнении объекта кода возвращается объект генератора.973974#### `inspect.CO_COROUTINE`975976Флаг устанавливается, когда объект кода является корутинной функцией. При выполнении объекта кода возвращается объект корутины. Подробнее см. [**PEP 492**](https://python-all.ru/3.12/library/inspect.html).977978Добавлено в версии 3.5.979980#### `inspect.CO_ITERABLE_COROUTINE`981982Флаг используется для преобразования генераторов в корутины на основе генераторов. Объекты-генераторы с этим флагом можно использовать в выражении `await`, и они могут `yield from` объекты корутин. Подробнее см. [**PEP 492**](https://python-all.ru/3.12/library/inspect.html).983984Добавлено в версии 3.5.985986#### `inspect.CO_ASYNC_GENERATOR`987988Флаг устанавливается, когда объект кода является асинхронной функцией-генератором. При выполнении объекта кода возвращается объект асинхронного генератора. Подробнее см. [**PEP 525**](https://python-all.ru/3.12/library/inspect.html).989990Добавлено в версии 3.6.991992> **Примечание**993>994> Эти флаги специфичны для CPython и могут быть не определены в других реализациях Python. Кроме того, флаги являются деталью реализации и могут быть удалены или объявлены устаревшими в будущих версиях Python. Для любых задач интроспекции рекомендуется использовать публичные API из модуля [`inspect`](https://python-all.ru/3.12/library/inspect.html#module-inspect).995996## Флаги буфера997998#### `class inspect.BufferFlags`9991000Это [`enum.IntFlag`](https://python-all.ru/3.12/library/enum.html#enum.IntFlag), представляющий флаги, которые можно передавать методу [`__buffer__()`](https://python-all.ru/3.12/reference/datamodel.html#object.__buffer__) объектов, реализующих [буферный протокол](https://python-all.ru/3.12/c-api/buffer.html#bufferobjects).10011002Значение флагов объясняется в разделе [Типы запросов буфера](https://python-all.ru/3.12/c-api/buffer.html#buffer-request-types).10031004#### `SIMPLE`10051006#### `WRITABLE`10071008#### `FORMAT`10091010#### `ND`10111012#### `STRIDES`10131014#### `C_CONTIGUOUS`10151016#### `F_CONTIGUOUS`10171018#### `ANY_CONTIGUOUS`10191020#### `INDIRECT`10211022#### `CONTIG`10231024#### `CONTIG_RO`10251026#### `STRIDED`10271028#### `STRIDED_RO`10291030#### `RECORDS`10311032#### `RECORDS_RO`10331034#### `FULL`10351036#### `FULL_RO`10371038#### `READ`10391040#### `WRITE`10411042Добавлено в версии 3.12.10431044## Интерфейс командной строки10451046Модуль [`inspect`](https://python-all.ru/3.12/library/inspect.html#module-inspect) также предоставляет базовые возможности интроспекции из командной строки.10471048По умолчанию принимает имя модуля и выводит его исходный код. Класс или функцию внутри модуля можно вывести, добавив двоеточие и полное имя целевого объекта.10491050#### `--details`10511052Выводит информацию об указанном объекте, а не его исходный код.1053