Pythonの型システムを理解する：`types.NotImplementedType`とその他の特殊型

理解を深めるために、以下のポイントを解説します。

NotImplementedType の役割

これは、プログラマーが意図的に実装を省略していることを明確に示すため、エラーを防ぐのに役立ちます。
例えば、抽象基底クラスで定義されているメソッドを、サブクラスで独自に実装するまで、NotImplementedType を返すことができます。
メソッドや演算子がまだ実装されていないことを示すために使用されます。

NotImplementedType の使い方

例：
メソッドや演算子を実装する際に、NotImplementedType を直接返すことができます。

class AbstractShape:
  def area(self):
    raise NotImplementedError

class Square(AbstractShape):
  def __init__(self, side_length):
    self.side_length = side_length

  def area(self):
    return self.side_length * self.side_length

square = Square(5)
print(square.area())  # 25 が出力されます

NotImplementedType と None の違い

どちらもオブジェクトとして扱えますが、異なる意味を持つことに注意が必要です。
一方、None は、オブジェクトが存在しないことを示すために使用されます。
NotImplementedType は、メソッドや演算子が意図的に実装されていないことを示すために使用されます。

isinstance() と issubclass() の使い分け

issubclass() は、クラスが特定のクラスのサブクラスであるかどうかを確認するために使用されます。
isinstance() は、オブジェクトが特定の型のインスタンスであるかどうかを確認するために使用されます。

square = Square(5)
print(isinstance(square, AbstractShape))  # True が出力されます
print(issubclass(Square, AbstractShape))  # True が出力されます

例えば、list 型の __eq__ メソッドは、比較がサポートされていないことを示すために NotImplementedType を返します。
NotImplementedType は、標準ライブラリのいくつかの組み込み型でも使用されています。

types.NotImplementedType は、Pythonにおける重要な型であり、メソッドや演算子の実装状況を明確に示すために使用されます。この型を理解することで、より読みやすく、保守しやすいコードを書くことができます。

Python's NotImplemented Type - Shahriar Tajbakhsh - Medium

抽象基底クラスとサブクラス

この例では、Shape という抽象基底クラスと、そのサブクラスである Circle と Rectangle を定義します。Shape クラスには、area() メソッドが定義されていますが、これはまだ実装されていません。Circle と Rectangle クラスは、それぞれ独自の area() メソッドを実装します。

class Shape:
  def area(self):
    raise NotImplementedError

class Circle(Shape):
  def __init__(self, radius):
    self.radius = radius

  def area(self):
    return math.pi * self.radius * self.radius

class Rectangle(Shape):
  def __init__(self, width, height):
    self.width = width
    self.height = height

  def area(self):
    return self.width * self.height

circle = Circle(5)
rectangle = Rectangle(10, 7)

print(circle.area())  # 78.53981633974483 が出力されます
print(rectangle.area())  # 70.0 が出力されます

カスタムオブジェクト

この例では、NotImplementedType を使用するカスタムオブジェクトを定義します。

class Point:
  def __init__(self, x, y):
    self.x = x
    self.y = y

  def __add__(self, other):
    if isinstance(other, Point):
      return Point(self.x + other.x, self.y + other.y)
    else:
      raise NotImplementedError

point1 = Point(1, 2)
point2 = Point(3, 4)

print(point1 + point2)  # Point(4, 6) が出力されます
print(point1 + 5)  # TypeError が発生します

標準ライブラリ

この例では、標準ライブラリの list 型の __eq__ メソッドが NotImplementedType を返すことを示します。

list1 = [1, 2, 3]
list2 = [1, 2, 3]

print(list1 == list2)  # True が出力されます
print(list1.__eq__(list2))  # True が出力されます

list3 = [4, 5, 6]

print(list1 == list3)  # False が出力されます
print(list1.__eq__(list3))  # NotImplementedType オブジェクトが返されます

NotImplementedType を理解することで、より読みやすく、保守しやすいコードを書くことができます。
抽象基底クラスとサブクラス、カスタムオブジェクト、標準ライブラリなど、さまざまなコンテキストで使用できます。
上記のコードは、types.NotImplementedType をさまざまな状況で使用する方法を示しています。

types.NotImplementedType を使用する際には、その意図を明確にコメントで説明することをお勧めします。
上記のコードはあくまで例であり、状況に応じてさまざまな方法で使用できます。

代替方法を検討すべきケース：

より具体的な情報を提供したい場合: 単に NotImplementedType を返すのではなく、その理由を明確にすることが重要です。例えば、NotImplementedError を継承した独自の例外クラスを作成することで、より詳細な情報を提供できます。
デフォルト動作を提供したい場合: 一部の状況では、NotImplementedType を返す代わりに、デフォルトの動作を提供することが適切です。例えば、数学演算子を実装していない場合、常に 0 を返すようにすることができます。
コードをより簡潔にしたい場合: 一部の単純なケースでは、NotImplementedType を使用するよりも、None を返す方が簡潔な場合があります。

代替方法の例：

例外を使用する

class AbstractShape:
  def area(self):
    raise NotImplementedError("AbstractShape.area() is not implemented")

class Square(AbstractShape):
  def __init__(self, side_length):
    self.side_length = side_length

  def area(self):
    return self.side_length * self.side_length

square = Square(5)
try:
  print(square.area())
except NotImplementedError as e:
  print(f"Error: {e}")

デフォルト値を返す

class AbstractShape:
  def area(self):
    return 0

class Square(AbstractShape):
  def __init__(self, side_length):
    self.side_length = side_length

  def area(self):
    return self.side_length * self.side_length

square = Square(5)
print(square.area())  # 25 が出力されます

None を返す

def add_vectors(vector1, vector2):
  if not isinstance(vector1, list) or not isinstance(vector2, list):
    return None

  if len(vector1) != len(vector2):
    return None

  result = []
  for i in range(len(vector1)):
    result.append(vector1[i] + vector2[i])

  return result

vector1 = [1, 2]
vector2 = [3, 4]
print(add_vectors(vector1, vector2))  # [4, 6] が出力されます

vector3 = [5]
print(add_vectors(vector1, vector3))  # None が出力されます

注意事項

コードの可読性と保守性を高めるために、コメントを追加することを忘れないでください。
常に最も明確で簡潔な方法を選択するようにしましょう。
代替方法を選択する際には、状況とコードの意図を考慮することが重要です。