【Python】型付けを行い、 mypy で堅牢なコードを書こう

この記事では、 Python の型付けと、 mypy を用いたチェックまで、サンプルコードを交えて解説します。

Python は動的型付け言語として知られていますが、バージョン3.5以降、型ヒントという機能が導入され、静的型チェックが可能になりました。

なぜ Python に型付けが必要なのか

コードの可読性向上

型ヒントを使うことで、コードを読む人が変数や関数のデータ型を直感的に理解できるようになります。

例えば、 name: str と書かれていれば、その変数が文字列を持つことが一目でわかります。

これにより、コードの可読性が格段に上がり、他の開発者や自分自身が後からコードを見直す際に非常に役立ちますね。

バグの早期発見

静的型チェックツール（例えば、mypy）を使用すると、プログラムの実行前に型の不一致や潜在的なバグを検出できます。

これにより、バグの早期発見が可能になり、デバッグにかかる時間と労力を大幅に削減できます。

例えば、整数型を期待しているところに誤って文字列を渡してしまうようなミスも事前に防ぐことができます。

mypy については後の章でも紹介しているのでご覧ください。

IDEによるコード補完の強化

型ヒントを追加すると、IDE（統合開発環境）がより賢くなり、コード補完機能が強化されます。

例えば、関数の引数や戻り値の型が明示されていると、IDEが自動的に適切な候補を提案してくれます。

コーディングが効率化し、開発スピードの向上も期待できますよね。

ドキュメンテーションの改善

これは副次的なメリットかもしれませんが、個人的には非常に大きなメリットです。

型ヒントは、コードの動作を明確にするための一種のドキュメントとしても機能します。

関数やメソッドの引数と戻り値の型を明示することで、初めてコードを見る人にも、関数の使い方や期待されるデータの形式を理解しやすくなります。

コードのメンテナンス性が向上することはもちろん、新しい開発者がプロジェクトに参加する際にもスムーズに理解できるようになります。

Pythonの型ヒントの基本

変数の型ヒント

name: str = "John Doe"
age: int = 30
height: float = 175.5
is_student: bool = True

この例では、変数に型ヒントを付けています。

name: strは、name変数が文字列型（str）であることを示しています。
age: intは、age変数が整数型（int）であることを示しています。
height: floatは、height変数が浮動小数点数型（float）であることを示しています。
is_student: boolは、is_student変数が真偽値型（bool）であることを示しています。

このような型ヒントにより、コードの意図が明確になり、他の開発者が変数の期待される型を理解しやすくなります。

関数の型ヒント

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

def calculate_area(length: float, width: float) -> float:
    return length * width

関数の型ヒントは、引数と戻り値の型を指定します。

greet関数では、name: strで引数nameが文字列型であることを示し、-> strで戻り値が文字列型であることを示しています。
calculate_area関数では、length: floatとwidth: floatで両引数が浮動小数点数型であることを示し、-> floatで戻り値も浮動小数点数型であることを示しています。

関数の使用方法が明確になり、誤った型の引数を渡すことを防ぐことができます。

複合型の使用

リストとタプル

from typing import List, Tuple

def process_numbers(numbers: List[int]) -> int:
    return sum(numbers)

def get_coordinates() -> Tuple[float, float]:
    return (35.6895, 139.6917)  # 東京の緯度経度

List[int]は整数のリストを表します。process_numbers関数は整数のリストを受け取り、その合計（整数）を返します。
Tuple[float, float]は2つの浮動小数点数からなるタプルを表します。get_coordinates関数は緯度と経度（両方とも浮動小数点数）のタプルを返します。

辞書と集合

from typing import Dict, Set

def count_words(text: str) -> Dict[str, int]:
    words = text.split()
    return {word: words.count(word) for word in set(words)}

def unique_characters(text: str) -> Set[str]:
    return set(text)

Dict[str, int]は文字列をキーとし、整数を値とする辞書を表します。count_words関数は文字列を受け取り、各単語の出現回数を辞書として返します。
Set[str]は文字列の集合を表します。unique_characters関数は文字列を受け取り、その中のユニークな文字の集合を返します。

高度な型ヒント

Union型

from typing import Union

def print_id(id: Union[int, str]) -> None:
    print(f"ID: {id}")

Union[int, str]は、int型またはstr型のいずれかであることを示します。

この例では、print_id関数が整数または文字列のIDを受け付けることができます。

Optional型

from typing import Optional

def find_user(user_id: int) -> Optional[str]:
    users = {1: "Alice", 2: "Bob"}
    return users.get(user_id)

Optional[str]は、str型の値またはNoneを返す可能性があることを示します。

find_user関数は、ユーザーIDに対応する名前を返すか、見つからない場合はNoneを返します。

ジェネリクス

from typing import TypeVar, List

T = TypeVar('T')

def first_element(lst: List[T]) -> T:
    if lst:
        return lst[0]
    raise IndexError("List is empty")

TypeVarを使用してジェネリック型Tを定義しています。first_element関数は任意の型のリストを受け取り、その最初の要素を返します。これにより、関数が様々な型のリストに対して動作することを示せます。

型チェッカーの使用について

Python の型ヒントは、実行時には無視されます。

静的型チェックを行うには、外部ツールを使用する必要があります。

その中でも最も一般的なのが mypy です。

mypy のインストールと基本的な使用方法

pip install mypy
mypy your_script.py

mypy をインストールし、 Python スクリプトに対して実行することで、型の整合性をチェックできます。

mypy の機能と利点

静的型チェック: コードを実行せずに型の問題を検出します。
型推論: 明示的な型ヒントがない場合でも、可能な限り型を推論します。
設定のカスタマイズ: mypy.iniファイルを使用して、チェックの厳密さを調整できます。
段階的な型付け: 既存のコードベースに徐々に型ヒントを追加できます。

mypyの使用例

以下のPythonスクリプト（example.py）を考えてみましょう：

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

result = add("5", 10)
print(result)

このスクリプトに対して mypy を実行すると：

$ mypy example.py
example.py:4: error: Argument 1 to "add" has incompatible type "str"; expected "int"

mypy は、add関数が整数を期待しているのに文字列が渡されていることを検出し、エラーを報告します。

mypy の注意点

mypy は型ヒントに基づいてチェックを行うため、型ヒントがない部分は無視されます。
動的な振る舞いを多用するコードでは、mypyが誤検知する可能性があります。
サードパーティライブラリの型情報が不完全な場合、追加の設定が必要になることがあります。

おわりに

Python の型付けは、コードの品質と保守性を大幅に向上させる強力なツールです。

適切に使用することで、大規模なプロジェクトでも安全性と生産性を維持することができます。

mypy などの静的型チェッカーを活用することで、型の問題を早期に発見し、より堅牢なコードを書くことができます。

型ヒントを活用し、Pythonの柔軟性と静的型付けの利点を両立させましょう。