型チェックを使ってみよう

[sotetsuk]

これまで、特に説明せずにPythonの型ヒント機能を使ってきましたが、より実践的な型チェックをしてみましょう。

型ヒントの例

型ヒントの基本的な書き方

Pythonは動的型付け言語ですが、型アノテーションを付け加えることで、統合開発環境によるリッチ補完や、バグの早期発見が可能になります。

主に、関数の引数と返り値にアノテーションを付けて検証すると良いでしょう。

def square(x: int) -> int:
    return x * x

x: int が引数がint型であること、-> int が返り値がint型であることを示しています。

型チェックの実行の仕方

今回作成した、fizzbuzz ライブラリの型が正しいか確認してみましょう。
型チェックは mypy パッケージを利用します。

現状、型チェックは問題ないことが分かります。
では、あえて返り値の型を間違えてみるとどうなるでしょうか？
返り値の型を間違えると、次のように、PyCharmが警告を出してくれます。

また、mypyの実行結果もエラーを返します。

型チェックをCIへ組み込む

ローカルで、型チェックが通ったら、これをテストと同じように、GitHub上でCIとして自動で実行できるようにしましょう。
#41 のPRを参考に、機能追加をしてみて下さい。

目次

1. プロジェクトを初期化しよう
2. 仕様を決めて、ユニットテストを追加してみよう
3. ユニットテストが通るように本体を実装してみよう
4. (Optional) doctestを導入してみよう
5. 新しい機能を追加する前に、CIを導入してみよう
6. 新しい機能を追加してみよう
7. ライブラリとして使えるようにしてみよう
8. CLIツールとして使えるようにしてみよう
9. (Optional) 便利な外部ライブラリをインストールして使ってみよう (Pytest編)
10. (Optional) 便利な外部ライブラリをインストールして使ってみよう (Click編)
11. [現在] 型チェックを使ってみよう
12. [つぎ] しっかりとしたREADMEを書こう