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

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

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

作成日: 更新日:

基本的な使い方

__setattr__メソッドは、Pythonオブジェクトの属性に値を設定(代入)する際に内部的に呼び出されるメソッドです。例えば、my_object.attribute_name = value のように、オブジェクトの属性に値を代入する構文が実行されると、この__setattr__メソッドが自動的に実行されます。

このメソッドの基本的な役割は、指定された属性名に対して与えられた値を割り当てることです。通常、プログラマが直接このメソッドを呼び出すことはありませんが、クラスを設計する際に、属性への値の設定方法を詳細に制御したい場合に非常に重要な役割を果たします。

クラス内で__setattr__メソッドをオーバーライド(再定義)することで、属性に値が設定される際の挙動をカスタマイズできます。例えば、属性に代入される値が特定の条件を満たしているかを検証するバリデーションロジックを実装したり、属性が更新されるたびにログを記録したり、関連する他の属性を自動的に更新したりするなどの処理を追加することが可能です。

このようなカスタマイズにより、オブジェクトの内部状態の一貫性を保ちながら、より堅牢で柔軟なデータ管理を実現できます。ただし、__setattr__をオーバーライドする際には、メソッド内で再度self.属性名 = 値のような代入を行うと無限再帰に陥る可能性があるため、object.__setattr__(self, name, value)のように基底クラスのメソッドを明示的に呼び出すなどの特別な配慮が必要です。

構文(syntax)

1class MyClass:
2    def __setattr__(self, name, value):
3        # name: 設定される属性の名前(文字列)
4        # value: 設定される属性の値
5        super().__setattr__(name, value)

引数(parameters)

self, name: str, value: Any, /

  • self: 属性を設定するオブジェクト自身
  • name: str: 設定する属性の名前
  • value: Any: 設定する属性の値

戻り値(return)

戻り値なし

戻り値はありません

関連コンテンツ

関連プログラミング言語