29.12. inspect — 活動中のオブジェクトの情報を取得する

ソースコード: Lib/inspect.py


inspect は、活動中のオブジェクト (モジュール、クラス、メソッド、関数、トレースバック、フレームオブジェクト、コードオブジェクトなど) から情報を取得する関数を定義しており、クラスの内容を調べたり、メソッドのソースコードを取得したり、関数の引数リストを取り出して整形したり、詳細なトレースバックを表示するのに必要な情報を取得したりするために利用できます。

このモジュールの機能は4種類に分類することができます。型チェック、ソースコードの情報取得、クラスや関数からの情報取得、インタープリタのスタック情報の調査です。

29.12.1. 型とメンバー

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:

属性

説明

module __doc__

ドキュメント文字列

  __file__

ファイル名 (組み込みモジュールには存在しません)

クラス

__doc__

ドキュメント文字列

  __name__

クラスの定義名

  __qualname__ qualified name
  __module__

クラスを定義しているモジュールの名前

メソッド

__doc__

ドキュメント文字列

  __name__

メソッドの定義名

  __qualname__ qualified name
  __func__

メソッドを実装している関数オブジェクト

  __self__

メソッドに結合しているインスタンス、または None

function __doc__

ドキュメント文字列

  __name__

関数の定義名

  __qualname__ qualified name
  __code__

関数をコンパイルしたバイトコード (bytecode) を格納するコードオブジェクト

  __defaults__

位置またはキーワード引数の全ての既定値のタプル

  __kwdefaults__

キーワード専用引数の全ての既定値のマッピング

  __globals__

関数が定義されたグローバル名前空間

  __annotations__

仮引数名からアノテーションへのマッピング; "return" キーは return アノテーションに予約されています

traceback tb_frame

このレベルのフレームオブジェクト

  tb_lasti

最後に実行しようとしたバイトコード中のインストラクションを示すインデックス

  tb_lineno

現在の Python ソースコードの行番号

  tb_next

このオブジェクトの内側 (このレベルから呼び出された) のトレースバックオブジェクト

フレーム

f_back

外側 (このフレームを呼び出した) のフレームオブジェクト

  f_builtins

このフレームで参照している組み込み名前空間

  f_code

このフレームで実行しているコードオブジェクト

  f_globals

このフレームで参照しているグローバル名前空間

  f_lasti

最後に実行しようとしたバイトコード中のインストラクションを示すインデックス

  f_lineno

現在の Python ソースコードの行番号

  f_locals

このフレームで参照しているローカル名前空間

  f_restricted

制限実行モードなら1、それ以外なら0

  f_trace

このフレームのトレース関数、または None

コード

co_argcount number of arguments (not including keyword only arguments, * or ** args)
  co_code

コンパイルされたバイトコードそのままの文字列

  co_cellvars tuple of names of cell variables (referenced by containing scopes)
  co_consts

バイトコード中で使用している定数のタプル

  co_filename

コードオブジェクトを生成したファイルのファイル名

  co_firstlineno

Python ソースコードの先頭行

  co_flags bitmap of CO_* flags, read more here
  co_lnotab

行番号からバイトコードインデックスへの変換表を文字列にエンコードしたもの

  co_freevars tuple of names of free variables (referenced via a function’s closure)
  co_kwonlyargcount number of keyword only arguments (not including ** arg)
  co_name

コードオブジェクトが定義されたときの名前

  co_names

ローカル変数名のタプル

  co_nlocals

ローカル変数の数

  co_stacksize

必要とされる仮想マシンのスタックスペース

  co_varnames

引数名とローカル変数名のタプル

ジェネレータ

__name__

名前

  __qualname__ qualified name
  gi_frame

フレーム

  gi_running

ジェネレータが実行中かどうか

  gi_code

コード

  gi_yieldfrom

yield from でイテレートされているオブジェクト、または None

coroutine __name__

名前

  __qualname__ qualified name
  cr_await

待機されているオブジェクト、または None

  cr_frame

フレーム

  cr_running

コルーチンが実行中かどうか

  cr_code

コード

組み込み

__doc__

ドキュメント文字列

  __name__

関数、メソッドの元々の名前

  __qualname__ qualified name
  __self__

メソッドが結合しているインスタンス、または None

バージョン 3.5 で変更: ジェネレータに __qualname__gi_yieldfrom 属性が追加されました。

ジェネレータの __name__ 属性がコード名ではなく関数名から設定されるようになり、変更できるようになりました。

inspect.getmembers(object[, predicate])

オブジェクトの全メンバーを、(名前, 値) の組み合わせのリストで返します。リストはメンバー名でソートされています。predicate が指定されている場合、predicate の戻り値が真となる値のみを返します。

注釈

引数がクラスで属性がメタクラスのカスタム __dir__() に列挙されている場合、getmembers() はメタクラスで定義されたクラス属性のみを返します。

inspect.getmodulename(path)

Return the name of the module named by the file path, without including the names of enclosing packages. The file extension is checked against all of the entries in importlib.machinery.all_suffixes(). If it matches, the final path component is returned with the extension removed. Otherwise, None is returned.

Note that this function only returns a meaningful name for actual Python modules - paths that potentially refer to Python packages will still return None.

バージョン 3.3 で変更: The function is based directly on importlib.

inspect.ismodule(object)

オブジェクトがモジュールの場合真を返します。

inspect.isclass(object)

オブジェクトが組み込みか Python が生成したクラスの場合に真を返します。

inspect.ismethod(object)

オブジェクトがメソッドの場合真を返します。

inspect.isfunction(object)

オブジェクトが Python 関数(lambda 式で生成されたものを含む) の場合に真を返します。

inspect.isgeneratorfunction(object)

object が Python のジェネレータ関数の場合真を返します。

inspect.isgenerator(object)

object がジェネレータの場合真を返します。

inspect.iscoroutinefunction(object)

オブジェクトが コルーチン関数 (async def シンタックスで定義された関数) の場合真を返します。

バージョン 3.5 で追加.

inspect.iscoroutine(object)

オブジェクトが async def で生成された コルーチン の場合真を返します。

バージョン 3.5 で追加.

inspect.isawaitable(object)

オブジェクトを await 式内で使用できる場合真を返します。

ジェネレータベースのコルーチンと通常のジェネレータを区別するのに使うこともできます。

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

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

バージョン 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

バージョン 3.6 で追加.

inspect.isasyncgen(object)

Return true if the object is an asynchronous generator iterator created by an asynchronous generator function.

バージョン 3.6 で追加.

inspect.istraceback(object)

オブジェクトがトレースバックの場合は真を返します。

inspect.isframe(object)

オブジェクトがフレームの場合は真を返します。

inspect.iscode(object)

オブジェクトがコードの場合は真を返します。

inspect.isbuiltin(object)

オブジェクトが組み込み関数か束縛済みの組み込みメソッドの場合に真を返します。

inspect.isroutine(object)

オブジェクトがユーザ定義か組み込みの関数またはメソッドの場合は真を返します。

inspect.isabstract(object)

object が抽象規定型 (ABC) であるときに真を返します。

inspect.ismethoddescriptor(object)

オブジェクトがメソッドデスクリプタであり、 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, but beyond that the set of attributes varies. A __name__ attribute is usually sensible, and __doc__ often is.

デスクリプタを使って実装されたメソッドで、上記のいずれかのテストもパスしているものは、 ismethoddescriptor() では偽を返します。これは単に他のテストの方がもっと確実だからです – 例えば、 ismethod() をパスしたオブジェクトは __func__ 属性などを持っていると期待できます。

inspect.isdatadescriptor(object)

オブジェクトがデータデスクリプタの場合に真を返します。

データデスクリプタは __get__ および __set__ 属性の両方を持ちます。データデスクリプタの例は (Python 上で定義された) プロパティや getset やメンバーです。後者のふたつは C で定義されており、個々の型に特有のテストも行います。そのため、Python の実装よりもより確実です。通常、データデスクリプタは __name____doc__ 属性を持ちます (プロパティ、 getset 、メンバーは両方の属性を持っています) が、保証されているわけではありません。

inspect.isgetsetdescriptor(object)

オブジェクトが getset デスクリプタの場合に真を返します。

CPython 実装の詳細: getset とは、拡張モジュールで PyGetSetDef 構造体を用いて定義された属性のことです。そのような型を持たない Python 実装の場合は、このメソッドは常に False を返します。

inspect.ismemberdescriptor(object)

オブジェクトがメンバーデスクリプタの場合に真を返します。

CPython 実装の詳細: メンバーデスクリプタとは、拡張モジュールで PyMemberDef 構造体を用いて定義された属性のことです。そのような型を持たない Python 実装の場合は、このメソッドは常に False を返します。

29.12.2. ソースコードの情報取得

inspect.getdoc(object)

Get the documentation string for an object, cleaned up with cleandoc(). If the documentation string for an object is not provided and the object is a class, a method, a property or a descriptor, retrieve the documentation string from the inheritance hierarchy.

バージョン 3.5 で変更: ドキュメンテーション文字列がオーバーライドされていない場合は継承されるようになりました。

inspect.getcomments(object)

Return in a single string any lines of comments immediately preceding the object’s source code (for a class, function, or method), or at the top of the Python source file (if the object is a module). If the object’s source code is unavailable, return None. This could happen if the object has been defined in C or the interactive shell.

inspect.getfile(object)

オブジェクトを定義している (テキストまたはバイナリの) ファイルの名前を返します。オブジェクトが組み込みモジュール、クラス、関数の場合は TypeError 例外が発生します。

inspect.getmodule(object)

オブジェクトを定義しているモジュールを推測します。

inspect.getsourcefile(object)

オブジェクトを定義している Python ソースファイルの名前を返します。オブジェクトが組み込みのモジュール、クラス、関数の場合には、 TypeError 例外が発生します。

inspect.getsourcelines(object)

オブジェクトのソース行のリストと開始行番号を返します。引数にはモジュール、クラス、メソッド、関数、トレースバック、フレーム、コードオブジェクトを指定することができます。戻り値は指定したオブジェクトに対応するソースコードのソース行リストと元のソースファイル上での開始行となります。ソースコードを取得できない場合は OSError が発生します。

バージョン 3.3 で変更: IOError の代わりに OSError を送出します。前者は後者のエイリアスです。

inspect.getsource(object)

オブジェクトのソースコードを返します。引数にはモジュール、クラス、メソッド、関数、トレースバック、フレーム、コードオブジェクトを指定することができます。ソースコードは単一の文字列で返します。ソースコードを取得できない場合は OSError が発生します。

バージョン 3.3 で変更: IOError の代わりに OSError を送出します。前者は後者のエイリアスです。

inspect.cleandoc(doc)

コードブロックと位置を合わせるためのインデントを docstring から削除します。

先頭行の行頭の空白文字は全て削除されます。 2行目以降では全行で同じ数の行頭の空白文字が、削除できるだけ削除されます。 その後、先頭と末尾の空白行が削除され、全てのタブが空白に展開されます。

29.12.3. Signature オブジェクトで呼び出し可能オブジェクトを内省する

バージョン 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)

与えられた callableSignature オブジェクトを返します:

>>> 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'>

Accepts a wide range of python callables, from plain functions and classes to functools.partial() objects.

Raises ValueError if no signature can be provided, and TypeError if that type of object is not supported.

バージョン 3.5 で追加: follow_wrapped parameter. Pass False to get a signature of callable specifically (callable.__wrapped__ will not be used to unwrap decorated callables.)

注釈

Some callables may not be introspectable in certain implementations of Python. For example, in CPython, some built-in functions defined in C provide no metadata about their arguments.

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.

The optional parameters argument is a sequence of Parameter objects, which is validated to check that there are no parameters with duplicate names, and that the parameters are in the right order, i.e. positional-only first, then positional-or-keyword, and that parameters with defaults follow parameters without defaults.

The optional return_annotation argument, can be an arbitrary Python object, is the “return” annotation of the callable.

Signature オブジェクトは イミュータブル です。変更されたコピーを作成するには Signature.replace() を使用してください。

バージョン 3.5 で変更: Signature オブジェクトがピックル並びにハッシュ可能になりました。

empty

return アノテーションがないことを指すクラスレベルの特殊マーカです。

parameters

仮引数名から対応する Parameter オブジェクトへの順序付きマッピングです。

return_annotation

呼び出し可能オブジェクトの “return” アノテーションです。呼び出し可能オブジェクトに “return” アノテーションがない場合、この属性は Signature.empty に設定されます。

bind(*args, **kwargs)

Create a mapping from positional and keyword arguments to parameters. Returns BoundArguments if *args and **kwargs match the signature, or raises a TypeError.

bind_partial(*args, **kwargs)

Works the same way as Signature.bind(), but allows the omission of some required arguments (mimics functools.partial() behavior.) Returns BoundArguments, or raises a TypeError if the passed arguments do not match the signature.

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'"
classmethod from_callable(obj, *, follow_wrapped=True)

Return a Signature (or its subclass) object for a given callable obj. Pass follow_wrapped=False to get a signature of obj without unwrapping its __wrapped__ chain.

このメソッドは Signature のサブクラス化を単純化します:

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

バージョン 3.5 で追加.

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

Parameter オブジェクトは イミュータブル です。変更されたコピーを作成するには Parameter.replace() を使用してください。

バージョン 3.5 で変更: Parameter オブジェクトがピックル並びにハッシュ可能になりました。

empty

デフォルト値とアノテーションがないことを指すクラスレベルの特殊マーカです。

name

仮引数名 (文字列) です。名前は有効な Python 識別子でなければなりません。

CPython 実装の詳細: CPython generates implicit parameter names of the form .0 on the code objects used to implement comprehensions and generator expressions.

バージョン 3.6 で変更: These parameter names are exposed by this module as names like implicit0.

default

引数のデフォルト値です。引数にデフォルト値がない場合、この属性は Parameter.empty に設定されます。

annotation

引数のアノテーションです。引数にアノテーションがない場合、この属性は Parameter.empty に設定されます。

kind

実引数値がどのように仮引数に束縛されるかを記述します。有効な値 (Parameter を通じてアクセスできます、たとえば Parameter.KEYWORD_ONLY) は:

名前

意味

POSITIONAL_ONLY

値を位置引数として渡さなければなりません。

Python には位置専用引数を定義する明示的なシンタックスはありませんが、組み込みおよび拡張モジュールの多くの関数 (特に1つか2つの引数を取るもの) は位置専用引数を取ります。

POSITIONAL_OR_KEYWORD

値をキーワードまたは位置引数として渡すことができます (これは Python で実装された関数の標準的な束縛動作です)。

VAR_POSITIONAL

その他の仮引数に束縛されていない位置引数のタプルです。Python の関数定義における *args 仮引数に対応します。

KEYWORD_ONLY

値をキーワード引数として渡さなければなりません。キーワード専用引数は Python の関数定義において **args の後に現れる引数です。

VAR_KEYWORD

その他の仮引数に束縛されていないキーワード引数の辞書です。Python の関数定義における **kwargs 仮引数に対応します。

例: デフォルト値のない全てのキーワード専用引数を出力します:

>>> 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
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'"

バージョン 3.4 で変更: Python 3.3 では、Parameter オブジェクトは kindPOSITIONAL_ONLY の場合 None に設定された name を持つことができました。 これはもう許可されません。

class inspect.BoundArguments

Result of a Signature.bind() or Signature.bind_partial() call. Holds the mapping of arguments to the function’s parameters.

arguments

An ordered, mutable mapping (collections.OrderedDict) of parameters’ names to arguments’ values. Contains only explicitly bound arguments. Changes in arguments will reflect in args and kwargs.

Should be used in conjunction with Signature.parameters for any argument processing purposes.

注釈

Arguments for which Signature.bind() or Signature.bind_partial() relied on a default value are skipped. However, if needed, use BoundArguments.apply_defaults() to add them.

args

位置引数の値のタプルです。arguments 属性から動的に計算されます。

kwargs

キーワード引数の値の辞書です。arguments 属性から動的に計算されます。

signature

親の Signature オブジェクトへの参照です。

apply_defaults()

存在しない引数のデフォルト値を設定します。

For variable-positional arguments (*args) the default is an empty tuple.

For variable-keyword arguments (**kwargs) the default is an empty dict.

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

バージョン 3.5 で追加.

args および kwargs 属性を使用して関数を呼び出すことができます:

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

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

参考

PEP 362 - Function Signature Object.
The detailed specification, implementation details and examples.

29.12.4. クラスと関数

inspect.getclasstree(classes, unique=False)

リストで指定したクラスの継承関係から、ネストしたリストを作成します。ネストしたリストには、直前の要素から派生したクラスが格納されます。各要素は長さ2のタプルで、クラスと基底クラスのタプルを格納しています。unique が真の場合、各クラスは戻り値のリスト内に一つだけしか格納されません。真でなければ、多重継承を利用したクラスとその派生クラスは複数回格納される場合があります。

inspect.getargspec(func)

Get the names and default values of a Python function’s parameters. A named tuple ArgSpec(args, varargs, keywords, defaults) is returned. args is a list of the parameter names. varargs and keywords are the names of the * and ** parameters or None. defaults is a tuple of default argument values or None if there are no default arguments; if this tuple has n elements, they correspond to the last n elements listed in args.

バージョン 3.0 で撤廃: Use getfullargspec() for an updated API that is usually a drop-in replacement, but also correctly handles function annotations and keyword-only parameters.

Alternatively, use signature() and Signature Object, which provide a more structured introspection API for callables.

inspect.getfullargspec(func)

Get the names and default values of a Python function’s parameters. A named tuple is returned:

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

args is a list of the positional parameter names. varargs is the name of the * parameter or None if arbitrary positional arguments are not accepted. varkw is the name of the ** parameter or None if arbitrary keyword arguments are not accepted. defaults is an n-tuple of default argument values corresponding to the last n positional parameters, or None if there are no such defaults defined. kwonlyargs is a list of keyword-only parameter names. kwonlydefaults is a dictionary mapping parameter names from kwonlyargs to the default values used if no argument is supplied. annotations is a dictionary mapping parameter names to annotations. The special key "return" is used to report the function return value annotation (if any).

Note that signature() and Signature Object provide the recommended API for callable introspection, and support additional behaviours (like positional-only arguments) that are sometimes encountered in extension module APIs. This function is retained primarily for use in code that needs to maintain compatibility with the Python 2 inspect module API.

バージョン 3.4 で変更: This function is now based on signature(), but still ignores __wrapped__ attributes and includes the already bound first parameter in the signature output for bound methods.

バージョン 3.6 で変更: This method was previously documented as deprecated in favour of signature() in Python 3.5, but that decision has been reversed in order to restore a clearly supported standard interface for single-source Python 2/3 code migrating away from the legacy getargspec() API.

inspect.getargvalues(frame)

Get information about arguments passed into a particular frame. A named tuple ArgInfo(args, varargs, keywords, locals) is returned. args is a list of the argument names. varargs and keywords are the names of the * and ** arguments or None. locals is the locals dictionary of the given frame.

注釈

This function was inadvertently marked as deprecated in Python 3.5.

inspect.formatargspec(args[, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, annotations[, formatarg, formatvarargs, formatvarkw, formatvalue, formatreturns, formatannotations]])

Format a pretty argument spec from the values returned by getfullargspec().

The first seven arguments are (args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, annotations).

The other six arguments are functions that are called to turn argument names, * argument name, ** argument name, default values, return annotation and individual annotations into strings, respectively.

例えば:

>>> from inspect import formatargspec, getfullargspec
>>> def f(a: int, b: float):
...     pass
...
>>> formatargspec(*getfullargspec(f))
'(a: int, b: float)'

バージョン 3.5 で撤廃: Use signature() and Signature Object, which provide a better introspecting API for callables.

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

getargvalues() で取得した4つの値を読みやすく整形します。 format* 引数はオプションで、名前と値を文字列に変換する整形関数を指定することができます。

注釈

This function was inadvertently marked as deprecated in Python 3.5.

inspect.getmro(cls)

cls クラスの基底クラス (cls 自身も含む) を、メソッドの優先順位順に並べたタプルを返します。結果のリスト内で各クラスは一度だけ格納されます。メソッドの優先順位はクラスの型によって異なります。非常に特殊なユーザ定義のメタクラスを使用していない限り、cls が戻り値の先頭要素となります。

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

argskwds を、Python の関数もしくはメソッド func を呼び出した場合と同じように引数名に束縛します。束縛済みメソッド(bound method)の場合、最初の引数(慣習的に self という名前が付けられます)にも、関連づけられたインスタンスを束縛します。引数名 (*** 引数が存在すればその名前も) に argskwds からの値をマップした辞書を返します。func を正しく呼び出せない場合、つまり func(*args, **kwds) がシグネチャの不一致のために例外を投げるような場合には、それと同じ型で同じか似ているメッセージの例外を発生させます。例:

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

バージョン 3.2 で追加.

バージョン 3.5 で撤廃: Use Signature.bind() and Signature.bind_partial() instead.

inspect.getclosurevars(func)

Get the mapping of external name references in a Python function or method func to their current values. A named tuple ClosureVars(nonlocals, globals, builtins, unbound) is returned. nonlocals maps referenced names to lexical closure variables, globals to the function’s module globals and builtins to the builtins visible from the function body. unbound is the set of names referenced in the function that could not be resolved at all given the current module globals and builtins.

func が Python の関数やメソッドでない場合 TypeError が送出されます。

バージョン 3.3 で追加.

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

Get the object wrapped by func. It follows the chain of __wrapped__ attributes returning the last object in the chain.

stop is an optional callback accepting an object in the wrapper chain as its sole argument that allows the unwrapping to be terminated early if the callback returns a true value. If the callback never returns a true value, the last object in the chain is returned as usual. For example, signature() uses this to stop unwrapping if any object in the chain has a __signature__ attribute defined.

ValueError is raised if a cycle is encountered.

バージョン 3.4 で追加.

29.12.5. インタープリタスタック

When the following functions return “frame records,” each record is a named tuple FrameInfo(frame, filename, lineno, function, code_context, index). The tuple contains the frame object, the filename, the line number of the current line, the function name, a list of lines of context from the source code, and the index of the current line within that list.

バージョン 3.5 で変更: タプルではなく名前付きタプルを返します。

注釈

フレームレコードの最初の要素などのフレームオブジェクトへの参照を保存すると、循環参照になってしまう場合があります。循環参照ができると、Python の循環参照検出機能を有効にしていたとしても関連するオブジェクトが参照しているすべてのオブジェクトが解放されにくくなり、明示的に参照を削除しないとメモリ消費量が増大する恐れがあります。

参照の削除を Python の循環参照検出機能にまかせることもできますが、 finally 節で循環参照を解除すれば確実にフレーム (とそのローカル変数) は削除されます。また、循環参照検出機能は Python のコンパイルオプションや gc.disable() で無効とされている場合がありますので注意が必要です。例:

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

If you want to keep the frame around (for example to print a traceback later), you can also break reference cycles by using the frame.clear() method.

以下の関数でオプション引数 context には、戻り値のソース行リストに何行分のソースを含めるかを指定します。ソース行リストには、実行中の行を中心として指定された行数分のリストを返します。

inspect.getframeinfo(frame, context=1)

フレームまたはトレースバックオブジェクトの情報を取得します。 名前付きタプル Traceback(filename, lineno, function, code_context, index) が返されます。

inspect.getouterframes(frame, context=1)

指定したフレームと、その外側の全フレームのフレームレコードを返します。外側のフレームとは frame が生成されるまでのすべての関数呼び出しを示します。戻り値のリストの先頭は frame のフレームレコードで、末尾の要素は frame のスタックにある最も外側のフレームのフレームレコードとなります。

バージョン 3.5 で変更: A list of named tuples FrameInfo(frame, filename, lineno, function, code_context, index) is returned.

inspect.getinnerframes(traceback, context=1)

指定したフレームと、その内側の全フレームのフレームレコードを返します。内のフレームとは frame から続く一連の関数呼び出しを示します。戻り値のリストの先頭は traceback のフレームレコードで、末尾の要素は例外が発生した位置を示します。

バージョン 3.5 で変更: A list of named tuples FrameInfo(frame, filename, lineno, function, code_context, index) is returned.

inspect.currentframe()

呼び出し元のフレームオブジェクトを返します。

CPython 実装の詳細: この関数はインタプリタの Python スタックフレームサポートに依存します。これは Python のすべての実装に存在している保証はありません。Python スタックフレームサポートのない環境では、この関数は None を返します。

inspect.stack(context=1)

呼び出し元スタックのフレームレコードのリストを返します。最初の要素は呼び出し元のフレームレコードで、末尾の要素はスタックにある最も外側のフレームのフレームレコードとなります。

バージョン 3.5 で変更: A list of named tuples FrameInfo(frame, filename, lineno, function, code_context, index) is returned.

inspect.trace(context=1)

実行中のフレームと処理中の例外が発生したフレームの間のフレームレコードのリストを返します。最初の要素は呼び出し元のフレームレコードで、末尾の要素は例外が発生した位置を示します。

バージョン 3.5 で変更: A list of named tuples FrameInfo(frame, filename, lineno, function, code_context, index) is returned.

29.12.6. 属性の静的なフェッチ

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.

For cases where you want passive introspection, like documentation tools, this can be inconvenient. getattr_static() has the same signature as getattr() but avoids executing code when it fetches attributes.

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

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

Note: this function may not be able to retrieve all attributes that getattr can fetch (like dynamically created attributes) and may find attributes that getattr can’t (like descriptors that raise AttributeError). It can also return descriptors objects instead of instance members.

If the instance __dict__ is shadowed by another member (for example a property) then this function will be unable to find instance members.

バージョン 3.2 で追加.

getattr_static() does not resolve descriptors, for example slot descriptors or getset descriptors on objects implemented in C. The descriptor object is returned instead of the underlying attribute.

You can handle these with code like the following. Note that for arbitrary getset descriptors invoking these may trigger code execution:

# 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

29.12.7. ジェネレータおよびコルーチンの現在の状態

When implementing coroutine schedulers and for other advanced uses of generators, it is useful to determine whether a generator is currently executing, is waiting to start or resume or execution, or has already terminated. getgeneratorstate() allows the current state of a generator to be determined easily.

inspect.getgeneratorstate(generator)

ジェネレータイテレータの現在の状態を取得します。

取り得る状態は:
  • GEN_CREATED: 実行開始を待機しています。

  • GEN_RUNNING: インタープリタによって現在実行されています。

  • GEN_SUSPENDED: yield 式で現在サスペンドされています。

  • GEN_CLOSED: 実行が完了しました。

バージョン 3.2 で追加.

inspect.getcoroutinestate(coroutine)

Get current state of a coroutine object. The function is intended to be used with coroutine objects created by async def functions, but will accept any coroutine-like object that has cr_running and cr_frame attributes.

取り得る状態は:
  • CORO_CREATED: 実行開始を待機しています。

  • CORO_RUNNING: インタープリタにより現在実行中です。

  • CORO_SUSPENDED: await 式により現在停止中です。

  • CORO_CLOSED: 実行が完了しました。

バージョン 3.5 で追加.

ジェネレータの現在の内部状態を問い合わせることも出来ます。これは主に内部状態が期待通り更新されているかどうかを確認するためのテストの目的に有用です。

inspect.getgeneratorlocals(generator)

Get the mapping of live local variables in generator to their current values. A dictionary is returned that maps from variable names to values. This is the equivalent of calling locals() in the body of the generator, and all the same caveats apply.

If generator is a generator with no currently associated frame, then an empty dictionary is returned. TypeError is raised if generator is not a Python generator object.

CPython 実装の詳細: This function relies on the generator exposing a Python stack frame for introspection, which isn’t guaranteed to be the case in all implementations of Python. In such cases, this function will always return an empty dictionary.

バージョン 3.3 で追加.

inspect.getcoroutinelocals(coroutine)

This function is analogous to getgeneratorlocals(), but works for coroutine objects created by async def functions.

バージョン 3.5 で追加.

29.12.8. Code Objects Bit Flags

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

inspect.CO_OPTIMIZED

The code object is optimized, using fast locals.

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

The code object has a variable positional parameter (*args-like).

inspect.CO_VARKEYWORDS

The code object has a variable keyword parameter (**kwargs-like).

inspect.CO_NESTED

The flag is set when the code object is a nested function.

inspect.CO_GENERATOR

The flag is set when the code object is a generator function, i.e. a generator object is returned when the code object is executed.

inspect.CO_NOFREE

The flag is set if there are no free or cell variables.

inspect.CO_COROUTINE

The flag is set when the code object is a coroutine function. When the code object is executed it returns a coroutine object. See PEP 492 for more details.

バージョン 3.5 で追加.

inspect.CO_ITERABLE_COROUTINE

The flag is used to transform generators into generator-based coroutines. Generator objects with this flag can be used in await expression, and can yield from coroutine objects. See PEP 492 for more details.

バージョン 3.5 で追加.

inspect.CO_ASYNC_GENERATOR

The flag is set when the code object is an asynchronous generator function. When the code object is executed it returns an asynchronous generator object. See PEP 525 for more details.

バージョン 3.6 で追加.

注釈

The flags are specific to CPython, and may not be defined in other Python implementations. Furthermore, the flags are an implementation detail, and can be removed or deprecated in future Python releases. It’s recommended to use public APIs from the inspect module for any introspection needs.

29.12.9. コマンドラインインターフェイス

The inspect module also provides a basic introspection capability from the command line.

By default, accepts the name of a module and prints the source of that module. A class or function within the module can be printed instead by appended a colon and the qualified name of the target object.

--details

Print information about the specified object rather than the source code