# `inspect` — Inspect live objects

Вихідний код: Lib/inspect.py

Модуль `inspect` надає кілька корисних функцій, які допомагають отримати інформацію про живі об’єкти, такі як модулі, класи, методи, функції, відстеження, об’єкти фрейму та об’єкти коду. Наприклад, це може допомогти вам вивчити вміст класу, отримати вихідний код методу, витягти та відформатувати список аргументів для функції або отримати всю інформацію, необхідну для відображення детального відстеження.

Цей модуль надає чотири основні види послуг: перевірка типу, отримання вихідного коду, перевірка класів і функцій і перевірка стека інтерпретатора.

## Типи та члени

The `getmembers()` function retrieves the members of an object such as a class or module. The functions whose names begin with «is» are mainly provided as convenient choices for the second argument to `getmembers()`. They also help you determine when you can expect to find the following special attributes (see Import-related attributes on module objects for module attributes):

Тип | Атрибут | опис
--- | --- | ---
клас | __doc__ | рядок документації
| __name__ | ім’я, з яким було визначено цей клас
| __qualname__ | кваліфіковане ім’я
| __module__ | ім’я модуля, в якому був визначений цей клас
| __type_params__ | A tuple containing the type parameters of a generic class
метод | __doc__ | рядок документації
| __name__ | ім’я, з яким було визначено цей метод
| __qualname__ | кваліфіковане ім’я
| __func__ | об’єкт функції, що містить реалізацію методу
| __self__ | екземпляр, до якого прив’язаний цей метод, або `None`
| __module__ | ім’я модуля, в якому був визначений цей метод
функція | __doc__ | рядок документації
| __name__ | ім’я, з яким ця функція була визначена
| __qualname__ | кваліфіковане ім’я
| __code__ | об’єкт коду, що містить скомпільовану функцію bytecode
| __defaults__ | кортеж із будь-якими значеннями за замовчуванням для позиційних або ключових параметрів
| __kwdefaults__ | відображення будь-яких значень за замовчуванням для параметрів, які містять лише ключові слова
| __globals__ | глобальний простір імен, у якому була визначена ця функція
| __builtins__ | вбудований простір імен
| __annotations__ | зіставлення назв параметрів з анотаціями; Ключ `"return"` зарезервовано для анотацій повернення.
| __type_params__ | A tuple containing the type parameters of a generic function
| __module__ | ім’я модуля, в якому була визначена ця функція
traceback | tb_frame | кадрувати об’єкт на цьому рівні
| tb_lasti | індекс останньої спроби вказівки в байт-коді
| tb_lineno | номер поточного рядка у вихідному коді Python
| tb_next | наступний внутрішній об’єкт трасування (викликається цим рівнем)
frame | f_back | наступний зовнішній об’єкт фрейму (виклик цього фрейму)
| f_builtins | вбудований простір імен, видимий цим фреймом
| f_code | об’єкт коду, який виконується в цьому кадрі
| f_globals | глобальний простір імен, видимий цим кадром
| f_lasti | індекс останньої спроби вказівки в байт-коді
| f_lineno | номер поточного рядка у вихідному коді Python
| f_locals | локальний простір імен, видимий цим кадром
| f_generator | returns the generator or coroutine object that owns this frame, or `None` if the frame is of a regular function
| f_trace | функція трасування для цього кадру або `None`
| f_trace_lines | indicate whether a tracing event is triggered for each source source line
| f_trace_opcodes | indicate whether per-opcode events are requested
| clear() | used to clear all references to local variables
код | co_argcount | кількість аргументів (не враховуючи лише аргументи ключового слова, * або ** аргументи)
| co_code | рядок необробленого скомпільованого байт-коду
| co_cellvars | кортеж імен змінних комірки (на які посилаються області, що містять)
| co_conts | кортеж констант, що використовуються в байт-коді
| co_filename | ім’я файлу, в якому створено цей об’єкт коду
| co_firstlineno | номер першого рядка у вихідному коді Python
| co_flags | растрова карта прапорів `CO_*`, читайте більше тут
| co_lnotab | кодоване відображення номерів рядків в індекси байт-коду
| co_freevars | кортеж імен вільних змінних (на які посилаються через закриття функції)
| co_posonlyargcount | кількість лише позиційних аргументів
| co_kwonlyargcount | кількість аргументів лише для ключових слів (не враховуючи аргумент **)
| co_name | ім’я, з яким було визначено цей об’єкт коду
| co_qualname | fully qualified name with which this code object was defined
| co_names | кортеж імен, відмінних від аргументів і локальних параметрів функції
| co_nlocals | кількість локальних змінних
| co_stacksize | необхідний простір у стеку віртуальної машини
| co_varnames | кортеж імен аргументів і локальних змінних
| co_lines() | returns an iterator that yields successive bytecode ranges
| co_positions() | returns an iterator of source code positions for each bytecode instruction
| replace() | returns a copy of the code object with new values
generator | __name__ | name
| __qualname__ | кваліфіковане ім’я
| gi_frame | frame
| gi_running | чи працює генератор?
| gi_code | код
| gi_yieldfrom | об’єкт повторюється за допомогою `yield from` або `None`
async generator | __name__ | name
| __qualname__ | кваліфіковане ім’я
| ag_await | об’єкт, який очікується, або `None`
| ag_frame | frame
| ag_running | чи працює генератор?
| ag_code | код
coroutine | __name__ | name
| __qualname__ | кваліфіковане ім’я
| cr_await | об’єкт, який очікується, або `None`
| cr_frame | frame
| cr_running | чи виконується співпрограма?
| cr_code | код
| cr_origin | де була створена співпрограма, або `None`. Див. `sys.set_coroutine_origin_tracking_depth()`
builtin | __doc__ | рядок документації
| __name__ | оригінальна назва цієї функції або методу
| __qualname__ | кваліфіковане ім’я
| __self__ | екземпляр, до якого прив’язаний метод, або `None`

Змінено в версії 3.5: Додайте атрибути `__qualname__` і `gi_yieldfrom` до генераторів.

Атрибут `__name__` генераторів тепер встановлюється з імені функції, а не з кодового імені, і тепер його можна змінювати.

Змінено в версії 3.7: Додайте атрибут `cr_origin` до співпрограм.

Змінено в версії 3.10: Додайте атрибут `__builtins__` до функцій.

Змінено в версії 3.14: Add `f_generator` attribute to frames.

inspect.getmembers(object[, predicate])

  Повертає всі члени об’єкта в списку пар `(ім’я, значення)`, відсортованих за назвою. Якщо вказано необов’язковий аргумент предикат, який буде викликано з об’єктом `значення` кожного члена, будуть включені лише ті члени, для яких предикат повертає справжнє значення.

  Примітка

  `getmembers()` will only return class attributes defined in the metaclass when the argument is a class and those attributes have been listed in the metaclass“ custom `__dir__()`.

inspect.getmembers_static(object[, predicate])

  Return all the members of an object in a list of `(name, value)` pairs sorted by name without triggering dynamic lookup via the descriptor protocol, __getattr__ or __getattribute__. Optionally, only return members that satisfy a given predicate.

  Примітка

  `getmembers_static()` may not be able to retrieve all members that getmembers can fetch (like dynamically created attributes) and may find members that getmembers can’t (like descriptors that raise AttributeError). It can also return descriptor objects instead of instance members in some cases.

  Added in version 3.11.

inspect.getmodulename(path)

  Повертає ім’я модуля, названого шляхом до файлу, без назв пакетів, що входять до нього. Розширення файлу перевіряється на всі записи в `importlib.machinery.all_suffixes()`. Якщо він збігається, остаточний компонент шляху повертається з видаленим розширенням. В іншому випадку повертається `None`.

  Зауважте, що ця функція тільки повертає значущу назву для фактичних модулів Python - шляхи, які потенційно посилаються на пакети Python, все одно повертатимуть `None`.

  Змінено в версії 3.3: Функція базується безпосередньо на `importlib`.

inspect.ismodule(object)

  Повертає `True`, якщо об’єкт є модулем.

inspect.isclass(object)

  Повертає `True`, якщо об’єкт є класом, вбудованим чи створеним у коді Python.

inspect.ismethod(object)

  Повертає `True`, якщо об’єкт є зв’язаним методом, написаним на Python.

inspect.ispackage(object)

  Return `True` if the object is a package.

  Added in version 3.14.

inspect.isfunction(object)

  Повертає `True`, якщо об’єкт є функцією Python, яка включає функції, створені виразом lambda.

inspect.isgeneratorfunction(object)

  Повертає `True`, якщо об’єкт є функцією генератора Python.

  Змінено в версії 3.8: Функції, загорнуті в `functools.partial()`, тепер повертають `True`, якщо загорнута функція є функцією генератора Python.

  Змінено в версії 3.13: Functions wrapped in `functools.partialmethod()` now return `True` if the wrapped function is a Python generator function.

inspect.isgenerator(object)

  Повертає `True`, якщо об’єкт є генератором.

inspect.iscoroutinefunction(object)

  Return `True` if the object is a coroutine function (a function defined with an `async def` syntax), a `functools.partial()` wrapping a coroutine function, or a sync function marked with `markcoroutinefunction()`.

  Added in version 3.5.

  Змінено в версії 3.8: Функції, загорнуті в `functools.partial()`, тепер повертають `True`, якщо загорнута функція є coroutine function.

  Змінено в версії 3.12: Sync functions marked with `markcoroutinefunction()` now return `True`.

  Змінено в версії 3.13: Functions wrapped in `functools.partialmethod()` now return `True` if the wrapped function is a coroutine function.

inspect.markcoroutinefunction(func)

  Decorator to mark a callable as a coroutine function if it would not otherwise be detected by `iscoroutinefunction()`.

  This may be of use for sync functions that return a coroutine, if the function is passed to an API that requires `iscoroutinefunction()`.

  When possible, using an `async def` function is preferred. Also acceptable is calling the function and testing the return with `iscoroutine()`.

  Added in version 3.12.

inspect.iscoroutine(object)

  Повертає `True`, якщо об’єкт є coroutine, створеною функцією `async def`.

  Added in version 3.5.

inspect.isawaitable(object)

  Повертає `True`, якщо об’єкт можна використовувати у виразі `await`.

  Can also be used to distinguish generator-based coroutines from regular generators:

      import types

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

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

  Added in version 3.5.

inspect.isasyncgenfunction(object)

  Return `True` if the object is an asynchronous generator function, for example:

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

  Added in version 3.6.

  Змінено в версії 3.8: Functions wrapped in `functools.partial()` now return `True` if the wrapped function is an asynchronous generator function.

  Змінено в версії 3.13: Functions wrapped in `functools.partialmethod()` now return `True` if the wrapped function is a coroutine function.

inspect.isasyncgen(object)

  Повертає `True`, якщо об’єкт є asynchronous generator iterator, створеним функцією asynchronous generator.

  Added in version 3.6.

inspect.istraceback(object)

  Повертає `True`, якщо об’єкт є трасуванням.

inspect.isframe(object)

  Повертає `True`, якщо об’єкт є фреймом.

inspect.iscode(object)

  Повертає `True`, якщо об’єкт є кодом.

inspect.isbuiltin(object)

  Повертає `True`, якщо об’єкт є вбудованою функцією або зв’язаним вбудованим методом.

inspect.ismethodwrapper(object)

  Return `True` if the type of object is a `MethodWrapperType`.

  These are instances of `MethodWrapperType`, such as `__str__()`, `__eq__()` and `__repr__()`.

  Added in version 3.11.

inspect.isroutine(object)

  Повертає `True`, якщо об’єкт є визначеною користувачем або вбудованою функцією чи методом.

inspect.isabstract(object)

  Повертає `True`, якщо об’єкт є абстрактним базовим класом.

inspect.ismethoddescriptor(object)

  Повертає `True`, якщо об’єкт є дескриптором методу, але не якщо `ismethod()`, `isclass()`, `isfunction()` або `isbuiltin()` є істинними.

  This, for example, is true of `int.__add__`. An object passing this test has a `__get__()` method, but not a `__set__()` method or a `__delete__()` method. Beyond that, the set of attributes varies. A `__name__` attribute is usually sensible, and `__doc__` often is.

  Methods implemented via descriptors that also pass one of the other tests return `False` from the `ismethoddescriptor()` test, simply because the other tests promise more – you can, e.g., count on having the `__func__` attribute (etc) when an object passes `ismethod()`.

  Змінено в версії 3.13: This function no longer incorrectly reports objects with `__get__()` and `__delete__()`, but not `__set__()`, as being method descriptors (such objects are data descriptors, not method descriptors).

inspect.isdatadescriptor(object)

  Повертає `True`, якщо об’єкт є дескриптором даних.

  Data descriptors have a `__set__` or a `__delete__` method. Examples are properties (defined in Python), getsets, and members. The latter two are defined in C and there are more specific tests available for those types, which is robust across Python implementations. Typically, data descriptors will also have `__name__` and `__doc__` attributes (properties, getsets, and members have both of these attributes), but this is not guaranteed.

inspect.isgetsetdescriptor(object)

  Повертає `True`, якщо об’єкт є дескриптором getset.

  getsets — це атрибути, визначені в модулях розширення за допомогою структур `PyGetSetDef`. Для реалізацій Python без таких типів цей метод завжди повертатиме `False`.

inspect.ismemberdescriptor(object)

  Повертає `True`, якщо об’єкт є дескриптором-членом.

  Дескриптори членів — це атрибути, визначені в модулях розширення за допомогою структур `PyMemberDef`. Для реалізацій Python без таких типів цей метод завжди повертатиме `False`.

## Отримання вихідного коду

inspect.getdoc(object)

  Отримайте рядок документації для об’єкта, очищений за допомогою `cleandoc()`. Якщо рядок документації для об’єкта не надано, а об’єкт є класом, методом, властивістю або дескриптором, отримайте рядок документації з ієрархії успадкування. Повертає `None`, якщо рядок документації недійсний або відсутній.

  Змінено в версії 3.5: Рядки документації тепер успадковуються, якщо не перевизначаються.

inspect.getcomments(object)

  Повертайте в одному рядку будь-які рядки коментарів безпосередньо перед вихідним кодом об’єкта (для класу, функції чи методу) або у верхній частині вихідного файлу Python (якщо об’єкт є модулем). Якщо вихідний код об’єкта недоступний, поверніть `None`. Це може статися, якщо об’єкт було визначено в C або інтерактивній оболонці.

inspect.getfile(object)

  Повертає ім’я (текстового або бінарного) файлу, у якому було визначено об’єкт. Це не вдасться з помилкою `TypeError`, якщо об’єкт є вбудованим модулем, класом або функцією.

inspect.getmodule(object)

  Спробуйте вгадати, у якому модулі було визначено об’єкт. Поверніть `None`, якщо модуль не можна визначити.

inspect.getsourcefile(object)

  Повертає ім’я вихідного файлу Python, у якому було визначено об’єкт, або `None`, якщо неможливо визначити спосіб отримання джерела. Це не вдасться з помилкою `TypeError`, якщо об’єкт є вбудованим модулем, класом або функцією.

inspect.getsourcelines(object)

  Return a list of source lines and starting line number for an object. The argument may be a module, class, method, function, traceback, frame, or code object. The source code is returned as a list of the lines corresponding to the object and the line number indicates where in the original source file the first line of code was found. An `OSError` is raised if the source code cannot be retrieved. A `TypeError` is raised if the object is a built-in module, class, or function.

  Змінено в версії 3.3: `OSError` створюється замість `IOError`, тепер псевдонім першого.

inspect.getsource(object)

  Return the text of the source code for an object. The argument may be a module, class, method, function, traceback, frame, or code object. The source code is returned as a single string. An `OSError` is raised if the source code cannot be retrieved. A `TypeError` is raised if the object is a built-in module, class, or function.

  Змінено в версії 3.3: `OSError` створюється замість `IOError`, тепер псевдонім першого.

inspect.cleandoc(doc)

  Очистіть відступи з рядків документів, які мають відступ, щоб вирівнюватися з блоками коду.

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

## Самоаналіз викликаних за допомогою об’єкта Signature

Added in version 3.3.

The `Signature` object represents the call signature of a callable object and its return annotation. To retrieve a `Signature` object, use the `signature()` function.

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

  Return a `Signature` object for the given callable:

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

      >>> sig = signature(foo)

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

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

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

  Приймає широкий діапазон викликів Python, від простих функцій і класів до об’єктів `functools.partial()`.

  If some of the annotations are strings (e.g., because `from __future__ import annotations` was used), `signature()` will attempt to automatically un-stringize the annotations using `annotationlib.get_annotations()`. The globals, locals, and eval_str parameters are passed into `annotationlib.get_annotations()` when resolving the annotations; see the documentation for `annotationlib.get_annotations()` for instructions on how to use these parameters. A member of the `annotationlib.Format` enum can be passed to the annotation_format parameter to control the format of the returned annotations. For example, use `annotation_format=annotationlib.Format.STRING` to return annotations in string format.

  Raises `ValueError` if no signature can be provided, and `TypeError` if that type of object is not supported. Also, if the annotations are stringized, and eval_str is not false, the `eval()` call(s) to un-stringize the annotations in `annotationlib.get_annotations()` could potentially raise any kind of exception.

  A slash (/) in the signature of a function denotes that the parameters prior to it are positional-only. For more info, see the FAQ entry on positional-only parameters.

  Змінено в версії 3.5: The follow_wrapped parameter was added. Pass `False` to get a signature of callable specifically (`callable.__wrapped__` will not be used to unwrap decorated callables.)

  Змінено в версії 3.10: The globals, locals, and eval_str parameters were added.

  Змінено в версії 3.14: The annotation_format parameter was added.

  Примітка

  Деякі виклики можуть бути недоступними для інтроспекції в певних реалізаціях Python. Наприклад, у CPython деякі вбудовані функції, визначені в C, не надають метаданих про свої аргументи.

  Деталі реалізації CPython: If the passed object has a `__signature__` attribute, we may use it to create the signature. The exact semantics are an implementation detail and are subject to unannounced changes. Consult the source code for current semantics.

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

  A `Signature` object represents the call signature of a function and its return annotation. For each parameter accepted by the function it stores a `Parameter` object in its `parameters` collection.

  Необов’язковий аргумент parameters — це послідовність об’єктів `Parameter`, яка перевіряється, щоб перевірити, чи немає параметрів із повторюваними іменами та чи параметри розташовано в правильному порядку, тобто спочатку лише позиційні, а потім позиційні -or-keyword, і що параметри зі значеннями за замовчуванням слідують за параметрами без значень за замовчуванням.

  The optional return_annotation argument can be an arbitrary Python object. It represents the «return» annotation of the callable.

  `Signature` objects are immutable. Use `Signature.replace()` or `copy.replace()` to make a modified copy.

  Змінено в версії 3.5: `Signature` objects are now picklable and hashable.

  empty

    Спеціальний маркер рівня класу, щоб вказати відсутність анотації повернення.

  parameters

    Впорядковане зіставлення назв параметрів із відповідними об’єктами `Parameter`. Параметри відображаються в строгому порядку визначення, включаючи параметри лише ключових слів.

    Змінено в версії 3.7: Python лише явно гарантував, що він зберіг порядок оголошення параметрів лише за ключовими словами, починаючи з версії 3.7, хоча на практиці цей порядок завжди зберігався в Python 3.

  return_annotation

    Анотація «повернення» для викликаного. Якщо викликаний не має анотації «повернення», цей атрибут має значення `Signature.empty`.

  bind(*args, **kwargs)

    Створіть відображення позиційних аргументів і аргументів ключових слів на параметри. Повертає `BoundArguments`, якщо `*args` і `**kwargs` збігаються з підписом, або викликає `TypeError`.

  bind_partial(*args, **kwargs)

    Працює так само, як `Signature.bind()`, але дозволяє пропускати деякі необхідні аргументи (імітує поведінку `functools.partial()`). Повертає `BoundArguments` або викликає `TypeError`, якщо передані аргументи не збігаються з підписом.

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

    Create a new `Signature` instance based on the instance `replace()` was invoked on. It is possible to pass different parameters and/or return_annotation to override the corresponding properties of the base signature. To remove `return_annotation` from the copied `Signature`, pass in `Signature.empty`.

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

    `Signature` objects are also supported by the generic function `copy.replace()`.

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

    Create a string representation of the `Signature` object.

    If max_width is passed, the method will attempt to fit the signature into lines of at most max_width characters. If the signature is longer than max_width, all parameters will be on separate lines.

    If quote_annotation_strings is False, annotations in the signature are displayed without opening and closing quotation marks if they are strings. This is useful if the signature was created with the `STRING` format or if `from __future__ import annotations` was used.

    Added in version 3.13.

    Змінено в версії 3.14: The unquote_annotations parameter was added.

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

    Return a `Signature` (or its subclass) object for a given callable obj.

    This method simplifies subclassing of `Signature`:

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

    Its behavior is otherwise identical to that of `signature()`.

    Added in version 3.5.

    Змінено в версії 3.10: The globals, locals, and eval_str parameters were added.

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

  `Parameter` objects are immutable. Instead of modifying a `Parameter` object, you can use `Parameter.replace()` or `copy.replace()` to create a modified copy.

  Змінено в версії 3.5: Parameter objects are now picklable and hashable.

  empty

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

  name

    Ім’я параметра у вигляді рядка. Ім’я має бути дійсним ідентифікатором Python.

    CPython генерує неявні імена параметрів у формі `.0` для об’єктів коду, які використовуються для реалізації розуміння та виразів генератора.

    Змінено в версії 3.6: These parameter names are now exposed by this module as names like `implicit0`.

  default

    Стандартне значення для параметра. Якщо параметр не має значення за замовчуванням, цей атрибут має значення `Parameter.empty`.

  annotation

    Анотація до параметра. Якщо параметр не має анотації, цей атрибут має значення `Parameter.empty`.

  kind

    Describes how argument values are bound to the parameter. The possible values are accessible via `Parameter` (like `Parameter.KEYWORD_ONLY`), and support comparison and ordering, in the following order:

    Ім’я | Значення
    --- | ---
    ПОЗИЦІЙНЕ_ЛИШЕ | Значення має бути надано як позиційний аргумент. Лише позиційні параметри – це ті, які з’являються перед записом `/` (якщо він є) у визначенні функції Python.
    POSITIONAL_OR_KEYWORD | Значення може бути надано як ключове слово або позиційний аргумент (це стандартна поведінка зв’язування для функцій, реалізованих у Python).
    VAR_POSITIONAL | Кортеж позиційних аргументів, які не прив’язані до жодного іншого параметра. Це відповідає параметру `*args` у визначенні функції Python.
    KEYWORD_ONLY | Значення має бути надано як аргумент ключового слова. Параметри лише для ключових слів – це ті, які з’являються після запису `*` або `*args` у визначенні функції Python.
    VAR_KEYWORD | Набір аргументів ключових слів, які не прив’язані до жодного іншого параметра. Це відповідає параметру `**kwargs` у визначенні функції Python.

    Example: print all keyword-only arguments without default values:

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

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

  kind.description

    Describes an enum value of `Parameter.kind`.

    Added in version 3.8.

    Example: print all descriptions of arguments:

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

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

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

    Create a new `Parameter` instance based on the instance replaced was invoked on. To override a `Parameter` attribute, pass the corresponding argument. To remove a default value or/and an annotation from a `Parameter`, pass `Parameter.empty`.

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

        >>> str(param.replace()) # Will create a shallow copy of 'param'
        'foo=42'

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

    `Parameter` objects are also supported by the generic function `copy.replace()`.

  Змінено в версії 3.4: In Python 3.3 `Parameter` objects were allowed to have `name` set to `None` if their `kind` was set to `POSITIONAL_ONLY`. This is no longer permitted.

class inspect.BoundArguments

  Результат виклику `Signature.bind()` або `Signature.bind_partial()`. Зберігає відображення аргументів у параметри функції.

  arguments

    Змінне відображення імен параметрів у значеннях аргументів. Містить лише явно пов’язані аргументи. Зміни в `arguments` відображатимуться в `args` і `kwargs`.

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

    Примітка

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

    Змінено в версії 3.9: `arguments` тепер має тип `dict`. Раніше він мав тип `collections.OrderedDict`.

  args

    Кортеж значень позиційних аргументів. Динамічно обчислюється з атрибута `arguments`.

  kwargs

    A dict of keyword arguments values. Dynamically computed from the `arguments` attribute. Arguments that can be passed positionally are included in `args` instead.

  signature

    Посилання на батьківський об’єкт `Signature`.

  apply_defaults()

    Установіть значення за замовчуванням для відсутніх аргументів.

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

    Для аргументів зі змінними ключовими словами (`**kwargs`) типовим є порожній dict.

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

    Added in version 3.5.

  The `args` and `kwargs` properties can be used to invoke functions:

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

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

Дивись також

PEP 362 - Об’єкт підпису функції.

  Детальна специфікація, деталі реалізації та приклади.

## Класи та функції

inspect.getclasstree(classes, unique=False)

  Упорядкуйте заданий список класів у ієрархію вкладених списків. Там, де з’являється вкладений список, він містить класи, похідні від класу, запис якого безпосередньо передує списку. Кожен запис є 2-кортежем, що містить клас і кортеж його базових класів. Якщо аргумент unique є істинним, у поверненій структурі з’являється рівно один запис для кожного класу в заданому списку. В іншому випадку класи, які використовують множинне успадкування, та їхні нащадки з’являтимуться кілька разів.

inspect.getfullargspec(func)

  Отримати імена та значення за замовчуванням параметрів функції Python. Повертається named tuple:

  `FullArgSpec(args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, анотації)`

  args — це список імен позиційних параметрів. varargs — це назва параметра `*` або `None`, якщо довільні позиційні аргументи не приймаються. varkw — це назва параметра `**` або `None`, якщо довільні аргументи ключового слова не приймаються. defaults — це n-кортеж значень аргументів за замовчуванням, що відповідають останнім n позиційним параметрам, або `None`, якщо такі значення за замовчуванням не визначено. kwonlyargs — це список імен параметрів лише за ключовими словами в порядку оголошення. kwonlydefaults — це словник, який зіставляє назви параметрів з kwonlyargs на значення за замовчуванням, які використовуються, якщо аргумент не надано. анотації — це словник, який зіставляє назви параметрів з анотаціями. Спеціальний ключ `"return"` використовується для повідомлення анотації значення, що повертається функцією (якщо є).

  Зауважте, що `signature()` і Signature Object надають рекомендований API для інтроспекції з можливістю виклику та підтримують додаткові режими (наприклад, лише позиційні аргументи), які іноді зустрічаються в API модуля розширення. Ця функція зберігається головним чином для використання в коді, який потребує підтримки сумісності з API модуля `inspect` Python 2.

  Змінено в версії 3.4: Ця функція тепер базується на `signature()`, але все ще ігнорує атрибути `__wrapped__` і включає вже зв’язаний перший параметр у вихідні дані підпису для зв’язаних методів.

  Змінено в версії 3.6: Раніше цей метод був задокументований як застарілий на користь `signature()` у Python 3.5, але це рішення було скасовано, щоб відновити чітко підтримуваний стандартний інтерфейс для єдиного вихідного коду Python 2/3, що переходить із застарілої версії `getargspec()` API.

  Змінено в версії 3.7: Python лише явно гарантував, що він зберіг порядок оголошення параметрів лише за ключовими словами, починаючи з версії 3.7, хоча на практиці цей порядок завжди зберігався в Python 3.

inspect.getargvalues(frame)

  Отримати інформацію про аргументи, передані в певний кадр. Повертається named tuple `ArgInfo(args, varargs, keywords, locals)`. args — це список імен аргументів. varargs і keywords — це імена аргументів `*` і `**` або `None`. locals — це словник місцевих значень даного кадру.

  Примітка

  Ця функція була випадково позначена як застаріла в Python 3.5.

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

  Відформатуйте гарну специфікацію аргументу з чотирьох значень, які повертає `getargvalues()`. Аргументи format* — це відповідні додаткові функції форматування, які викликаються для перетворення імен і значень у рядки.

  Примітка

  Ця функція була випадково позначена як застаріла в Python 3.5.

inspect.getmro(cls)

  Повертає кортеж базових класів класу cls, включаючи cls, у порядку вирішення методів. Жоден клас не з’являється більше одного разу в цьому кортежі. Зауважте, що порядок вирішення методів залежить від типу cls. Якщо не використовується дуже специфічний метатип, визначений користувачем, cls буде першим елементом кортежу.

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

  Bind the args and kwds to the argument names of the Python function or method func, as if it was called with them. For bound methods, bind also the first argument (typically named `self`) to the associated instance. A dict is returned, mapping the argument names (including the names of the `*` and `**` arguments, if any) to their values from args and kwds. In case of invoking func incorrectly, i.e. whenever `func(*args, **kwds)` would raise an exception because of incompatible signature, an exception of the same type and the same or similar message is raised. For example:

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

  Added in version 3.2.

  Застаріло починаючи з версії 3.5: Замість цього використовуйте `Signature.bind()` і `Signature.bind_partial()`.

inspect.getclosurevars(func)

  Отримайте зіставлення зовнішніх посилань на імена у функції або методі Python func на їхні поточні значення. Повертається named tuple `ClosureVars(nonlocals, globals, builtins, unbound)`. nonlocals відображає назви посилань на лексичні змінні закриття, globals на глобальні модулі функції та builtins на вбудовані елементи, видимі з тіла функції. unbound — це набір імен, на які посилається функція, які взагалі не можуть бути розпізнані з урахуванням поточних глобальних і вбудованих модулів.

  `TypeError` виникає, якщо func не є функцією або методом Python.

  Added in version 3.3.

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

  Оберніть об’єкт за допомогою func. Він слідує за ланцюжком атрибутів `__wrapped__`, повертаючи останній об’єкт у ланцюжку.

  stop — необов’язковий зворотний виклик, який приймає об’єкт у ланцюжку оболонки як єдиний аргумент, який дозволяє розгортання завершувати достроково, якщо зворотний виклик повертає справжнє значення. Якщо зворотний виклик ніколи не повертає справжнє значення, останній об’єкт у ланцюжку повертається, як зазвичай. Наприклад, `signature()` використовує це, щоб зупинити розгортання, якщо будь-який об’єкт у ланцюжку має визначений атрибут `__signature__`.

  `ValueError` виникає, якщо зустрічається цикл.

  Added in version 3.4.

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

  Обчисліть анотації dict для об’єкта.

  This is an alias for `annotationlib.get_annotations()`; see the documentation of that function for more information.

  Added in version 3.10.

  Змінено в версії 3.14: This function is now an alias for `annotationlib.get_annotations()`. Calling it as `inspect.get_annotations` will continue to work.

## Стек інтерпретатора

Some of the following functions return `FrameInfo` objects. For backwards compatibility these objects allow tuple-like operations on all attributes except `positions`. This behavior is considered deprecated and may be removed in the future.

class inspect.FrameInfo
  frame

    The frame object that the record corresponds to.

  filename

    The file name associated with the code being executed by the frame this record corresponds to.

  lineno

    The line number of the current line associated with the code being executed by the frame this record corresponds to.

  function

    The function name that is being executed by the frame this record corresponds to.

  code_context

    A list of lines of context from the source code that’s being executed by the frame this record corresponds to.

  index

    The index of the current line being executed in the `code_context` list.

  positions

    A `dis.Positions` object containing the start line number, end line number, start column offset, and end column offset associated with the instruction being executed by the frame this record corresponds to.

  Змінено в версії 3.5: Return a named tuple instead of a `tuple`.

  Змінено в версії 3.11: `FrameInfo` is now a class instance (that is backwards compatible with the previous named tuple).

class inspect.Traceback
  filename

    The file name associated with the code being executed by the frame this traceback corresponds to.

  lineno

    The line number of the current line associated with the code being executed by the frame this traceback corresponds to.

  function

    The function name that is being executed by the frame this traceback corresponds to.

  code_context

    A list of lines of context from the source code that’s being executed by the frame this traceback corresponds to.

  index

    The index of the current line being executed in the `code_context` list.

  positions

    A `dis.Positions` object containing the start line number, end line number, start column offset, and end column offset associated with the instruction being executed by the frame this traceback corresponds to.

  Змінено в версії 3.11: `Traceback` is now a class instance (that is backwards compatible with the previous named tuple).

Примітка

Зберігання посилань на об’єкти фрейму, які знаходяться в першому елементі фреймових записів, які повертаються цими функціями, може призвести до того, що ваша програма створить цикли посилань. Після створення еталонного циклу тривалість життя всіх об’єктів, до яких можна отримати доступ з об’єктів, що утворюють цикл, може стати набагато довшим, навіть якщо ввімкнено додатковий детектор циклу Python. Якщо такі цикли необхідно створити, важливо переконатися, що вони явно розірвані, щоб уникнути затримки руйнування об’єктів і збільшення споживання пам’яті, яке відбувається.

Хоча детектор циклу вловить їх, знищення кадрів (та локальних змінних) можна зробити детермінованим, видаливши цикл у реченні `finally`. Це також важливо, якщо детектор циклу було вимкнено під час компіляції Python або використання `gc.disable()`. Наприклад:

    def handle_stackframe_without_leak():
        frame = inspect.currentframe()
        try:
            # do something with the frame
        finally:
            del frame

Якщо ви хочете зберегти фрейм (наприклад, щоб пізніше надрукувати трасування), ви також можете розірвати цикли посилань за допомогою методу `frame.clear()`.

Необов’язковий аргумент context, який підтримується більшістю цих функцій, визначає кількість рядків контексту для повернення, які розташовані навколо поточного рядка.

inspect.getframeinfo(frame, context=1)

  Get information about a frame or traceback object. A `Traceback` object is returned.

  Змінено в версії 3.11: A `Traceback` object is returned instead of a named tuple.

inspect.getouterframes(frame, context=1)

  Get a list of `FrameInfo` objects for a frame and all outer frames. These frames represent the calls that lead to the creation of frame. The first entry in the returned list represents frame; the last entry represents the outermost call on frame’s stack.

  Змінено в версії 3.5: Повертається список іменованих кортежів `FrameInfo(frame, filename, lineno, function, code_context, index)` повертається.

  Змінено в версії 3.11: A list of `FrameInfo` objects is returned.

inspect.getinnerframes(traceback, context=1)

  Get a list of `FrameInfo` objects for a traceback’s frame and all inner frames. These frames represent calls made as a consequence of frame. The first entry in the list represents traceback; the last entry represents where the exception was raised.

  Змінено в версії 3.5: Повертається список іменованих кортежів `FrameInfo(frame, filename, lineno, function, code_context, index)` повертається.

  Змінено в версії 3.11: A list of `FrameInfo` objects is returned.

inspect.currentframe()

  Повертає об’єкт кадру для кадру стека абонента.

  Ця функція покладається на підтримку фрейму стека Python в інтерпретаторі, який не гарантовано існує в усіх реалізаціях Python. Якщо ця функція працює в реалізації без підтримки фрейму стека Python, ця функція повертає `None`.

inspect.stack(context=1)

  Return a list of `FrameInfo` objects for the caller’s stack. The first entry in the returned list represents the caller; the last entry represents the outermost call on the stack.

  Змінено в версії 3.5: Повертається список іменованих кортежів `FrameInfo(frame, filename, lineno, function, code_context, index)` повертається.

  Змінено в версії 3.11: A list of `FrameInfo` objects is returned.

inspect.trace(context=1)

  Return a list of `FrameInfo` objects for the stack between the current frame and the frame in which an exception currently being handled was raised in. The first entry in the list represents the caller; the last entry represents where the exception was raised.

  Змінено в версії 3.5: Повертається список іменованих кортежів `FrameInfo(frame, filename, lineno, function, code_context, index)` повертається.

  Змінено в версії 3.11: A list of `FrameInfo` objects is returned.

## Отримання атрибутів статично

Both `getattr()` and `hasattr()` can trigger code execution when fetching or checking for the existence of attributes. Descriptors, like properties, will be invoked and `__getattr__()` and `__getattribute__()` may be called.

У випадках, коли вам потрібен пасивний самоаналіз, наприклад інструменти документування, це може бути незручно. `getattr_static()` має такий самий підпис, як і `getattr()`, але уникає виконання коду, коли він отримує атрибути.

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

  Retrieve attributes without triggering dynamic lookup via the descriptor protocol, `__getattr__()` or `__getattribute__()`.

  Примітка: ця функція може бути не в змозі отримати всі атрибути, які getattr може отримати (наприклад, динамічно створені атрибути), і може знайти атрибути, які getattr не може отримати (наприклад, дескриптори, які викликають AttributeError). Він також може повертати об’єкти дескрипторів замість членів екземпляра.

  Якщо примірник `__dict__` затінений іншим членом (наприклад, властивістю), тоді ця функція не зможе знайти члени примірника.

  Added in version 3.2.

`getattr_static()` не розпізнає дескриптори, наприклад, дескриптори слотів або дескриптори getset в об’єктах, реалізованих у C. Об’єкт дескриптора повертається замість основного атрибута.

Ви можете впоратися з цим за допомогою такого коду. Зауважте, що виклик довільних дескрипторів getset може ініціювати виконання коду:

    # example code for resolving the builtin descriptor types
    class _foo:
        __slots__ = ['foo']

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

    result = getattr_static(some_object, 'foo')
    if type(result) in descriptor_types:
        try:
            result = result.__get__()
        except AttributeError:
            # descriptors can raise AttributeError to
            # indicate there is no underlying value
            # in which case the descriptor itself will
            # have to do
            pass

## Current State of Generators, Coroutines, and Asynchronous Generators

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

inspect.getgeneratorstate(generator)

  Отримати поточний стан генератора-ітератора.

  Можливі стани:

  - GEN_CREATED: Очікування на початок виконання.

  - GEN_RUNNING: наразі виконується інтерпретатором.

  - GEN_SUSPENDED: наразі призупинено на виразі yield.

  - GEN_CLOSED: виконання завершено.

  Added in version 3.2.

inspect.getcoroutinestate(coroutine)

  Отримати поточний стан об’єкта співпрограми. Функція призначена для використання з об’єктами співпрограми, створеними функціями `async def`, але вона приймає будь-який об’єкт, подібний до співпрограми, який має атрибути `cr_running` і `cr_frame`.

  Можливі стани:

  - CORO_CREATED: Очікування на початок виконання.

  - CORO_RUNNING: наразі виконується інтерпретатором.

  - CORO_SUSPENDED: наразі призупинено через вираз очікування.

  - CORO_CLOSED: виконання завершено.

  Added in version 3.5.

inspect.getasyncgenstate(agen)

  Get current state of an asynchronous generator object. The function is intended to be used with asynchronous iterator objects created by `async def` functions which use the `yield` statement, but will accept any asynchronous generator-like object that has `ag_running` and `ag_frame` attributes.

  Можливі стани:

  - AGEN_CREATED: Waiting to start execution.

  - AGEN_RUNNING: Currently being executed by the interpreter.

  - AGEN_SUSPENDED: Currently suspended at a yield expression.

  - AGEN_CLOSED: Execution has completed.

  Added in version 3.12.

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

inspect.getgeneratorlocals(generator)

  Отримайте зіставлення поточних локальних змінних у генераторі з їхніми поточними значеннями. Повертається словник, який відображає імена змінних на значення. Це еквівалент виклику `locals()` у тілі генератора, і застосовуються всі ті самі застереження.

  Якщо generator є generator без пов’язаного фрейму, повертається порожній словник. `TypeError` виникає, якщо generator не є об’єктом генератора Python.

  Ця функція покладається на те, що генератор відкриває фрейм стека Python для самоаналізу, що не гарантовано буде у всіх реалізаціях Python. У таких випадках ця функція завжди повертатиме порожній словник.

  Added in version 3.3.

inspect.getcoroutinelocals(coroutine)

  Ця функція аналогічна `getgeneratorlocals()`, але працює для об’єктів співпрограми, створених функціями `async def`.

  Added in version 3.5.

inspect.getasyncgenlocals(agen)

  This function is analogous to `getgeneratorlocals()`, but works for asynchronous generator objects created by `async def` functions which use the `yield` statement.

  Added in version 3.12.

## Кодові об’єкти Бітові прапорці

Python code objects have a `co_flags` attribute, which is a bitmap of the following flags:

inspect.CO_OPTIMIZED

  Об’єкт коду оптимізовано за допомогою швидких локальних кодів.

inspect.CO_NEWLOCALS

  If set, a new dict will be created for the frame’s `f_locals` when the code object is executed.

inspect.CO_VARARGS

  Об’єкт коду має змінний позиційний параметр (`*args`).

inspect.CO_VARKEYWORDS

  Об’єкт коду має змінний параметр ключового слова (`**kwargs`-like).

inspect.CO_NESTED

  Прапорець встановлюється, коли об’єкт коду є вкладеною функцією.

inspect.CO_GENERATOR

  Прапорець встановлюється, коли об’єкт коду є функцією генератора, тобто об’єкт генератора повертається під час виконання об’єкта коду.

inspect.CO_COROUTINE

  Прапор встановлюється, коли об’єкт коду є співпрограмою. Коли об’єкт коду виконується, він повертає об’єкт співпрограми. Дивіться PEP 492 для більш детальної інформації.

  Added in version 3.5.

inspect.CO_ITERABLE_COROUTINE

  Прапор використовується для перетворення генераторів у співпрограми на основі генератора. Об’єкти-генератори з цим прапорцем можна використовувати у виразі `очікування` і можуть `поступати від` об’єктів співпрограми. Дивіться PEP 492 для більш детальної інформації.

  Added in version 3.5.

inspect.CO_ASYNC_GENERATOR

  Прапорець встановлюється, коли об’єкт коду є функцією асинхронного генератора. Коли об’єкт коду виконується, він повертає об’єкт асинхронного генератора. Дивіться PEP 525 для більш детальної інформації.

  Added in version 3.6.

inspect.CO_HAS_DOCSTRING

  The flag is set when there is a docstring for the code object in the source code. If set, it will be the first item in `co_consts`.

  Added in version 3.14.

inspect.CO_METHOD

  The flag is set when the code object is a function defined in class scope.

  Added in version 3.14.

Примітка

Прапори є специфічними для CPython і можуть не бути визначені в інших реалізаціях Python. Крім того, прапори є деталями реалізації, і їх можна видалити або застаріти в майбутніх випусках Python. Рекомендовано використовувати загальнодоступні API з модуля `inspect` для будь-яких потреб самоаналізу.

## Buffer flags

class inspect.BufferFlags

  This is an `enum.IntFlag` that represents the flags that can be passed to the `__buffer__()` method of objects implementing the buffer protocol.

  The meaning of the flags is explained at Типи запитів на буфер.

  SIMPLE
  WRITABLE
  FORMAT
  ND
  STRIDES
  C_CONTIGUOUS
  F_CONTIGUOUS
  ANY_CONTIGUOUS
  INDIRECT
  CONTIG
  CONTIG_RO
  STRIDED
  STRIDED_RO
  RECORDS
  RECORDS_RO
  FULL
  FULL_RO
  READ
  WRITE

  Added in version 3.12.

## Інтерфейс командного рядка

Модуль `inspect` також надає базову можливість самоаналізу з командного рядка.

За замовчуванням приймає назву модуля та друкує джерело цього модуля. Натомість клас або функцію в модулі можна надрукувати, додавши двокрапку та кваліфіковане ім’я цільового об’єкта.

--details

  Надрукувати інформацію про вказаний об’єкт, а не вихідний код