Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

【Python3.x】getattr()関数の使い方

getattr関数の使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

getattr関数は、Pythonのオブジェクトから指定された名前の属性(メソッドやプロパティなど)を取得する関数です。この関数は、getattr(オブジェクト, 属性名)のように使用し、第一引数に属性を取得したい対象のオブジェクトを、第二引数に文字列として指定された属性名を渡します。例えば、my_object.valueという属性にアクセスしたい場合、getattr(my_object, 'value')と記述することで、その属性の値を取得できます。

もし指定された属性がオブジェクトに見つからない場合、通常はAttributeErrorというエラーが発生します。しかし、getattr関数には第三引数としてオプションのデフォルト値を指定できます。getattr(オブジェクト, 属性名, デフォルト値)のように記述すると、属性が見つからなかった場合にAttributeErrorを発生させる代わりに、このデフォルト値が返されます。これにより、属性の存在を事前に確認することなく、より安全に属性へのアクセスを試みることが可能になります。

この関数の主な利点は、属性名をプログラムの実行時に動的に決定できる点にあります。例えば、外部の設定ファイルから読み込んだ文字列や、ユーザーの入力に基づいて異なる属性にアクセスする必要がある場合などに非常に有用です。コードの柔軟性と汎用性を高め、オブジェクトの振る舞いを動的に制御したい場面で活用されます。

構文(syntax)

1class MyClass:
2    def __init__(self):
3        self.attribute_name = "attribute_value"
4
5my_instance = MyClass()
6# オブジェクト 'my_instance' から属性 'attribute_name' の値を取得する
7value = getattr(my_instance, "attribute_name")
8# value は "attribute_value" になる

引数(parameters)

object: Any, name: str, default: Any = None

  • object: Any: 属性を取得したいオブジェクト
  • name: str: 取得したい属性の名前(文字列)
  • default: Any = None: 属性が存在しない場合に返されるデフォルト値

戻り値(return)

属性の値またはデフォルト値

getattr 関数は、指定されたオブジェクトの属性の値、または属性が存在しない場合に指定されたデフォルト値を返します。

関連コンテンツ

関連プログラミング言語