mypyのエラーを発生させずにメソッドをオーバーライドするには

Question

以下のコードにおいて[mypy] error:Signature of "build_path" incompatible with supertype "Local"というエラーが発生しています。

mypyのエラーを発生させずにメソッドをオーバーライドするにはどうしたら良いのでしょうか？

class Local():
    def build_path(self, *file_or_directory_tuple: str) -> Path:
        path = Path.cwd()
        path = path.joinpath(*file_or_directory_tuple)
        return path


class NewsFile(Local):
    def build_path(self, title: str) -> Path:
        return super().build_path('news', title+'.txt')

Answer 1

mypyのエラーを発生させずにメソッドをオーバーライドするには

その前に「何故エラーになるかを理解する」のが先ではないでしょうか？
言い換えれば「なぜmypyを使うのか、その意義を把握する」のが先決だと思います。

class Local():
    def build_path(self, *file_or_directory_tuple: str) -> Path:
        path = Path.cwd()
        path = path.joinpath(*file_or_directory_tuple)
        return path


class NewsFile(Local):
    def build_path(self, title: str) -> Path:
        return super().build_path('news', title+'.txt')

instance: Local = NewFile()
path: Path = instance.build_path('Users', 'YourName', '.bashrc')

このコードは実行時にエラーになりますが

(1) 実行してみてエラーであることに気づけるならそれでもよい
(2) 実行前に静的に解析して「誤りだ！」と指摘してほしい

どちらでしょうか？

型アノテーションを使わずにプログラミングする従来スタイルでは(1)の考え、あるいは人間が目で見ればわかるから(1)だけでも問題にならないという考えだと思います。いわゆる動的型付け言語では主にこのスタイルでよいという考え方が根本にあると思います。

一方、「人間の不注意をコンピューターに機械的にチェックさせたい。そのためには多少柔軟性を犠牲にしてもよい」というのが(2)の考え方、すなわちいわゆる静的型付け言語の考え方です。

型アノテーションは動的型付け言語であるPythonに(2)の考え方でのプログラミングができるようにするためのものです。型を明示して「こうでなければならない」と宣言するなら必ずその制約を守ったコードを書く必要があります。

---

もしかしたら

method(self, *args: str)

の意味にお気づきでなかったのかも知れません。この仮引数argsの記述ですと「実引数はstr型、かつ引数の数はいくらでも(0個でも1個でも2個でも...)よい」という意味になります。

基底クラスではいくつ引数を指定してもよいとなっているのですから派生クラスでもそういう引数仕様にしておかないとNewsFileをLocalと見做して使うということができなくなります。

Localクラスのメソッドの入力仕様・出力仕様に従わないメソッドを持つクラスNewsFileをLocalの派生とすることは、(静的型付けに従ってプログラミングをするという意味において)意義がなくなるといえましょう。

---

どこに課題があるかはっきりわからなかったので色々コメントしましたが、単に基底クラスと互換性があるようにこのメソッドを実装するテクニックをお尋ねになっているのかも知れませんね。

もし「ディレクトリー要素を省略したときはあるディレクトリーを仮定する」、「拡張子を指定してなければ自動的に仮定する」という仕様にして基底クラスの引数仕様を「せばめる」のではなく「広げる」ならmypyは文句をいわなくなると思います。例えば以下のようにすればエラーはでなくなるでしょう。

class Defaulted(Local):
    def build_path(self, *path_elements: str) -> Path:
        assert len(path_elements) > 0
        if len(path_elements) == 1:
            path_elements = ('news',) + path_elements
        base_name = path_elements[-1]
        if '.' not in base_name:
            path_elements = path_elements[:-1] + \
                            (base_name + '.txt',)
        return super().build_path(*path_elements)

しかしこれは基底クラスのメソッドの拡張といえるでしょうか・・・。
自分の感覚ですと、そのような拡張を無理して作るよりはbuild_news_pathという別個の機能にしたほうがよほどわかりやすい気がします。

Localクラスなら
build_path('Users', 'name', '.bashrc')
といった使い方をするのに、NewsFileクラスなら
build_path('python-tips-1')
みたいな使い方になるのですよね？使う側でまったく違う使い方をしなければならないものに見えますので、そのメソッド名が同じであったりLocal/NewsFileクラスが継承関係にあるということが殆ど生きてこなくて、かえって混乱を招くような気がするのです。

Comments

[退会済みユーザー]

>>この仮引数argsの記述ですと「実引数はstr型、かつ引数の数はいくらでも(0個でも1個でも2個でも...)よい」という意味になります。

この意味については存じ上げていたのですが、

>>Localクラスのメソッドの入力仕様・出力仕様に従わないメソッドを持つクラスNewsFileをLocalの派生とすることは、(静的型付けに従ってプログラミングをするという意味において)意義がなくなるといえましょう。

ということについて全く考えていませんでした。納得いきました。回答ありがとうございました。