Pythonオブジェクトの内部を見る方法

Pythonは、その柔軟性と使いやすさから多くのプログラマーに愛されています。この言語を使っていると、オブジェクトの内部構造を詳しく調べたいと思うことがあるでしょう。本記事では、Pythonオブジェクトの内部を観察するための方法をいくつか紹介します。

Pythonオブジェクトの内部を調べる理由

オブジェクトの内部を調べることは、デバッグやコードの最適化、または単純に学習のために非常に役立ちます。オブジェクトの属性やメソッドを知ることで、コードの挙動を理解しやすくなります。

dir()関数を使ったオブジェクトの調査

dir()関数は、オブジェクトの属性とメソッドのリストを返します。これは、オブジェクトの構造を把握するための最初のステップとして非常に便利です。

class Sample:
    def __init__(self):
        self.value = 42

    def method(self):
        return "Hello"

obj = Sample()
print(dir(obj))

上記のコードを実行すると、以下のような出力が得られます。

['__class__', '__delattr__', '__dict__', '__dir__', '__doc__', '__eq__', '__format__', '__ge__', '__getattribute__', '__gt__', '__hash__', '__init__', '__init_subclass__', '__le__', '__lt__', '__module__', '__ne__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__', '__sizeof__', '__str__', '__subclasshook__', '__weakref__', 'method', 'value']

vars()関数でオブジェクトの属性を取得

vars()関数は、オブジェクトの属性を辞書形式で返します。これにより、オブジェクトの状態を詳細に確認することができます。

class Sample:
    def __init__(self):
        self.value = 42
        self.name = "SampleObject"

obj = Sample()
print(vars(obj))

このコードを実行すると、以下のような出力が得られます。

{'value': 42, 'name': 'SampleObject'}

inspectモジュールで詳細情報を取得

inspectモジュールは、オブジェクトのソースコードやメソッドの情報を取得するための強力なツールです。特に、関数やクラスの詳細を知りたいときに役立ちます。

import inspect

def sample_function():
    """This is a sample function."""
    return "Sample"

print(inspect.getmembers(sample_function))
print(inspect.getdoc(sample_function))

このコードを実行すると、関数のメンバー情報とドキュメンテーションが表示されます。

[('__annotations__', {}), ('__call__', ), ('__class__', ), ('__closure__', None), ('__code__', ", line 2>), ('__defaults__', None), ('__delattr__', ), ('__dict__', {}), ('__dir__', ), ('__doc__', 'This is a sample function.'), ('__eq__', ), ('__format__', ), ('__ge__', ), ('__get__', ), ('__getattribute__', ), ('__globals__', {...}), ('__gt__', ), ('__hash__', ), ('__init__', ), ('__init_subclass__', ), ('__kwdefaults__', None), ('__le__', ), ('__lt__', ), ('__module__', '__main__'), ('__name__', 'sample_function'), ('__ne__', ), ('__new__', ), ('__qualname__', 'sample_function'), ('__reduce__', ), ('__reduce_ex__', ), ('__repr__', ), ('__setattr__', ), ('__sizeof__', ), ('__str__', ), ('__subclasshook__', )]
This is a sample function.