Pythonで__lt__と__gt__による比較演算子のオーバーロードを実装する方法

Pythonには、演算子の挙動をカスタマイズ（オーバーロード）するための「マジックメソッド（特殊メソッド）」が用意されています。比較演算子（<、<=、>、>=、==、!=）は、それぞれ対応するマジックメソッドである __lt__、__le__、__gt__、__ge__、__eq__、__ne__ をクラス内に定義することでオーバーロードできます。

以下のプログラムでは、フィート（ft）とインチ（inch）で距離を表す「distance」クラスを作成し、< 演算子と > 演算子をオーバーロードして、オブジェクト同士を比較できるようにしています。

class distance:
  def __init__(self, x=5,y=5):
    self.ft=x
    self.inch=y

  def __eq__(self, other):
    if self.ft==other.ft and self.inch==other.inch:
      return "both objects are equal"
    else:
      return "both objects are not equal"

  def __lt__(self, other):
    in1=self.ft*12+self.inch
    in2=other.ft*12+other.inch
    if in1<in2:
      return "first object smaller than other"
    else:
      return "first object not smaller than other"

  def __gt__(self, other):
    in1=self.ft*12+self.inch
    in2=other.ft*12+other.inch
    if in1<in2:
      return "first object greater than other"
    else:
      return "first object not greater than other"

d1=distance(5,5)
d2=distance()
print (d1>d2)
d3=distance()
d4=distance(6,10)
print (d1<d2)
d5=distance(3,11)
d6=distance()
print(d5<d6)

実行結果

このプログラムを実行すると、次のような出力が得られます。__lt__ と __gt__ のマジックメソッドが正しく動作し、オブジェクト同士の比較が行えていることが確認できます。

first object not greater than other
first object not smaller than other
first object smaller than other

コードのポイント

• __lt__（less than）：< 演算子が使われたときに呼び出され、自身のオブジェクトが引数のオブジェクトより小さいかどうかを判定します。
• __gt__（greater than）：> 演算子が使われたときに呼び出され、自身のオブジェクトが引数のオブジェクトより大きいかどうかを判定します。
• 比較の際は、フィートをインチに換算（ft × 12 ＋ inch）してから値を比べています。

補足：functools.total_orderingで記述量を減らす

すべての比較演算子を個別に実装するのは手間がかかります。標準ライブラリの functools.total_ordering デコレータを使えば、__eq__ と __lt__（または __gt__ など比較系メソッドのいずれか1つ）だけを定義するだけで、残りの比較メソッドが自動的に生成され、コードを大幅に簡潔にできます。