`inspect.md`

597 строк · 54.9 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.3/library/inspect.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 28.12. [`inspect`](https://python-all.ru/3.3/library/inspect.html#module-inspect) – Инспекция живых объектов89**Исходный код:** [Lib/inspect.py](https://python-all.ru/src/3.3/Lib/inspect.py)1011---1213Модуль [`inspect`](https://python-all.ru/3.3/library/inspect.html#module-inspect) предоставляет несколько полезных функций для получения информации об активных объектах, таких как модули, классы, методы, функции, трассировки стека, объекты фреймов и объекты кода. Например, с его помощью можно просмотреть содержимое класса, получить исходный код метода, извлечь и отформатировать список аргументов функции или получить всю информацию, необходимую для отображения подробной трассировки стека.1415Этот модуль предоставляет четыре основных вида сервисов: проверка типов, получение исходного кода, инспекция классов и функций, а также анализ стека интерпретатора.1617## 28.12.1. Типы и члены1819Функция [`getmembers()`](https://python-all.ru/3.3/library/inspect.html#inspect.getmembers) извлекает члены объекта, такого как класс или модуль. Шестнадцать функций, имена которых начинаются с «is», в основном предоставляются как удобные варианты для второго аргумента [`getmembers()`](https://python-all.ru/3.3/library/inspect.html#inspect.getmembers). Они также помогают определить, когда можно ожидать следующие специальные атрибуты:2021| Тип | Атрибут | Описание |22| --- | --- | --- |23| модуль | doc | строка документации |24|  | file | filename (отсутствует для встроенных модулей) |25| класс | doc | строка документации |26|  | module | имя модуля, в котором был определён этот класс |27| метод | doc | строка документации |28|  | name | имя, под которым был определён этот метод |29|  | func | объект функции, содержащий реализацию метода |30|  | self | экземпляр, к которому привязан этот метод, или `None` |31| функция | doc | строка документации |32|  | name | имя, под которым была определена эта функция |33|  | code | объект кода, содержащий скомпилированную функцию [*байткод*](https://python-all.ru/3.3/glossary.html#term-bytecode) |34|  | defaults | кортеж значений по умолчанию для аргументов |35|  | globals | глобальное пространство имён, в котором была определена эта функция |36| трассировка | tb\_frame | объект фрейма на этом уровне |37|  | tb\_lasti | индекс последней предпринятой инструкции в байткоде |38|  | tb\_lineno | текущий номер строки в исходном коде Python |39|  | tb\_next | следующий внутренний объект traceback (вызванный на этом уровне) |40| фрейм | f\_back | следующий внешний объект фрейма (вызывающий этот фрейм) |41|  | f\_builtins | пространство имён builtins, видимое этим фреймом |42|  | f\_code | объект кода, выполняющийся в этом фрейме |43|  | f\_globals | глобальное пространство имён, видимое этим фреймом |44|  | f\_lasti | индекс последней предпринятой инструкции в байткоде |45|  | f\_lineno | текущий номер строки в исходном коде Python |46|  | f\_locals | локальное пространство имён, видимое этим фреймом |47|  | f\_restricted | 0 или 1, если фрейм находится в ограниченном режиме выполнения |48|  | f\_trace | функция трассировки для этого фрейма, или `None` |49| код | co\_argcount | количество аргументов (не включая \* или \*\* args) |50|  | co\_code | строка сырого скомпилированного байткода |51|  | co\_consts | кортеж констант, используемых в байткоде |52|  | co\_filename | имя файла, в котором был создан этот объект кода |53|  | co\_firstlineno | номер первой строки в исходном коде Python |54|  | co\_flags | битовая маска: 1=оптимизировано `\|` 2=новые локальные `\|` 4=\*arg `\|` 8=\*\*arg |55|  | co\_lnotab | кодированное отображение номеров строк на индексы байт-кода |56|  | co\_name | имя, с которым был определён этот объект кода |57|  | co\_names | кортеж имён локальных переменных |58|  | co\_nlocals | количество локальных переменных |59|  | co\_stacksize | требуемый размер стека виртуальной машины |60|  | co\_varnames | кортеж имён аргументов и локальных переменных |61| встроенный | doc | строка документации |62|  | name | исходное имя этой функции или метода |63|  | self | экземпляр, к которому привязан метод, или `None` |6465#### `inspect.getmembers(object[, predicate])`6667Возвращает все члены объекта в виде списка пар (имя, значение), отсортированных по имени. Если передан необязательный аргумент *predicate*, включаются только те члены, для которых предикат возвращает истинное значение.6869> **Примечание**70>71> [`getmembers()`](https://python-all.ru/3.3/library/inspect.html#inspect.getmembers) не возвращает атрибуты метакласса, когда аргумент является классом (это поведение унаследовано от функции [`dir()`](https://python-all.ru/3.3/library/functions.html#dir)).7273#### `inspect.getmoduleinfo(path)`7475Возвращает [*именованный кортеж*](https://python-all.ru/3.3/glossary.html#term-named-tuple) `ModuleInfo(name, suffix, mode, module_type)` со значениями, описывающими, как Python будет интерпретировать файл по *path*, если это модуль, или `None`, если он не идентифицируется как модуль. В этом кортеже *name* – имя модуля без имени оборачивающего пакета, *suffix* – конечная часть имени файла (которая может быть не расширением, отделённым точкой), *mode* – режим [`open()`](https://python-all.ru/3.3/library/functions.html#open), который будет использован (`'r'` или `'rb'`), а *module\_type* – целое число, представляющее тип модуля. *module\_type* будет иметь значение, которое можно сравнить с константами, определёнными в модуле [`imp`](https://python-all.ru/3.3/library/imp.html#module-imp); подробнее о типах модулей см. документацию этого модуля.7677Устарело с версии 3.3: Можно проверить суффикс пути к файлу среди поддерживаемых суффиксов, перечисленных в [`importlib.machinery`](https://python-all.ru/3.3/library/importlib.html#module-importlib.machinery), чтобы вывести ту же информацию.7879#### `inspect.getmodulename(path)`8081Возвращает имя модуля, задаваемое файлом *path*, без имён оборачивающих пакетов. Расширение файла проверяется по всем записям из [`importlib.machinery.all_suffixes()`](https://python-all.ru/3.3/library/importlib.html#importlib.machinery.all_suffixes). Если совпадение найдено, возвращается последний компонент пути с удалённым расширением. В противном случае возвращается `None`.8283Note that this function *only* returns a meaningful name for actual Python modules - paths that potentially refer to Python packages will still return `None`.8485Изменено в версии 3.3: Эта функция теперь напрямую основана на [`importlib`](https://python-all.ru/3.3/library/importlib.html#module-importlib), а не на устаревшей [`getmoduleinfo()`](https://python-all.ru/3.3/library/inspect.html#inspect.getmoduleinfo).8687#### `inspect.ismodule(object)`8889Возвращает True, если объект является модулем.9091#### `inspect.isclass(object)`9293Возвращает True, если объект является классом, встроенным или созданным в коде Python.9495#### `inspect.ismethod(object)`9697Возвращает True, если объект является связанным методом, написанным на Python.9899#### `inspect.isfunction(object)`100101Возвращает True, если объект является функцией Python, включая функции, созданные с помощью выражения [*lambda*](https://python-all.ru/3.3/glossary.html#term-lambda).102103#### `inspect.isgeneratorfunction(object)`104105Возвращает True, если объект является функцией-генератором Python.106107#### `inspect.isgenerator(object)`108109Возвращает True, если объект является генератором.110111#### `inspect.istraceback(object)`112113Возвращает True, если объект является трассировкой.114115#### `inspect.isframe(object)`116117Возвращает True, если объект является фреймом.118119#### `inspect.iscode(object)`120121Возвращает True, если объект является кодом.122123#### `inspect.isbuiltin(object)`124125Возвращает True, если объект является встроенной функцией или связанным встроенным методом.126127#### `inspect.isroutine(object)`128129Возвращает True, если объект является пользовательской или встроенной функцией или методом.130131#### `inspect.isabstract(object)`132133Возвращает True, если объект является абстрактным базовым классом.134135#### `inspect.ismethoddescriptor(object)`136137Возвращает true, если объект является дескриптором метода, но не если [`ismethod()`](https://python-all.ru/3.3/library/inspect.html#inspect.ismethod), [`isclass()`](https://python-all.ru/3.3/library/inspect.html#inspect.isclass), [`isfunction()`](https://python-all.ru/3.3/library/inspect.html#inspect.isfunction) или [`isbuiltin()`](https://python-all.ru/3.3/library/inspect.html#inspect.isbuiltin) возвращают true.138139Это, например, верно для `int.__add__`. Объект, проходящий эту проверку, имеет атрибут `__get__`, но не имеет атрибута `__set__`, а кроме того, набор атрибутов различается. `__name__` обычно осмысленно, и `__doc__` часто тоже.140141Методы, реализованные через дескрипторы и также проходящие один из других тестов, возвращают false для теста [`ismethoddescriptor()`](https://python-all.ru/3.3/library/inspect.html#inspect.ismethoddescriptor) просто потому, что другие тесты обещают больше – например, можно рассчитывать на наличие атрибута `__func__` (и т.д.), когда объект проходит [`ismethod()`](https://python-all.ru/3.3/library/inspect.html#inspect.ismethod).142143#### `inspect.isdatadescriptor(object)`144145Возвращает True, если объект является дескриптором данных.146147Дескрипторы данных имеют как атрибут `__get__`, так и атрибут `__set__`. Примеры: свойства (определённые в Python), getsets и элементы. Последние два определены на C, и для этих типов существуют более специфичные проверки, которые работают во всех реализациях Python. Обычно дескрипторы данных также имеют атрибуты `__name__` и `__doc__` (свойства, getsets и элементы имеют оба этих атрибута), но это не гарантируется.148149#### `inspect.isgetsetdescriptor(object)`150151Возвращает True, если объект является дескриптором getset.152153**Особенности реализации CPython:** getsets – это атрибуты, определённые в модулях расширения через структуры `PyGetSetDef`. Для реализаций Python без таких типов этот метод всегда возвращает `False`.154155#### `inspect.ismemberdescriptor(object)`156157Возвращает True, если объект является дескриптором члена.158159**Особенность реализации CPython:** Дескрипторы членов – это атрибуты, определяемые в модулях расширения через структуры [`PyMemberDef`](https://python-all.ru/3.3/c-api/structures.html#PyMemberDef). Для реализаций Python без таких типов этот метод всегда возвращает `False`.160161## 28.12.2. Получение исходного кода162163#### `inspect.getdoc(object)`164165Возвращает строку документации объекта, очищенную с помощью [`cleandoc()`](https://python-all.ru/3.3/library/inspect.html#inspect.cleandoc).166167#### `inspect.getcomments(object)`168169Возвращает единой строкой все строки комментариев, непосредственно предшествующие исходному коду объекта (для класса, функции или метода) или находящиеся в начале исходного файла Python (если объект – модуль).170171#### `inspect.getfile(object)`172173Возвращает имя (текстового или бинарного) файла, в котором определён объект. Это вызовет [`TypeError`](https://python-all.ru/3.3/library/exceptions.html#TypeError), если объект является встроенным модулем, классом или функцией.174175#### `inspect.getmodule(object)`176177Пытается определить модуль, в котором был определён объект.178179#### `inspect.getsourcefile(object)`180181Возвращает имя исходного файла Python, в котором определён объект. Это вызовет [`TypeError`](https://python-all.ru/3.3/library/exceptions.html#TypeError), если объект является встроенным модулем, классом или функцией.182183#### `inspect.getsourcelines(object)`184185Возвращает список строк исходного кода и номер начальной строки для объекта. Аргументом может быть модуль, класс, метод, функция, traceback, frame или code object. Исходный код возвращается в виде списка строк, соответствующих объекту, а номер строки указывает, где в исходном файле находится первая строка кода. Если исходный код не удаётся получить, возбуждается [`OSError`](https://python-all.ru/3.3/library/exceptions.html#OSError).186187Изменено в версии 3.3: [`OSError`](https://python-all.ru/3.3/library/exceptions.html#OSError) возбуждается вместо [`IOError`](https://python-all.ru/3.3/library/exceptions.html#IOError), который теперь является его псевдонимом.188189#### `inspect.getsource(object)`190191Возвращает текст исходного кода объекта. Аргументом может быть модуль, класс, метод, функция, traceback, frame или code object. Исходный код возвращается в виде одной строки. Если исходный код не удаётся получить, возбуждается [`OSError`](https://python-all.ru/3.3/library/exceptions.html#OSError).192193Изменено в версии 3.3: [`OSError`](https://python-all.ru/3.3/library/exceptions.html#OSError) возбуждается вместо [`IOError`](https://python-all.ru/3.3/library/exceptions.html#IOError), который теперь является его псевдонимом.194195#### `inspect.cleandoc(doc)`196197Убирает отступы из строк документации, которые добавлены для выравнивания с блоками кода. Удаляются все пробельные символы, которые можно равномерно убрать, начиная со второй строки. Также все табуляции заменяются пробелами.198199## 28.12.3. Интроспекция вызываемых объектов с помощью объекта Signature200201Новое в версии 3.3.202203Объект Signature представляет сигнатуру вызова вызываемого объекта и его аннотацию возврата. Чтобы получить объект Signature, используйте функцию [`signature()`](https://python-all.ru/3.3/library/inspect.html#inspect.signature).204205#### `inspect.signature(callable)`206207Возвращает объект [`Signature`](https://python-all.ru/3.3/library/inspect.html#inspect.Signature) для заданного `callable`:208209```python210>>> from inspect import signature211>>> def foo(a, *, b:int, **kwargs):212...     pass213214>>> sig = signature(foo)215216>>> str(sig)217'(a, *, b:int, **kwargs)'218219>>> str(sig.parameters['b'])220'b:int'221222>>> sig.parameters['b'].annotation223<class 'int'>224```225226Принимает широкий спектр вызываемых объектов Python: от обычных функций и классов до объектов [`functools.partial()`](https://python-all.ru/3.3/library/functools.html#functools.partial).227228> **Примечание**229>230> Некоторые вызываемые объекты могут не поддаваться интроспекции в некоторых реализациях Python. Например, в CPython встроенные функции, определённые на C, не предоставляют метаданных о своих аргументах.231232#### `class inspect.Signature(parameters=None, *, return_annotation=Signature.empty)`233234Объект Signature представляет сигнатуру вызова функции и её аннотацию возврата. Для каждого параметра, принимаемого функцией, он хранит объект [`Parameter`](https://python-all.ru/3.3/library/inspect.html#inspect.Parameter) в своей коллекции [`parameters`](https://python-all.ru/3.3/library/inspect.html#inspect.Signature.parameters).235236Необязательный аргумент *parameters* представляет собой последовательность объектов [`Parameter`](https://python-all.ru/3.3/library/inspect.html#inspect.Parameter), которая проверяется: в ней не должно быть параметров с дублирующимися именами, параметры должны быть в правильном порядке (сначала только позиционные, затем позиционно-ключевые), а параметры со значениями по умолчанию должны следовать после параметров без них.237238Необязательный аргумент *return\_annotation* может быть произвольным объектом Python и является аннотацией возвращаемого значения вызываемого объекта.239240Объекты Signature являются *неизменяемыми*. Используйте [`Signature.replace()`](https://python-all.ru/3.3/library/inspect.html#inspect.Signature.replace), чтобы создать изменённую копию.241242#### `empty`243244Специальный маркер уровня класса для указания отсутствия аннотации возврата.245246#### `parameters`247248Упорядоченное отображение имён параметров на соответствующие объекты [`Parameter`](https://python-all.ru/3.3/library/inspect.html#inspect.Parameter).249250#### `return_annotation`251252Аннотация возврата для вызываемого объекта. Если у вызываемого объекта нет аннотации возврата, этот атрибут устанавливается в [`Signature.empty`](https://python-all.ru/3.3/library/inspect.html#inspect.Signature.empty).253254#### `bind(*args, **kwargs)`255256Создаёт отображение позиционных и именованных аргументов на параметры. Возвращает [`BoundArguments`](https://python-all.ru/3.3/library/inspect.html#inspect.BoundArguments), если `*args` и `**kwargs` соответствуют сигнатуре, или вызывает исключение [`TypeError`](https://python-all.ru/3.3/library/exceptions.html#TypeError).257258#### `bind_partial(*args, **kwargs)`259260Работает так же, как [`Signature.bind()`](https://python-all.ru/3.3/library/inspect.html#inspect.Signature.bind), но допускает пропуск некоторых обязательных аргументов (имитирует поведение [`functools.partial()`](https://python-all.ru/3.3/library/functools.html#functools.partial)). Возвращает [`BoundArguments`](https://python-all.ru/3.3/library/inspect.html#inspect.BoundArguments) или вызывает исключение [`TypeError`](https://python-all.ru/3.3/library/exceptions.html#TypeError), если переданные аргументы не соответствуют сигнатуре.261262#### `replace(*[, parameters][, return_annotation])`263264Создаёт новый экземпляр Signature на основе экземпляра, для которого был вызван replace. Можно передать другие `parameters` и/или `return_annotation`, чтобы переопределить соответствующие свойства базовой сигнатуры. Чтобы удалить return\_annotation из скопированной Signature, передайте [`Signature.empty`](https://python-all.ru/3.3/library/inspect.html#inspect.Signature.empty).265266```python267>>> def test(a, b):268...     pass269>>> sig = signature(test)270>>> new_sig = sig.replace(return_annotation="new return anno")271>>> str(new_sig)272"(a, b) -> 'new return anno'"273```274275#### `class inspect.Parameter(name, kind, *, default=Parameter.empty, annotation=Parameter.empty)`276277Объекты Parameter являются *неизменяемыми*. Вместо изменения объекта Parameter можно использовать [`Parameter.replace()`](https://python-all.ru/3.3/library/inspect.html#inspect.Parameter.replace) для создания изменённой копии.278279#### `empty`280281Специальный маркер уровня класса для указания отсутствия значений по умолчанию и аннотаций.282283#### `name`284285Имя параметра в виде строки. Должно быть допустимым идентификатором Python (за исключением параметров `POSITIONAL_ONLY`, для которых можно установить `None`).286287#### `default`288289Значение по умолчанию для параметра. Если у параметра нет значения по умолчанию, этот атрибут устанавливается в [`Parameter.empty`](https://python-all.ru/3.3/library/inspect.html#inspect.Parameter.empty).290291#### `annotation`292293Аннотация для параметра. Если у параметра нет аннотации, этот атрибут устанавливается в [`Parameter.empty`](https://python-all.ru/3.3/library/inspect.html#inspect.Parameter.empty).294295#### `kind`296297Описывает, как значения аргументов привязываются к параметру. Возможные значения (доступны через [`Parameter`](https://python-all.ru/3.3/library/inspect.html#inspect.Parameter), например `Parameter.KEYWORD_ONLY`):298299| Имя | Значение |300| --- | --- |301| *POSITIONAL\_ONLY* | Значение должно передаваться как позиционный аргумент. В Python нет явного синтаксиса для определения только позиционных параметров, но многие встроенные функции и функции модулей расширения (особенно те, что принимают только один или два параметра) их поддерживают. |302| *POSITIONAL\_OR\_KEYWORD* | Значение может передаваться как ключевой, так и позиционный аргумент (это стандартное поведение привязки для функций, реализованных на Python). |303| *VAR\_POSITIONAL* | Кортеж позиционных аргументов, которые не привязаны ни к одному другому параметру. Это соответствует параметру `*args` в определении функции Python. |304| *KEYWORD\_ONLY* | Значение должно быть передано как именованный аргумент. Параметры, доступные только по ключу, – это те, которые следуют после записи `*` или `*args` в определении функции Python. |305| *VAR\_KEYWORD* | Словарь именованных аргументов, которые не привязаны ни к одному другому параметру. Это соответствует параметру `**kwargs` в определении функции Python. |306307Пример: вывод всех аргументов только для ключевой передачи без значений по умолчанию:308309```python310>>> def foo(a, b, *, c, d=10):311...     pass312313>>> sig = signature(foo)314>>> for param in sig.parameters.values():315...     if (param.kind == param.KEYWORD_ONLY and316...                        param.default is param.empty):317...         print('Parameter:', param)318Parameter: c319```320321#### `replace(*[, name][, kind][, default][, annotation])`322323Создаёт новый экземпляр Parameter на основе экземпляра, на котором был вызван метод replace. Чтобы переопределить атрибут [`Parameter`](https://python-all.ru/3.3/library/inspect.html#inspect.Parameter), передайте соответствующий аргумент. Чтобы удалить значение по умолчанию и/или аннотацию из параметра, передайте [`Parameter.empty`](https://python-all.ru/3.3/library/inspect.html#inspect.Parameter.empty).324325```python326>>> from inspect import Parameter327>>> param = Parameter('foo', Parameter.KEYWORD_ONLY, default=42)328>>> str(param)329'foo=42'330331>>> str(param.replace()) # Создаст поверхностную копию 'param'332'foo=42'333334>>> str(param.replace(default=Parameter.empty, annotation='spam'))335"foo:'spam'"336```337338#### `class inspect.BoundArguments`339340Результат вызова [`Signature.bind()`](https://python-all.ru/3.3/library/inspect.html#inspect.Signature.bind) или [`Signature.bind_partial()`](https://python-all.ru/3.3/library/inspect.html#inspect.Signature.bind_partial). Содержит отображение аргументов на параметры функции.341342#### `arguments`343344Упорядоченное изменяемое отображение ([`collections.OrderedDict`](https://python-all.ru/3.3/library/collections.html#collections.OrderedDict)) имён параметров на значения аргументов. Содержит только явно связанные аргументы. Изменения в [`arguments`](https://python-all.ru/3.3/library/inspect.html#inspect.BoundArguments.arguments) отразятся в [`args`](https://python-all.ru/3.3/library/inspect.html#inspect.BoundArguments.args) и [`kwargs`](https://python-all.ru/3.3/library/inspect.html#inspect.BoundArguments.kwargs).345346Следует использовать вместе с [`Signature.parameters`](https://python-all.ru/3.3/library/inspect.html#inspect.Signature.parameters) для любых целей обработки аргументов.347348> **Примечание**349>350> Аргументы, для которых [`Signature.bind()`](https://python-all.ru/3.3/library/inspect.html#inspect.Signature.bind) или [`Signature.bind_partial()`](https://python-all.ru/3.3/library/inspect.html#inspect.Signature.bind_partial) полагались на значение по умолчанию, пропускаются. Однако при необходимости их легко включить.351352```python353>>> def foo(a, b=10):354...     pass355356>>> sig = signature(foo)357>>> ba = sig.bind(5)358359>>> ba.args, ba.kwargs360((5,), {})361362>>> for param in sig.parameters.values():363...     if param.name not in ba.arguments:364...         ba.arguments[param.name] = param.default365366>>> ba.args, ba.kwargs367((5, 10), {})368```369370#### `args`371372Кортеж значений позиционных аргументов. Вычисляется динамически из атрибута [`arguments`](https://python-all.ru/3.3/library/inspect.html#inspect.BoundArguments.arguments).373374#### `kwargs`375376Словарь значений именованных аргументов. Вычисляется динамически из атрибута [`arguments`](https://python-all.ru/3.3/library/inspect.html#inspect.BoundArguments.arguments).377378Свойства [`args`](https://python-all.ru/3.3/library/inspect.html#inspect.BoundArguments.args) и [`kwargs`](https://python-all.ru/3.3/library/inspect.html#inspect.BoundArguments.kwargs) можно использовать для вызова функций:379380```python381def test(a, *, b):382   ...383384sig = signature(test)385ba = sig.bind(10, b=20)386test(*ba.args, **ba.kwargs)387```388389> **См. также**390>391> **[**PEP 362**](https://python-all.ru/3.3/library/inspect.html) – объект сигнатуры функции.**392>393> Подробная спецификация, детали реализации и примеры.394395## 28.12.4. Классы и функции396397#### `inspect.getclasstree(classes, unique=False)`398399Упорядочивает заданный список классов в иерархию вложенных списков. Если встречается вложенный список, он содержит классы, унаследованные от класса, запись которого непосредственно предшествует этому списку. Каждая запись представляет собой кортеж из двух элементов, содержащий класс и кортеж его базовых классов. Если аргумент *unique* равен true, в возвращаемой структуре появляется ровно одна запись для каждого класса из заданного списка. В противном случае классы, использующие множественное наследование, и их потомки будут появляться несколько раз.400401#### `inspect.getargspec(func)`402403Получает имена и значения по умолчанию аргументов функции Python. Возвращается [*именованный кортеж*](https://python-all.ru/3.3/glossary.html#term-named-tuple) `ArgSpec(args, varargs, keywords, defaults)`. *args* – список имён аргументов. *varargs* и *keywords* – имена аргументов `*` и `**` или `None`. *defaults* – кортеж значений по умолчанию аргументов или `None`, если аргументов по умолчанию нет; если этот кортеж содержит *n* элементов, они соответствуют последним *n* элементам, перечисленным в *args*.404405Устарело с версии 3.0: Вместо этого используйте [`getfullargspec()`](https://python-all.ru/3.3/library/inspect.html#inspect.getfullargspec), который предоставляет информацию об именованных аргументах (keyword-only) и аннотациях.406407#### `inspect.getfullargspec(func)`408409Возвращает имена и значения по умолчанию аргументов функции Python. Возвращается [*именованный кортеж*](https://python-all.ru/3.3/glossary.html#term-named-tuple):410411`FullArgSpec(args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, annotations)`412413*args* – список имён аргументов. *varargs* и *varkw* – имена аргументов `*` и `**` или `None`. *defaults* – *n*-кортеж значений по умолчанию последних *n* аргументов, или `None`, если аргументов по умолчанию нет. *kwonlyargs* – список имён именованных аргументов (keyword-only). *kwonlydefaults* – словарь, отображающий имена из kwonlyargs в значения по умолчанию. *annotations* – словарь, отображающий имена аргументов в аннотации.414415Первые четыре элемента в кортеже соответствуют [`getargspec()`](https://python-all.ru/3.3/library/inspect.html#inspect.getargspec).416417> **Примечание**418>419> Рекомендуется использовать новый интерфейс [*объекта Signature*](https://python-all.ru/3.3/library/inspect.html#inspect-signature-object), который предоставляет лучший способ интроспекции функций.420421#### `inspect.getargvalues(frame)`422423Получает информацию об аргументах, переданных в конкретный фрейм. Возвращается [*именованный кортеж*](https://python-all.ru/3.3/glossary.html#term-named-tuple) `ArgInfo(args, varargs, keywords, locals)`. *args* – список имён аргументов. *varargs* и *keywords* – имена аргументов `*` и `**` или `None`. *locals* – словарь локальных переменных данного фрейма.424425#### `inspect.formatargspec(args[, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, annotations[, formatarg, formatvarargs, formatvarkw, formatvalue, formatreturns, formatannotations]])`426427Форматирует красивое описание аргументов из значений, возвращаемых [`getargspec()`](https://python-all.ru/3.3/library/inspect.html#inspect.getargspec) или [`getfullargspec()`](https://python-all.ru/3.3/library/inspect.html#inspect.getfullargspec).428429Первые семь аргументов – это (`args`, `varargs`, `varkw`, `defaults`, `kwonlyargs`, `kwonlydefaults`, `annotations`). Остальные пять аргументов – соответствующие опциональные функции форматирования, которые вызываются для преобразования имён и значений в строки. Последний аргумент – опциональная функция для форматирования последовательности аргументов. Например:430431```python432>>> from inspect import formatargspec, getfullargspec433>>> def f(a: int, b: float):434...     pass435...436>>> formatargspec(*getfullargspec(f))437'(a: int, b: float)'438```439440#### `inspect.formatargvalues(args[, varargs, varkw, locals, formatarg, formatvarargs, formatvarkw, formatvalue])`441442Форматирует красивое описание аргументов из четырёх значений, возвращаемых [`getargvalues()`](https://python-all.ru/3.3/library/inspect.html#inspect.getargvalues). Аргументы format\* – это соответствующие необязательные функции форматирования, которые вызываются для преобразования имён и значений в строки.443444#### `inspect.getmro(cls)`445446Возвращает кортеж базовых классов класса cls, включая cls, в порядке разрешения методов (MRO). Ни один класс не встречается в этом кортеже более одного раза. Обратите внимание, что порядок разрешения методов зависит от типа cls. Если не используется особенная пользовательская метатипизация, cls будет первым элементом кортежа.447448#### `inspect.getcallargs(func, *args, **kwds)`449450Привязывает *args* и *kwds* к именам аргументов функции или метода Python *func*, как если бы она была вызвана с ними. Для привязанных методов также привязывает первый аргумент (обычно с именем `self`) к соответствующему экземпляру. Возвращается словарь, отображающий имена аргументов (включая имена аргументов `*` и `**`, если они есть) в их значения из *args* и *kwds*. В случае некорректного вызова *func*, т.е. когда `func(*args, **kwds)` вызвало бы исключение из-за несовместимой сигнатуры, возникает исключение того же типа и с тем же или похожим сообщением. Например:451452```python453>>> from inspect import getcallargs454>>> def f(a, b=1, *pos, **named):455...     pass456>>> getcallargs(f, 1, 2, 3) == {'a': 1, 'named': {}, 'b': 2, 'pos': (3,)}457True458>>> getcallargs(f, a=2, x=4) == {'a': 2, 'named': {'x': 4}, 'b': 1, 'pos': ()}459True460>>> getcallargs(f)461Traceback (most recent call last):462...463TypeError: f() missing 1 required positional argument: 'a'464```465466Новое в версии 3.2.467468> **Примечание**469>470> Вместо этого рекомендуется использовать новый [`Signature.bind()`](https://python-all.ru/3.3/library/inspect.html#inspect.Signature.bind).471472#### `inspect.getclosurevars(func)`473474Получает отображение внешних ссылок на имена в функции или методе Python *func* на их текущие значения. Возвращается [*именованный кортеж*](https://python-all.ru/3.3/glossary.html#term-named-tuple) `ClosureVars(nonlocals, globals, builtins, unbound)`. *nonlocals* отображает ссылочные имена на лексические переменные замыкания, *globals* – на глобальные переменные модуля функции, а *builtins* – на встроенные функции, видимые из тела функции. *unbound* – это множество имён, на которые есть ссылки в функции, но которые не удалось разрешить при текущих глобальных переменных модуля и встроенных функциях.475476[`TypeError`](https://python-all.ru/3.3/library/exceptions.html#TypeError) вызывается, если *func* не является функцией или методом Python.477478Новое в версии 3.3.479480## 28.12.5. Стек интерпретатора481482Когда следующие функции возвращают «записи фреймов» (frame records), каждая запись представляет собой кортеж из шести элементов: объект фрейма, имя файла, номер текущей строки, имя функции, список строк контекста из исходного кода и индекс текущей строки в этом списке.483484> **Примечание**485>486> Хранение ссылок на объекты фреймов (как в первом элементе записей фреймов, возвращаемых этими функциями) может привести к созданию циклических ссылок в программе. После создания циклической ссылки время жизни всех объектов, доступных из объектов, образующих цикл, может значительно увеличиться, даже если включён дополнительный детектор циклов Python. Если такие циклы необходимо создать, важно убедиться, что они явно разрываются, чтобы избежать задержки уничтожения объектов и увеличения потребления памяти.487>488> Хотя детектор циклов перехватит их, уничтожение фреймов (и локальных переменных) можно сделать детерминированным, удалив цикл в блоке [`finally`](https://python-all.ru/3.3/reference/compound_stmts.html#finally). Это также важно, если детектор циклов был отключён при компиляции Python или с помощью [`gc.disable()`](https://python-all.ru/3.3/library/gc.html#gc.disable). Например:489>490> ```python491> def handle_stackframe_without_leak():492>     frame = inspect.currentframe()493>     try:494>         # Выполнить действие с фреймом495>     finally:496>         del frame497> ```498499Необязательный аргумент *context*, поддерживаемый большинством этих функций, задаёт количество возвращаемых строк контекста, которые располагаются вокруг текущей строки.500501#### `inspect.getframeinfo(frame, context=1)`502503Возвращает информацию об объекте фрейма или traceback. Возвращается [*именованный кортеж*](https://python-all.ru/3.3/glossary.html#term-named-tuple) `Traceback(filename, lineno, function, code_context, index)`.504505#### `inspect.getouterframes(frame, context=1)`506507Возвращает список записей фреймов для фрейма и всех внешних фреймов. Эти фреймы представляют вызовы, которые привели к созданию *frame*. Первая запись в возвращаемом списке представляет *frame*; последняя запись представляет самый внешний вызов в стеке *frame*.508509#### `inspect.getinnerframes(traceback, context=1)`510511Возвращает список записей о фреймах для фрейма traceback и всех внутренних фреймов. Эти фреймы представляют вызовы, являющиеся следствием *frame*. Первый элемент списка представляет *traceback*; последний элемент представляет место, где было возбуждено исключение.512513#### `inspect.currentframe()`514515Возвращает объект фрейма для фрейма стека вызывающего.516517**Особенность реализации CPython:** Эта функция полагается на поддержку стековых фреймов Python в интерпретаторе, которая не гарантируется во всех реализациях Python. Если запуск происходит в реализации без поддержки стековых фреймов Python, эта функция возвращает `None`.518519#### `inspect.stack(context=1)`520521Возвращает список записей о фреймах для стека вызывающего кода. Первый элемент возвращаемого списка представляет вызывающий код; последний элемент представляет самый внешний вызов в стеке.522523#### `inspect.trace(context=1)`524525Возвращает список записей о фреймах для стека между текущим фреймом и фреймом, в котором было возбуждено исключение, обрабатываемое в данный момент. Первый элемент списка представляет вызывающий код; последний элемент представляет место, где было возбуждено исключение.526527## 28.12.6. Статическое получение атрибутов528529Как [`getattr()`](https://python-all.ru/3.3/library/functions.html#getattr), так и [`hasattr()`](https://python-all.ru/3.3/library/functions.html#hasattr) могут запускать выполнение кода при получении или проверке существования атрибутов. Дескрипторы, такие как свойства, будут вызваны, и [`__getattr__()`](https://python-all.ru/3.3/reference/datamodel.html#object.__getattr__) и [`__getattribute__()`](https://python-all.ru/3.3/reference/datamodel.html#object.__getattribute__) также могут быть вызваны.530531Для случаев, когда требуется пассивная интроспекция, например, в инструментах документации, это может быть неудобно. [`getattr_static()`](https://python-all.ru/3.3/library/inspect.html#inspect.getattr_static) имеет ту же сигнатуру, что и [`getattr()`](https://python-all.ru/3.3/library/functions.html#getattr), но не выполняет код при получении атрибутов.532533#### `inspect.getattr_static(obj, attr, default=None)`534535Извлекает атрибуты без запуска динамического поиска через протокол дескрипторов, [`__getattr__()`](https://python-all.ru/3.3/reference/datamodel.html#object.__getattr__) или [`__getattribute__()`](https://python-all.ru/3.3/reference/datamodel.html#object.__getattribute__).536537Примечание: эта функция может быть не в состоянии получить все атрибуты, которые может получить getattr (например, динамически созданные атрибуты), и может найти атрибуты, которые getattr не может (например, дескрипторы, вызывающие AttributeError). Она также может возвращать объекты дескрипторов вместо членов экземпляра.538539Если [`__dict__`](https://python-all.ru/3.3/library/stdtypes.html#object.__dict__) экземпляра затенён другим членом (например, свойством), то эта функция не сможет найти члены экземпляра.540541Новое в версии 3.2.542543[`getattr_static()`](https://python-all.ru/3.3/library/inspect.html#inspect.getattr_static) не разрешает дескрипторы, например, дескрипторы слотов или getset-дескрипторы для объектов, реализованных на C. Возвращается объект дескриптора вместо базового атрибута.544545С ними можно работать с помощью кода вроде следующего. Обратите внимание, что для произвольных getset-дескрипторов их вызов может запустить выполнение кода:546547```python548# Пример кода для разрешения встроенных типов дескрипторов549class _foo:550    __slots__ = ['foo']551552slot_descriptor = type(_foo.foo)553getset_descriptor = type(type(open(__file__)).name)554wrapper_descriptor = type(str.__dict__['__add__'])555descriptor_types = (slot_descriptor, getset_descriptor, wrapper_descriptor)556557result = getattr_static(some_object, 'foo')558if type(result) in descriptor_types:559    try:560        result = result.__get__()561    except AttributeError:562        # Дескрипторы могут вызывать AttributeError, чтобы563        # указать, что нет нижележащего значения564        # в этом случае сам дескриптор будет565        # придется сделать566        pass567```568569## 28.12.7. Текущее состояние генератора570571При реализации планировщиков корутин и в других продвинутых применениях генераторов полезно определять, выполняется ли генератор в данный момент, ожидает ли он запуска или возобновления, или уже завершился. [`getgeneratorstate()`](https://python-all.ru/3.3/library/inspect.html#inspect.getgeneratorstate) позволяет легко определить текущее состояние генератора.572573#### `inspect.getgeneratorstate(generator)`574575Возвращает текущее состояние генератора-итератора.576577**Возможные состояния:**578579- GEN\_CREATED: Ожидание начала выполнения.580- GEN\_RUNNING: В настоящее время выполняется интерпретатором.581- GEN\_SUSPENDED: в данный момент приостановлена на выражении yield.582- GEN\_CLOSED: выполнение завершено.583584Новое в версии 3.2.585586Текущее внутреннее состояние генератора также можно запросить. Это полезно в основном для целей тестирования, чтобы убедиться, что внутреннее состояние обновляется должным образом:587588#### `inspect.getgeneratorlocals(generator)`589590Возвращает отображение живых локальных переменных в *generator* на их текущие значения. Возвращается словарь, отображающий имена переменных в значения. Это эквивалентно вызову [`locals()`](https://python-all.ru/3.3/library/functions.html#locals) в теле генератора, и все те же предостережения действуют.591592Если *generator* – это [*generator*](https://python-all.ru/3.3/glossary.html#term-generator) без текущего связанного фрейма, то возвращается пустой словарь. [`TypeError`](https://python-all.ru/3.3/library/exceptions.html#TypeError) возбуждается, если *generator* не является объектом-генератором Python.593594**Деталь реализации CPython:** Эта функция полагается на то, что генератор предоставляет стековый фрейм Python для интроспекции, что не гарантируется во всех реализациях Python. В таких случаях эта функция всегда будет возвращать пустой словарь.595596Новое в версии 3.3.597