mypy - 型チェック

mypyは、Pythonの静的型チェッカです。Pythonは動的型付け言語のため、変数や関数の引数にどんな型の値でも入れることができます。これは柔軟である反面、意図しない型の値が渡されてもエラーにならず、実行時に初めて問題が発覚することがあります。

Pythonでは、型ヒント(Type Hints) を記述することで、コードに「この変数はint型」「この関数はstrを返す」といった型の情報を付けることができます。mypyはこの型ヒントをもとに、実行前に型の不整合を検出します。

1. 型ヒントの基本

Pythonでは、関数の引数や戻り値に型ヒントを付けることができます。

def greet(name: str) -> str:
    return "Hello, " + name

def calculate_total(price: int, quantity: int) -> int:
    return price * quantity
  • name: str は引数nameがstr型であることを示す
  • -> str は戻り値がstr型であることを示す
💡 ポイント
型ヒントはあくまで「注釈」であり、Pythonの実行時には強制されません。型ヒントに反する値を渡してもプログラムはそのまま動作します。mypyのような静的型チェッカを使って初めて、型の不整合を検出できます。

2. mypyの実行

以下のコマンドでmypyを実行します。

Windowsの場合:

mypy src/

Macの場合:

python3 -m mypy src/

実行すると、以下のようなエラーが表示されます。

src/user_service.py:8: error: Argument 2 to "get" of "dict" has incompatible type "str"; expected "int"  [arg-type]
Found 1 error in 1 file (checked 3 source files)

出力の読み方は以下の通りです。

  • ファイル名:行番号: error: メッセージ [エラーカテゴリ]
  • 最終行にはエラーの合計件数とチェックしたファイル数が表示される

検出されたエラーについて解説します。

Argument 2 to "get" of "dict" has incompatible type "str"; expected "int"  [arg-type]

agesはdict[int, int]と推論されるため、dict.get(key, default) の第2引数(デフォルト値)にもintが期待されます。しかし"N/A"という文字列を渡しているため、mypyが型の不整合を検出しています。宣言した戻り値型intと、実際に返しうる値の不整合が根本原因ですが、mypyは.get() の引数チェックとして先に指摘します。

💡 ポイント
Flake8はコードの「見た目」(スタイル)をチェックしますが、mypyはコードの「意味」(型の整合性)をチェックします。mypyが検出するのは、実行時にバグになりうる型の不整合です。

3. エラーの修正

型の不整合を修正するために、src/user_service.pyのget_user_age関数を以下のように修正します。

def get_user_age(user_id: int) -> int:
    ages = {1: 25, 2: 30, 3: 35}
    return ages.get(user_id, 0)

デフォルト値を文字列"N/A"から数値0に変更することで、戻り値の型が常にintになり、宣言と一致します。

修正後に再度mypyを実行して、エラーが解消されたことを確認しましょう。

Windowsの場合:

mypy src/

Macの場合:

python3 -m mypy src/

以下のように、エラーが解消されたことが表示されます。

Success: no issues found in 2 source files

4. mypyの設定

mypyもFlake8やBlackと同様に、プロジェクトに合わせた設定のカスタマイズができます。mypyの設定はBlackと同じくpyproject.tomlファイルに記述します。

設定を行う理由は主に2つあります。1つ目は、チェック対象のPythonバージョンを明示することで、チーム全員が同じ基準でチェックできるようにすることです。2つ目は、デフォルトでは無効になっているより厳格なチェックルールを有効にすることで、型の不整合をより多く検出できるようにすることです。

先ほど作成したpyproject.tomlに以下の内容を追加します。

[tool.black]
line-length = 120

[tool.mypy]
python_version = "3.12"
warn_return_any = true
warn_unused_configs = true

追加したコードを解説します。

[tool.mypy]

mypyの設定セクションの開始を示しています。Blackの[tool.black]と同様に、pyproject.tomlではツールごとにセクションを分けて設定を記述します。

python_version = "3.12"

チェック対象のPythonバージョンを指定しています。指定したバージョンで利用できない構文や型を使った場合にエラーが報告されます。チーム内で使用するPythonバージョンを統一するために設定します。

warn_return_any = true

戻り値の型がAny(型が不明)になっている場合に警告を出す設定です。デフォルトでは無効になっていますが、有効にすることで型チェックの漏れを防ぐことができます。

warn_unused_configs = true

設定ファイル内で使われていない設定項目がある場合に警告を出す設定です。設定の記述ミスを早期に発見するために有効にしています。

💡 ポイント
今回追加したwarn_return_anyとwarn_unused_configsは、サンプルコードでは該当するケースがないため、出力結果に変化はありません。しかし、実際のプロジェクトではこれらの設定が問題の早期発見に役立ちます。

mypyにはこのほかにも多くの設定項目があります。主な設定項目は以下のとおりです。

設定項目 説明 デフォルト値
python_version チェック対象のPythonバージョン 実行環境のバージョン
warn_return_any 戻り値がAny型の場合に警告 false
warn_unused_configs 未使用の設定項目を警告 false
disallow_untyped_defs 型ヒントのない関数定義をエラーにする false
ignore_missing_imports インポート先の型情報がない場合のエラーを無視 false

今回のハンズオンでは基本的な設定のみですが、プロジェクトの規模が大きくなるにつれて、disallow_untyped_defsなどのより厳格なチェックを段階的に導入していくことが一般的です。