【Python】引数の型チェックは必須とすべきか

Question

コンストラクタやメソッドに引数を渡します。

このとき、引数が予定通りの型であるかどうかをコンストラクタ側、メソッド側にチェックさせるべきでしょうか？

全引数に対し確認、TypeErrorの発生をさせるべきでしょうか？

バグが減っていいような気もしますが、あまりにも冗長とも感じます。

型ヒントもエラーや警告が発生するわけでもないので万全とは言えないと思います。

どのくらいで型チェックを書くべきでしょうか？

def test(self, a:str):
    if not type(a) is str:
        raise TypeError()
    # 以降、メソッド本来の動作

Comments

[gouf]

これは興味なのですが、どういった背景がありこのような疑問が発生したのでしょうか。たとえば静的型付け言語のような書き方を動的型付け言語でも実現したい、といったことなのでしょうか?

[退会済みユーザー]

現在、機械学習に関するプログラムを書いています。ご存知かと思いますが、機械学習はほぼPython一択ですよね。ただ、Pythonでも静的言語のようなしっかりとした型チェックができないものかと思い、質問させていただきました。

Answer 1

型アノテーションはそれなりに強力なので、静的なチェックを意図するのであればこちらを重視してください。

質問文のようなチェック方法であれば、書いたところでほとんど無駄です。なぜなら、型チェックを書こうと書くまいと実行時エラーになるのは変わりないからです。

たとえば呼び出し元で極めて稀な条件が成立したときだけ型の不一致でエラーになるような状態を検出したいと考えた場合、質問文のアプローチは何ら意味を持ちません。

それをやる意味があるシチュエーションというのは、

• 最終的にどこかで破綻して出てくる長大なtracebackを開発者に示すのではなく、もう少し親切なメッセージを出してあげたい
• やらないとより深刻な事態を引き起こす（たとえば外部リソースをクラッシュさせ得るとか）のでやらざるを得ない

といったケースが考えられると思います。逆に言えば、一般的なコードでは必要ないだろう、ということです。

Comments

[KSwordOfHaste]

自分の回答は感覚的な書き方しかできてなかったですが、hayataka2049さん回答のように論理的に根拠を挙げるべきだったと思いました。より深刻な事態を引き起こす例として外部リソースをクラッシュさせるというのは低水準処理/OS機能の利用などで気にすると思いますが、一般的アプリケーションとしてありそうな例としては「延々と計算した結果が間違いとなる可能性がある＝＞チェックを怠るとバグのために無駄なデバッグ時間がかかるかも知れない＝＞事前にチェックしておこう」なんてケースではないかと思いました。バグのために無駄なデバッグ時間がかかるというのはプログラマーにとって深刻な事態の一つと言ってよいと思います。定義域の範囲外の値を引数に指定した場合に計算がそれ以上進む前に（例え長々とスタックトレースが出たとしても）すぐに例外が起きてくれるのならそれは深刻とは言えないですよね！

[hayataka2049]

動的型付け言語を使うのにわざわざ型チェックを書くのも悲しい、という率直な気持ちも大切だと思います。

Answer 2

自分はアマチュアなのでプロの方と感覚が違う気がしますが・・・

もしライブラリーを作っているなら「リファレンスを見もせずに使おうとする人」に対して「なるべく早く引数が間違っている点をチェックして問い合わせを減らす」ことに留意した方がよいかも知れません。

しかし自分のアプリケーションを作るにあたり型のチェックを一々やるのはナンセンスだと自分は思います。ちょっとここはチェックしておくかなぁというところにassertを付けることはありますが。あるいはPyCharmのように「型アノテーションを静的にチェックし、うっかりミスを早めに指摘してくれるIDE」を使って「ライブラリーを使うときの引数の指定のケアレスミスを多少なりとも減らす」ということは普段からやります。ただ自分で書いたアプリケーションのコードに一々アノテーションを付けるかというと・・・ある程度大き目のものならやったことがありますが実行時にまでチェックを入れるようなことは、デバッグではやりますが最初からはあまりやらないです。

なるべく厳密にかっちり作りたいのなら動的型付け言語でやるうま味が少なくなってくるので、静的型付け言語で書いた方がよいのではないかと思ったりもします。

動的型付け言語を使うというのは「型がどうなっているべきか」をコーディングする時点で「頭において」設計を進め、一々そんなのを宣言したりチェックしたりという手間を省いても「だいたい正しくコードが書ける自信がある場面で生きる」のではないでしょうか？

Comments

[KSwordOfHaste]

コーディングする時点で・・・設計を進め

なんて書いてしまいました。
アマチュアまるだしの内容だと思います・・・普通設計してからコーディングするんですよね・・・