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

【Python3.x】__base__::__setattr__()メソッドの使い方

__setattr__メソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

__setattr__メソッドは、Pythonのオブジェクトの属性に値を設定する際に、その挙動をカスタマイズするために使用される特殊なメソッドです。このメソッドは、obj.attribute = value のような形式でオブジェクトの属性に値を代入するたびに、Pythonインタープリタによって自動的に呼び出されます。

具体的には、__setattr__(self, name, value) という形で定義され、selfは属性を設定するオブジェクト自身、nameは文字列として設定される属性の名前、valueはその属性に設定される値をそれぞれ表します。このメソッドをオーバーライドすることで、属性に値が設定される前にその値を検証したり、特定の条件に基づいて値を変換したり、属性設定に関連する追加の処理を実行したりすることが可能になります。例えば、属性に負の数が設定されるのを防ぐ、あるいは特定の型の値のみを受け入れるといった実装が考えられます。

__setattr__を独自に実装する際には、無限再帰に陥らないよう注意が必要です。メソッド内で self.name = value のように直接属性を代入しようとすると、再び自身の __setattr__ が呼び出されてしまい、エラーが発生します。これを避けるためには、基底クラスである object の __setattr__ メソッドを明示的に呼び出す (object.__setattr__(self, name, value)) か、またはオブジェクトの内部辞書 self.__dict__ に直接値を設定する (self.__dict__[name] = value) 必要があります。これにより、属性設定処理の柔軟な制御を実現します。

構文(syntax)

1class MyClass:
2    def __setattr__(self, name: str, value: object):
3        object.__setattr__(self, name, value)

引数(parameters)

self, name: str, value: object

  • self: メソッドが呼び出されたオブジェクト自身
  • name: str: 設定する属性の名前(文字列)
  • value: object: 設定する属性の値

戻り値(return)

戻り値なし

戻り値はありません

関連コンテンツ