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

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

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

作成日: 更新日:

基本的な使い方

__setattr__メソッドは、Pythonにおいてオブジェクトの属性に値を設定する際に呼び出される特殊なメソッドです。これはPythonのデータモデルの一部であり、通称「マジックメソッド」とも呼ばれます。

具体的には、obj.attribute = value のような形式でオブジェクトの属性に新しい値を代入しようとすると、このメソッドが自動的に実行されます。Pythonのクラスでは通常、属性の設定はデフォルトの挙動で行われますが、この__setattr__をクラス内で定義することで、そのデフォルトの動作をカスタマイズできます。

このメソッドを利用することで、属性に値が設定される前に、その値の妥当性を検証(例えば、データ型チェックや値の範囲チェックなど)したり、属性が変更されたことをトリガーとして関連する他の処理を実行したりすることが可能になります。例えば、年齢属性に負の数を設定できないようにしたり、更新日時を自動的に記録したりする際に役立ちます。

__setattr__を実装する際には、内部でself.attribute = valueのような直接的な属性代入を行うと、再び__setattr__が呼び出されて無限ループに陥る危険性があるため注意が必要です。安全に属性を設定するには、object.__setattr__(self, name, value) のように、基底クラスの属性設定処理を明示的に呼び出す必要があります。このメソッドを理解することは、オブジェクトの内部動作をより深く制御し、堅牢で柔軟なクラス設計を行う上で非常に重要です。

構文(syntax)

1class MyClass:
2    def __setattr__(self, name, value):
3        pass

引数(parameters)

self, name: str, value: Any, /

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

戻り値(return)

戻り値なし

戻り値はありません

関連コンテンツ

関連プログラミング言語