inspect
--- 活動中のオブジェクトを調査する¶
ソースコード: Lib/inspect.py
inspect
は、活動中のオブジェクト (モジュール、クラス、メソッド、関数、トレースバック、フレームオブジェクト、コードオブジェクトなど) から情報を取得する関数を定義しており、クラスの内容を調べたり、メソッドのソースコードを取得したり、関数の引数リストを取り出して整形したり、詳細なトレースバックを表示するのに必要な情報を取得したりするために利用できます。
このモジュールの機能は4種類に分類することができます。型チェック、ソースコードの情報取得、クラスや関数からの情報取得、インタープリタのスタック情報の調査です。
型とメンバー¶
getmembers()
は、クラスやモジュールなどのオブジェクトからメンバーを取得します。名前が "is" で始まる関数は、主に getmembers()
の第2引数として利用するために提供されています。以下のような特殊属性を参照できるかどうか調べる時にも使えるでしょう (モジュール属性については Import-related attributes on module objects を参照してください):
型 |
属性 |
説明 |
---|---|---|
クラス |
__doc__ |
ドキュメント文字列 |
__name__ |
クラスの定義名 |
|
__qualname__ |
qualified name |
|
__module__ |
クラスを定義しているモジュールの名前 |
|
__type_params__ |
A tuple containing the type parameters of a generic class |
|
メソッド |
__doc__ |
ドキュメント文字列 |
__name__ |
メソッドの定義名 |
|
__qualname__ |
qualified name |
|
__func__ |
メソッドを実装している関数オブジェクト |
|
__self__ |
メソッドに結合しているインスタンス、または |
|
__module__ |
name of module in which this method was defined |
|
関数 |
__doc__ |
ドキュメント文字列 |
__name__ |
関数の定義名 |
|
__qualname__ |
qualified name |
|
__code__ |
関数をコンパイルした バイトコード を格納するコードオブジェクト |
|
__defaults__ |
位置またはキーワード引数の全ての既定値のタプル |
|
__kwdefaults__ |
キーワード専用引数の全ての既定値のマッピング |
|
__globals__ |
関数が定義されたグローバル名前空間 |
|
__builtins__ |
builtins namespace |
|
__annotations__ |
仮引数名からアノテーションへのマッピング; |
|
__type_params__ |
A tuple containing the type parameters of a generic function |
|
__module__ |
name of module in which this function was defined |
|
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_trace |
このフレームのトレース関数、または |
|
コード |
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_lnotab |
行番号からバイトコードインデックスへの変換表を文字列にエンコードしたもの |
|
co_freevars |
tuple of names of free variables (referenced via a function's closure) |
|
co_posonlyargcount |
number of positional only arguments |
|
co_kwonlyargcount |
number of keyword only arguments (not including ** arg) |
|
co_name |
コードオブジェクトが定義されたときの名前 |
|
co_qualname |
fully qualified name with which this code object was defined |
|
co_names |
tuple of names other than arguments and function locals |
|
co_nlocals |
ローカル変数の数 |
|
co_stacksize |
必要とされる仮想マシンのスタックスペース |
|
co_varnames |
引数名とローカル変数名のタプル |
|
ジェネレータ |
__name__ |
name |
__qualname__ |
qualified name |
|
gi_frame |
フレーム |
|
gi_running |
ジェネレータが実行中かどうか |
|
gi_code |
コード |
|
gi_yieldfrom |
|
|
async generator |
__name__ |
name |
__qualname__ |
qualified name |
|
ag_await |
待機されているオブジェクト、または |
|
ag_frame |
フレーム |
|
ag_running |
ジェネレータが実行中かどうか |
|
ag_code |
コード |
|
コルーチン |
__name__ |
name |
__qualname__ |
qualified name |
|
cr_await |
待機されているオブジェクト、または |
|
cr_frame |
フレーム |
|
cr_running |
コルーチンが実行中かどうか |
|
cr_code |
コード |
|
cr_origin |
where coroutine was
created, or |
|
組み込み |
__doc__ |
ドキュメント文字列 |
__name__ |
関数、メソッドの元々の名前 |
|
__qualname__ |
qualified name |
|
__self__ |
メソッドが結合しているインスタンス、または |
バージョン 3.5 で変更: ジェネレータに __qualname__
と gi_yieldfrom
属性が追加されました。
ジェネレータの __name__
属性がコード名ではなく関数名から設定されるようになり、変更できるようになりました。
バージョン 3.7 で変更: Add cr_origin
attribute to coroutines.
バージョン 3.10 で変更: Add __builtins__
attribute to functions.
- inspect.getmembers(object[, predicate])¶
Return all the members of an object in a list of
(name, value)
pairs sorted by name. If the optional predicate argument—which will be called with thevalue
object of each member—is supplied, only members for which the predicate returns a true value are included.注釈
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)¶
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)¶
オブジェクトがモジュールの場合
True
を返します。
- inspect.isclass(object)¶
オブジェクトが組み込みか Python が生成したクラスの場合に
True
を返します。
- inspect.ismethod(object)¶
オブジェクトがメソッドの場合
True
を返します。
- inspect.isgeneratorfunction(object)¶
オブジェクトが Python のジェネレータ関数の場合
True
を返します。バージョン 3.8 で変更: Functions wrapped in
functools.partial()
now returnTrue
if the wrapped function is a Python generator function.バージョン 3.13 で変更: Functions wrapped in
functools.partialmethod()
now returnTrue
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 anasync def
syntax), afunctools.partial()
wrapping a coroutine function, or a sync function marked withmarkcoroutinefunction()
.Added in version 3.5.
バージョン 3.8 で変更: Functions wrapped in
functools.partial()
now returnTrue
if the wrapped function is a coroutine function.バージョン 3.12 で変更: Sync functions marked with
markcoroutinefunction()
now returnTrue
.バージョン 3.13 で変更: Functions wrapped in
functools.partialmethod()
now returnTrue
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 withiscoroutine()
.Added in version 3.12.
- inspect.isawaitable(object)¶
オブジェクトを
await
式内で使用できる場合True
を返します。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 returnTrue
if the wrapped function is an asynchronous generator function.バージョン 3.13 で変更: Functions wrapped in
functools.partialmethod()
now returnTrue
if the wrapped function is a coroutine function.
- inspect.isasyncgen(object)¶
オブジェクトが asynchronous generator 関数によって生成された asynchronous generator iterator である場合に
True
を返します。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 aMethodWrapperType
.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)¶
オブジェクトがメソッドデスクリプタであり、
ismethod()
,isclass()
,isfunction()
,isbuiltin()
でない場合にTrue
を返します。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 theismethoddescriptor()
test, simply because the other tests promise more -- you can, e.g., count on having the__func__
attribute (etc) when an object passesismethod()
.バージョン 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)¶
オブジェクトが getset デスクリプタの場合に
True
を返します。CPython 実装の詳細: getset とは、拡張モジュールで
PyGetSetDef
構造体を用いて定義された属性のことです。そのような型を持たない Python 実装の場合は、このメソッドは常にFalse
を返します。
- inspect.ismemberdescriptor(object)¶
オブジェクトがメンバーデスクリプタの場合に
True
を返します。CPython 実装の詳細: メンバーデスクリプタとは、拡張モジュールで
PyMemberDef
構造体を用いて定義された属性のことです。そのような型を持たない Python 実装の場合は、このメソッドは常にFalse
を返します。
ソースコードの情報取得¶
- 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. ReturnNone
if the documentation string is invalid or missing.バージョン 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)¶
Try to guess which module an object was defined in. Return
None
if the module cannot be determined.
- inspect.getsourcefile(object)¶
Return the name of the Python source file in which an object was defined or
None
if no way can be identified to get the source. This will fail with aTypeError
if the object is a built-in module, class, or function.
- 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. ATypeError
is raised if the object is a built-in module, class, or function.
- 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. ATypeError
is raised if the object is a built-in module, class, or function.
- inspect.cleandoc(doc)¶
コードブロックと位置を合わせるためのインデントを docstring から削除します。
先頭行の行頭の空白文字は全て削除されます。 2行目以降では全行で同じ数の行頭の空白文字が、削除できるだけ削除されます。 その後、先頭と末尾の空白行が削除され、全てのタブが空白に展開されます。
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)¶
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'>
単純な関数やクラスから、
functools.partial()
オブジェクトまで、幅広い Python の呼び出し可能なオブジェクトを受け付けます。For objects defined in modules using stringized annotations (
from __future__ import annotations
),signature()
will attempt to automatically un-stringize the annotations usingget_annotations()
. The globals, locals, and eval_str parameters are passed intoget_annotations()
when resolving the annotations; see the documentation forget_annotations()
for instructions on how to use these parameters.Raises
ValueError
if no signature can be provided, andTypeError
if that type of object is not supported. Also, if the annotations are stringized, and eval_str is not false, theeval()
call(s) to un-stringize the annotations inget_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.
注釈
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.
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 aParameter
object in itsparameters
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. It represents the "return" annotation of the callable.
Signature
objects are immutable. UseSignature.replace()
orcopy.replace()
to make a modified copy.バージョン 3.5 で変更:
Signature
objects are now picklable and hashable.- empty¶
return アノテーションがないことを指すクラスレベルの特殊マーカです。
- parameters¶
An ordered mapping of parameters' names to the corresponding
Parameter
objects. Parameters appear in strict definition order, including keyword-only parameters.バージョン 3.7 で変更: Python only explicitly guaranteed that it preserved the declaration order of keyword-only parameters as of version 3.7, although in practice this order had always been preserved in Python 3.
- 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 aTypeError
.
- bind_partial(*args, **kwargs)¶
Works the same way as
Signature.bind()
, but allows the omission of some required arguments (mimicsfunctools.partial()
behavior.) ReturnsBoundArguments
, or raises aTypeError
if the passed arguments do not match the signature.
- replace(*[, parameters][, return_annotation])¶
Create a new
Signature
instance based on the instancereplace()
was invoked on. It is possible to pass different parameters and/or return_annotation to override the corresponding properties of the base signature. To removereturn_annotation
from the copiedSignature
, pass inSignature.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 functioncopy.replace()
.
- format(*, max_width=None)¶
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.
Added in version 3.13.
- 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 aParameter
object, you can useParameter.replace()
orcopy.replace()
to create a modified copy.バージョン 3.5 で変更: Parameter objects are now picklable and hashable.
- 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 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
(likeParameter.KEYWORD_ONLY
), and support comparison and ordering, in the following order:名前
意味
POSITIONAL_ONLY
Value must be supplied as a positional argument. Positional only parameters are those which appear before a
/
entry (if present) in a Python function definition.POSITIONAL_OR_KEYWORD
値をキーワードまたは位置引数として渡すことができます (これは Python で実装された関数の標準的な束縛動作です)。
VAR_POSITIONAL
その他の仮引数に束縛されていない位置引数のタプルです。Python の関数定義における
*args
仮引数に対応します。KEYWORD_ONLY
値をキーワード引数として渡さなければなりません。キーワード専用引数は Python の関数定義において
*
や*args
の後に現れる引数です。VAR_KEYWORD
その他の仮引数に束縛されていないキーワード引数の辞書です。Python の関数定義における
**kwargs
仮引数に対応します。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 aParameter
attribute, pass the corresponding argument. To remove a default value or/and an annotation from aParameter
, passParameter.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 functioncopy.replace()
.
バージョン 3.4 で変更: In Python 3.3
Parameter
objects were allowed to havename
set toNone
if theirkind
was set toPOSITIONAL_ONLY
. This is no longer permitted.
- class inspect.BoundArguments¶
Result of a
Signature.bind()
orSignature.bind_partial()
call. Holds the mapping of arguments to the function's parameters.- arguments¶
A mutable mapping of parameters' names to arguments' values. Contains only explicitly bound arguments. Changes in
arguments
will reflect inargs
andkwargs
.Should be used in conjunction with
Signature.parameters
for any argument processing purposes.注釈
Arguments for which
Signature.bind()
orSignature.bind_partial()
relied on a default value are skipped. However, if needed, useBoundArguments.apply_defaults()
to add them.バージョン 3.9 で変更:
arguments
is now of typedict
. Formerly, it was of typecollections.OrderedDict
.
- kwargs¶
A dict of keyword arguments values. Dynamically computed from the
arguments
attribute. Arguments that can be passed positionally are included inargs
instead.
- 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 {'a': 'spam', 'b': 'ham', 'args': ()}
Added in version 3.5.
The
args
andkwargs
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: - 関数シグニチャオブジェクト
The detailed specification, implementation details and examples.
クラスと関数¶
- inspect.getclasstree(classes, unique=False)¶
リストで指定したクラスの継承関係から、ネストしたリストを作成します。ネストしたリストには、直前の要素から派生したクラスが格納されます。各要素は長さ2のタプルで、クラスと基底クラスのタプルを格納しています。unique が真の場合、各クラスは戻り値のリスト内に一つだけしか格納されません。真でなければ、多重継承を利用したクラスとその派生クラスは複数回格納される場合があります。
- 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 orNone
if arbitrary positional arguments are not accepted. varkw is the name of the**
parameter orNone
if arbitrary keyword arguments are not accepted. defaults is an n-tuple of default argument values corresponding to the last n positional parameters, orNone
if there are no such defaults defined. kwonlyargs is a list of keyword-only parameter names in declaration order. 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 2inspect
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 legacygetargspec()
API.バージョン 3.7 で変更: Python only explicitly guaranteed that it preserved the declaration order of keyword-only parameters as of version 3.7, although in practice this order had always been preserved in Python 3.
- inspect.getargvalues(frame)¶
指定したフレームに渡された引数の情報を取得します。戻り値は 名前付きタプル
ArgInfo(args, varargs, keywords, locals)
です。args は引数名のリストです。 varargs と keywords は*
引数と**
引数の名前で、引数がなければNone
となります。 locals は指定したフレームのローカル変数の辞書です。注釈
This function was inadvertently marked as deprecated in Python 3.5.
- 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)¶
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. wheneverfunc(*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 で非推奨: Use
Signature.bind()
andSignature.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
が送出されます。Added in version 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.Added in version 3.4.
- inspect.get_annotations(obj, *, globals=None, locals=None, eval_str=False)¶
Compute the annotations dict for an object.
obj
may be a callable, class, or module. Passing in an object of any other type raisesTypeError
.Returns a dict.
get_annotations()
returns a new dict every time it's called; calling it twice on the same object will return two different but equivalent dicts.This function handles several details for you:
If
eval_str
is true, values of typestr
will be un-stringized usingeval()
. This is intended for use with stringized annotations (from __future__ import annotations
).If
obj
doesn't have an annotations dict, returns an empty dict. (Functions and methods always have an annotations dict; classes, modules, and other types of callables may not.)Ignores inherited annotations on classes. If a class doesn't have its own annotations dict, returns an empty dict.
All accesses to object members and dict values are done using
getattr()
anddict.get()
for safety.Always, always, always returns a freshly created dict.
eval_str
controls whether or not values of typestr
are replaced with the result of callingeval()
on those values:If eval_str is true,
eval()
is called on values of typestr
. (Note thatget_annotations
doesn't catch exceptions; ifeval()
raises an exception, it will unwind the stack past theget_annotations
call.)If eval_str is false (the default), values of type
str
are unchanged.
globals
andlocals
are passed in toeval()
; see the documentation foreval()
for more information. Ifglobals
orlocals
isNone
, this function may replace that value with a context-specific default, contingent ontype(obj)
:If
obj
is a module,globals
defaults toobj.__dict__
.If
obj
is a class,globals
defaults tosys.modules[obj.__module__].__dict__
andlocals
defaults to theobj
class namespace.If
obj
is a callable,globals
defaults toobj.__globals__
, although ifobj
is a wrapped function (usingfunctools.update_wrapper()
) it is first unwrapped.
Calling
get_annotations
is best practice for accessing the annotations dict of any object. See Annotations Best Practices for more information on annotations best practices.Added in version 3.10.
インタープリタスタック¶
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 の循環参照検出機能を有効にしていたとしても関連するオブジェクトが参照しているすべてのオブジェクトが解放されにくくなり、明示的に参照を削除しないとメモリ消費量が増大する恐れがあります。
参照の削除を 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)¶
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)¶
指定したフレームと、その外側の全フレームの
FrameInfo
オブジェクトのリストを取得します。外側のフレームとは frame が生成されるまでのすべての関数呼び出しを示します。戻り値のリストの先頭は frame のフレームレコードで、末尾の要素は frame のスタックにある最も外側のフレームのフレームレコードとなります。バージョン 3.5 で変更: 名前付きタプル
FrameInfo(frame, filename, lineno, function, code_context, index)
のリストが返されます。バージョン 3.11 で変更: A list of
FrameInfo
objects is returned.
- inspect.getinnerframes(traceback, context=1)¶
トレースバックのフレームと、その内側の全フレームの
FrameInfo
オブジェクトのリストを取得します。内のフレームとは frame から続く一連の関数呼び出しを示します。戻り値のリストの先頭は traceback のフレームレコードで、末尾の要素は例外が発生した位置を示します。バージョン 3.5 で変更: 名前付きタプル
FrameInfo(frame, filename, lineno, function, code_context, index)
のリストが返されます。バージョン 3.11 で変更: A list of
FrameInfo
objects is returned.
- inspect.currentframe()¶
呼び出し元のフレームオブジェクトを返します。
CPython 実装の詳細: この関数はインタプリタの Python スタックフレームサポートに依存します。これは Python のすべての実装に存在している保証はありません。Python スタックフレームサポートのない環境では、この関数は
None
を返します。
属性の静的なフェッチ¶
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.Added in version 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
Current State of Generators, Coroutines, and Asynchronous Generators¶
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: 実行が完了しました。
Added in version 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 hascr_running
andcr_frame
attributes.取り得る状態は:
CORO_CREATED: 実行開始を待機しています。
CORO_RUNNING: インタープリタにより現在実行中です。
CORO_SUSPENDED: await 式により現在停止中です。
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 theyield
statement, but will accept any asynchronous generator-like object that hasag_running
andag_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)¶
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.
Added in version 3.3.
- inspect.getcoroutinelocals(coroutine)¶
This function is analogous to
getgeneratorlocals()
, but works for coroutine objects created byasync def
functions.Added in version 3.5.
- inspect.getasyncgenlocals(agen)¶
This function is analogous to
getgeneratorlocals()
, but works for asynchronous generator objects created byasync def
functions which use theyield
statement.Added in version 3.12.
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_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.
Added in version 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 canyield from
coroutine objects. See PEP 492 for more details.Added in version 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.
Added in version 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.
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.
コマンドラインインターフェイス¶
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