[Pythonのはじめ方] Part36: 型ヒントとmypy

Pythonは動的型付け言語ですが、「型ヒント（Type Hints）」という仕組みを使うことで、コードがどのようなデータを扱うかを明示できるようになります。これに静的型チェッカー「mypy」を組み合わせることで、コードを実行する前に型の誤りを発見し、より堅牢なプログラムを作成できます。[1, 11, 20, 23]

このステップでは、Pythonの型ヒントの基本的な使い方と、mypyによる型チェックの方法を学び、コードの品質を高めるスキルを身につけましょう！🚀

型ヒント（Type Hints）は、Python 3.5から導入された、変数や関数の引数、戻り値に期待されるデータ型を注釈（アノテーション）として記述する機能です。[1, 11] Python自体は動的型付け言語であり、型ヒントがなくてもコードは実行できますが、型ヒントには以下のような大きなメリットがあります。[1, 11, 23]

• 可読性の向上: コードを読む人が、変数や関数が扱うデータの型を一目で理解しやすくなります。[1, 11, 23]
• バグの早期発見: mypyなどの静的型チェッカーツールを使うことで、型の不一致によるエラーを実行前に検出できます。[1, 11, 17, 20]
• 開発効率の向上: エディタやIDE（統合開発環境）が型情報を利用し、より正確なコード補完やエラーチェックを提供してくれます。[1, 22, 23]
• ドキュメントとしての価値: 型ヒント自体がコードの仕様の一部となり、ドキュメントとしての役割も果たします。[11, 20]

変数への型ヒント

変数名の後にコロン（:）と型名を記述します。Python 3.6以降で利用可能です。[23, 26]

age: int = 30
name: str = "Alice"
price: float = 1980.5
is_active: bool = True

# 型ヒントのみ記述することも可能
user_id: int
user_id = 12345

関数の引数と戻り値への型ヒント

関数の引数には変数と同様に 引数名: 型名 と記述します。戻り値の型は、引数リストの後ろにアロー（->）と型名を記述します。関数が何も返さない（またはNoneを返す）場合は -> None と指定します。[11, 23]

def greet(name: str) -> str:
    return f"Hello, {name}!"

def add(a: int, b: int) -> int:
    return a + b

def print_message(message: str) -> None:
    print(message)

# 使用例
user_greeting: str = greet("Bob")
total: int = add(5, 3)
print_message("Processing complete.")

リスト（list）や辞書（dict）など、コンテナ型の要素の型を指定したり、より複雑な型関係を表現したりするには、標準ライブラリの typing モジュールを利用します。[10, 11]

# typingモジュールから必要な型をインポート
from typing import List, Tuple, Dict, Set, Optional, Union, Any, Callable

# リスト（要素はすべてint）
numbers: List[int] = [1, 2, 3]

# タプル（要素の型と数が固定: intとstr）
person: Tuple[int, str] = (30, "Alice")
# タプル（要素の型は同じで数は可変: float）
coordinates: Tuple[float, ...] = (1.0, 2.5, 3.0)

# 辞書（キーがstr、値がint）
scores: Dict[str, int] = {"math": 80, "science": 95}

# セット（要素はすべてstr）
tags: Set[str] = {"python", "programming"}

# Optional[T]: T または None を許容 (Union[T, None] と同義)
nickname: Optional[str] = None

# Union[T1, T2, ...]: T1, T2, ... のいずれかの型を許容
value: Union[int, float] = 10.5

# Any: 任意の型を許容（型チェックを部分的に無効化）
anything: Any = "hello"
anything = 123

# Callable[[引数型...], 戻り値型]: 関数の型
def process_data(data: List[int], callback: Callable[[int], bool]) -> List[int]:
    return [item for item in data if callback(item)]

def is_even(n: int) -> bool:
    return n % 2 == 0

filtered_data = process_data([1, 2, 3, 4], is_even)

よく使われる typing モジュールの型:

💡 モダンな書き方:

• Python 3.9 以降: typing.Listやtyping.Dictの代わりに、組み込みのlistやdictを直接ジェネリクスとして使えます (例: list[int], dict[str, int])。[1, 3, 24] typing.Listなどは非推奨になりました。[1, 24]
• Python 3.10 以降: Union[X, Y]の代わりにパイプ演算子|を使えます (例: int | str)。[1, 13, 21] Optional[X]もX | Noneと書けます。[1, 13, 21]
• Python 3.12 以降: 型エイリアスを定義するための新しい type 文が導入されました。[4] また、ジェネリクスクラスや関数をより簡潔に定義できる新しい構文も追加されています。[4] メソッドのオーバーライドを示す @override デコレータも利用できます。[12]

# Python 3.9+
numbers: list[int] = [1, 2, 3]
scores: dict[str, int] = {"math": 80}

# Python 3.10+
identifier: int | str = "user123"
maybe_name: str | None = None # Optional[str] と同じ

# Python 3.12+
type Point = tuple[float, float] # 型エイリアス
def process_point(p: Point) -> None:
    print(p)

mypyは、Pythonコードの型ヒントをチェックするための代表的な静的型チェッカーツールです。[1, 7, 19] コードを実行する前に、型に関するエラーを発見し、バグを未然に防ぐのに役立ちます。[17, 19, 20]

インストール

pipを使って簡単にインストールできます。[1, 2, 27]

pip install mypy

基本的な使い方

ターミナル（コマンドプロンプト）で mypy コマンドの後にチェックしたいPythonファイル名（またはディレクトリ名）を指定します。[2, 17, 27]

mypy your_script.py
mypy your_project_directory/

例えば、次のような型エラーを含むコード (type_error_example.py) があるとします。

# type_error_example.py
def add(a: int, b: int) -> int:
    return a + b

result: int = add(5, "3") # 👈 エラー箇所: 第2引数が文字列になっている
print(result)

name: str = 123 # 👈 エラー箇所: 文字列型変数に整数を代入

このファイルに対してmypyを実行すると、mypyは型の不一致を検出し、以下のようなエラーメッセージを出力します。[1, 27]

type_error_example.py:5: error: Argument 2 to "add" has incompatible type "str"; expected "int"  [arg-type]
type_error_example.py:8: error: Incompatible types in assignment (expression has type "int", variable has type "str")  [assignment]
Found 2 errors in 1 file (checked 1 source file)

このように、mypyはコードを実行する前に、型の問題を教えてくれます。これにより、実行時エラーを減らし、コードの信頼性を高めることができます。✅ [1, 17]

mypyの設定ファイル (mypy.ini)

プロジェクトのルートディレクトリに mypy.ini という設定ファイルを作成することで、mypyのチェック動作を細かくカスタマイズできます。[17] 例えば、より厳格なチェックルールを適用したり、特定のファイルやエラーを無視したりする設定が可能です。

[mypy]
python_version = 3.11 # 対象とするPythonのバージョンを指定

# 基本的な厳格チェックを有効化
warn_return_any = True
warn_unused_configs = True

# より厳格なチェック項目 (例)
disallow_untyped_defs = True # 型ヒントがない関数定義をエラーにする
disallow_incomplete_defs = True # 部分的にしか型ヒントがない関数定義をエラーにする
disallow_untyped_calls = True # 型ヒントがない関数呼び出しをエラーにする

# 特定のファイルやディレクトリを除外
exclude = (?x)(
    ^tests/.*$
  | ^build/.*$
  )

# 特定のエラーコードを無視 (非推奨だが、移行期などに一時的に利用)
# disable_error_code = assignment, misc

# プラグインの利用など
# plugins = mypy_django_plugin.main

[mypy-*.migrations.*]
# Djangoのマイグレーションファイルではエラーを無視する例
ignore_errors = True

利用可能な設定項目は多岐にわたります。詳細はmypyの公式ドキュメントを参照してください。

型ヒントとmypyは、現代的なPython開発において非常に有効なツールです。

• 型ヒント: コードの意図を明確にし、可読性と保守性を向上させます。[1, 11, 17]
• mypy: 静的な型チェックにより、実行前に型の不整合を発見し、バグを減らしてコードの信頼性を高めます。[1, 17, 20]

最初は少し記述が増えるかもしれませんが、特に複数人での開発や長期的にメンテナンスするプロジェクトでは、そのメリットは非常に大きいです。[3, 20] 型ヒントとmypyを積極的に活用し、より高品質で堅牢なPythonコードを目指しましょう！💪

これでStep 8は完了です！テストと保守に関するスキルを身につけ、より信頼性の高いPythonプログラムを作成できるようになりましたね！🎉

• Python公式ドキュメント – typing — 型ヒントのサポート: https://docs.python.org/ja/3/library/typing.html [10]
• Static Typing with Python (型ヒントの仕様ドキュメント, 英語): https://typing.readthedocs.io/en/latest/ (GitHubリポジトリ: https://github.com/python/typing [6]) [8, 18]
• mypy documentation (mypy公式ドキュメント, 英語): https://mypy.readthedocs.io/en/stable/ (または https://www.mypy-lang.org/) [7, 9, 19]
• mypy Type Hint Cheat Sheet (mypyチートシート, 英語): https://mypy.readthedocs.io/en/stable/cheat_sheet_py3.html [14] (日本語での解説例 [27])
• PEP 484 — Type Hints (型ヒントの提案仕様, 英語): https://peps.python.org/pep-0484/ [7]