inspect

インスペクト（標準ライブラリ）

意味コードの内部情報取得

inspectとは？

inspectモジュールは、Pythonのコードの内部構造を調べるための便利なツール群を提供します。関数やクラスの定義内容、引数の型などを確認するのに役立ちます。

inspectの具体的な使い方

関数とクラスの情報取得

import inspect

class MyClass:
    """これは例示用のクラスです。"""
    
    def __init__(self, x):
        self.x = x
    
    def my_method(self, y):
        """これは例示用のメソッドです。"""
        return self.x + y

def my_function(a: int, b: str = "default") -> str:
    """これは例示用の関数です。"""
    return f"{a}: {b}"

# クラスの情報取得
print("=== クラスの情報 ===")
print(f"クラスのドキュメント: {MyClass.__doc__}")
print(f"クラスのメソッド: {[name for name, _ in inspect.getmembers(MyClass, inspect.isfunction)]}")

# 関数の情報取得
print("\n=== 関数の情報 ===")
print(f"関数のドキュメント: {my_function.__doc__}")
print(f"関数の引数: {inspect.signature(my_function)}")
print(f"関数のソースコード:\n{inspect.getsource(my_function)}")

# メソッドの情報取得
print("\n=== メソッドの情報 ===")
print(f"メソッドのドキュメント: {MyClass.my_method.__doc__}")
print(f"メソッドの引数: {inspect.signature(MyClass.my_method)}")
print(f"メソッドのソースコード:\n{inspect.getsource(MyClass.my_method)}")

👇出力結果

=== クラスの情報 ===
クラスのドキュメント: これは例示用のクラスです。
クラスのメソッド: ['__init__', 'my_method']

=== 関数の情報 ===
関数のドキュメント: これは例示用の関数です。
関数の引数: (a: int, b: str = 'default') -> str
関数のソースコード:
def my_function(a: int, b: str = "default") -> str:
    """これは例示用の関数です。"""
    return f"{a}: {b}"

=== メソッドの情報 ===
メソッドのドキュメント: これは例示用のメソッドです。
メソッドの引数: (self, y)
メソッドのソースコード:
    def my_method(self, y):
        """これは例示用のメソッドです。"""
        return self.x + y

このコードでは、inspectモジュールを使用して、クラス、関数、メソッドの様々な情報を取得しています。具体的には以下の情報を取得しています： 1. クラスのドキュメント文字列とメソッド一覧 2. 関数のドキュメント文字列、引数情報、ソースコード 3. メソッドのドキュメント文字列、引数情報、ソースコードこれらの情報は、コードの解析やドキュメント生成、デバッグなどに非常に役立ちます。

inspectに関するよくある質問

Q. inspectの主な用途は？

A. inspectモジュールの主な用途は、Pythonオブジェクトの内部情報を取得することです。関数やクラスのソースコード、引数の情報、ドキュメント文字列の取得、オブジェクトの型の確認などができます。これはデバッグやメタプログラミングに非常に役立ちます。

Q. 関数の引数情報を取得するには？

A. 関数の引数情報を取得するには、inspect.signature()を使用します。これにより、引数名、デフォルト値、アノテーションなどの情報を含むSignatureオブジェクトが得られます。例えば、inspect.signature(func).parameters で各引数の詳細情報にアクセスできます。

Q. inspectでクラス情報を取得できる？

A. はい、inspectモジュールを使ってクラスの情報も取得できます。例えば、inspect.getmembers()を使ってクラスのメソッドや属性を取得したり、inspect.getsource()でクラス全体のソースコードを取得したりできます。これはクラスの構造を動的に分析する際に非常に便利です。

inspectが学べる書籍の紹介

「プログラミング単語帳」を使って、プログラミングの単語を英単語のように学習してみませんか？
プログラミング単語帳には、Pythonのinspectやthreading.Semaphore、multiprocessing.Queue、collections、などのような実務でよく使われる単語が数百以上収録されています。
この書籍には、プログラミングの単語の意味や読み方、単語の使い方がわかる例文などが掲載されており、いつでもどこでもプログラミングの学習ができます。

よく使われる単語にだけ絞って学習することができるので、効率的にプログラミングが学習できます。