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

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

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

作成日: 更新日:

基本的な使い方

__eq__メソッドは、2つのオブジェクトが等しいかどうかを比較する処理を実行するメソッドです。

Pythonにおいて、==(等値演算子)を使用してオブジェクト同士を比較する際に、内部的に自動で呼び出される特殊なメソッド(Dunder Methodとも呼ばれます)の一つです。このメソッドは、自身(self)と別のオブジェクト(other)という2つの引数を受け取り、それらが等しいと判断できる場合には真偽値Trueを、等しくない場合にはFalseを返します。

AnnAssignクラスは、Pythonのコードが内部的にどのように構造化されているかを示す「抽象構文木(AST)」の一部を表すクラスです。具体的には、型ヒントが付けられた代入文(例: variable: int = 10)を表現します。このAnnAssignクラスに実装されている__eq__メソッドは、2つのAnnAssignオブジェクトが同じ代入文の意味を持っているかどうかを判定するために利用されます。例えば、同じ変数名、同じ型ヒント、そして同じ初期値を持つ代入文であれば等しいと判断されるといった、具体的な比較ロジックがこのメソッド内に定義されています。

プログラマーが自身でカスタムクラスを作成する際にも、この__eq__メソッドを実装することで、そのクラスのオブジェクトがどのような条件で等しいと見なされるかを独自に定義し、柔軟な比較ロジックを実現することが可能です。

構文(syntax)

1import ast
2
3# AnnAssignオブジェクトの生成例
4# 'x: int = 1' というコードを表すASTノード
5node1 = ast.AnnAssign(
6    target=ast.Name(id='x', ctx=ast.Store()),
7    annotation=ast.Name(id='int', ctx=ast.Load()),
8    value=ast.Constant(value=1),
9    simple=1
10)
11
12# 比較対象のAnnAssignオブジェクト
13# 同じ内容を持つノード
14node2 = ast.AnnAssign(
15    target=ast.Name(id='x', ctx=ast.Store()),
16    annotation=ast.Name(id='int', ctx=ast.Load()),
17    value=ast.Constant(value=1),
18    simple=1
19)
20
21# 異なる内容を持つノード
22node3 = ast.AnnAssign(
23    target=ast.Name(id='y', ctx=ast.Store()),
24    annotation=ast.Name(id='str', ctx=ast.Load()),
25    value=ast.Constant(value="hello"),
26    simple=1
27)
28
29# __eq__メソッド(==演算子)を使用した構文
30are_equal_1_2 = node1 == node2
31are_equal_1_3 = node1 == node3

引数(parameters)

self, value: object, /

  • value: object: 比較対象となるオブジェクト

戻り値(return)

bool

AnnAssignオブジェクト同士が等しい場合にTrue、そうでない場合にFalseを返します。

関連コンテンツ

関連プログラミング言語