【Python】抽象メソットの書き方

Last updated at 2024-12-17Posted at 2024-12-17

疑問

次のコードがmypyの型チェックでエラーになりました。
getメソッドはMyData型を返すとしていますが、Noneを返しているためです。

class MyClass(ABC):
    @abstractmethod
    def get(self) -> MyData:
        return None # 型ヒントと不一致

抽象メソッドには実装が存在しないことを示すべきですが、returnを書いてしまうと型チェックに引っかかります。
正しい記述方法を検討してみました。

抽象メソッドの本体には何も実装しないことが重要です。次の記述が一般的です。

class MyClass(ABC):
    @abstractmethod
    def get(self) -> MyData:
        ...

…は、は未実装を示す視覚的なシンプルな記述です。Ellipsis リテラルとしてPythonに組み込まれています。

class MyClass(ABC):
    @abstractmethod
    def get(self) -> MyData:
        pass

passはPythonの伝統的な記述です。公式ドキュメントでもpassがよく用いられています。

class MyClass(ABC):
    @abstractmethod
    def get(self) -> MyData:
        """Dataを取得するを取得する."""

docstringがある場合、mypyエラーは発生しませんが、...を併用して未実装を明示してもよいとおもいます。
docstringとpassを併用すると、ruff checkでPIE790('Unnecessary `pass` statement')警告となります。

どの記述にするかはプロジェクトのコーディングルール次第ですが、...を使う方が最近のトレンドとして増えている気がします。未実装の関数を一目で確認でき、ruffのチェックにも適合しやすいです。

class MyClass(ABC):
    @abstractmethod
    def get(self) -> MyData:
        """Dataを取得するを取得する."""
        ...

PythonAdvent Calendar 2024