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

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

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

作成日: 更新日:

基本的な使い方

__eq__メソッドは、Pythonにおいて、オブジェクト同士の等価性(==演算子)を判定する際の動作を定義するために使用される特殊メソッドです。

このメソッドは、Pythonのすべてのクラスがデフォルトで継承しており、初期状態では二つのオブジェクトがメモリ上で全く同じものであるか(つまり、同一のインスタンスであるか)どうかを比較します。しかし、多くの場面で、開発者はオブジェクトが保持する「値」や「内容」が等しい場合に、それらのオブジェクトを等価とみなしたいと考えるでしょう。

そのような要件がある場合、クラス内でこの__eq__メソッドを独自に実装(オーバーライド)することで、そのオブジェクトの属性値や内部状態に基づいたカスタムな等価性判定ロジックを定義できます。例えば、同じIDを持つ二つのユーザーオブジェクトを等価とみなす、といった具体的な比較規則を設定することが可能です。

__eq__メソッドを適切に実装することは、リストやセットなどのコレクション内でオブジェクトを検索したり、重複を排除したりする際に重要となります。また、単体テストフレームワークにおけるアサーション(例えば、assertEqualメソッドなど)がカスタムオブジェクトの比較を行う際にも、内部的にこの__eq__メソッドが利用されるため、正確なテスト結果を得る上でも不可欠な要素です。正しく定義された__eq__により、オブジェクトの比較が意図した通りに行われ、プログラムの信頼性が高まります。

構文(syntax)

1class Assert:
2    def __eq__(self, other):
3        pass

引数(parameters)

self, value, /

  • self: Assertクラスのインスタンス自身
  • value: Assertクラスのインスタンスと比較する値(位置引数のみ)

戻り値(return)

bool

二つのAssertオブジェクトが等しいかどうかを判定し、等しければTrue、そうでなければFalseを返します。

関連コンテンツ

関連プログラミング言語