はじめに

Pythonでは厳密な型定義を実施することが不可能であり、完全な型安全性を確保することはできません。しかし、型ヒントを用いることである程度の型安全性を確保することができます。型ヒントの一つであるLiteralを用いた際にmypyのエラーに遭遇し、その解決にすこし手間取ったので備忘録として残しておきます。

問題となるコード

from typing import Literal

var_type = Literal["apple", "orange"]

def func(var_type: var_type) -> None:
    print(f"This is the {var_type}")

fruit = "apple"
func(fruit)  # mypyエラーが発生

上記のコードをmypyでチェックすると以下のようなエラーが発生します。

error: Argument 1 to "func" has incompatible type "str"; expected "Literal['apple', 'orange']"  [arg-type]

fruitはappleが格納されており、Literalの中身と一致しているため一見問題なさそうです。しかしfruit事態の型はstrであるためにmypyのチェックに引っかかってしまいます。

解決策

この問題を解決するための方法をいくつか検討しました。

1. `TypeGuard`を使ったチェック関数の導入

Python 3.10以降ではTypeGuardを使用して、変数がリテラルのいずれかの値であるかを動的にチェックできます。これにより、動的な型チェックが可能になり、エラー処理が柔軟に行えます。ただし、チェック関数が必要となり、コード量が増加するというデメリットもあります。

from typing import Literal, TypeGuard

var_type = Literal["apple", "orange"]

def is_var_type(value: str) -> TypeGuard[var_type]:
    return value in ("apple", "orange")

def func(var_type: var_type) -> None:
    print(f"This is the {var_type}")

fruit = "apple"

if is_var_type(fruit):
    func(fruit)  # エラーなし
else:
    print("Invalid fruit type")

2. `Annotated`で型情報を追加する

Python 3.9以降で使用できるAnnotatedを用いて、str型でありながら特定のリテラル値だけを許可する型を定義できます。

from typing import Literal, Annotated

VarType = Annotated[str, Literal["apple", "orange"]]

def func(var_type: VarType) -> None:
    print(f"This is the {var_type}")

fruit = "apple"  # 事前に値の検証を行うと安全

func(fruit)  # mypyでのエラーは発生しない

3. `Final`を使う

変数にFinalを使用すると、変更不可の定数として宣言でき、mypyエラーを回避できます。

from typing import Final, Literal

var_type = Literal["apple", "orange"]


def func(var_type: var_type) -> None:
    print(f"This is the {var_type}")


fruit: Final = "apple"
func(fruit)

4.別ファイルで型定義を行い、インポートして使用

型を別ファイルに定義しておくと、再利用性が高まり、型管理が簡潔になります。

type.py

from typing import Literal

VarType = Literal["apple", "orange"]

main.py

from .types import VarType

def func(var_type: VarType) -> None:
    print(f"This is the {var_type}")

fruit:VarType = "apple"
func(fruit)  # エラーなし

それぞれの方法ごとの利点・欠点のまとめ

方法	利点	欠点
TypeGuardを使う	・動的な型チェックが可能・エラーハンドリングの柔軟性が向上	・チェック関数の追加でコードが長くなる
Annotatedを使う	・型ヒントが簡潔に	・mypyのサポートが不完全な場合がある・型チェックが不十分な場合がある
Finalを使う	・定数としての意味合いが明確・mypyの型チェックが簡単に通る	・動的な値に適用が難しい・他の用途には適さない
別ファイルで型定義	・型の再利用性が向上・大規模プロジェクトで保守しやすい	・小規模プロジェクトでのオーバーヘッド・型定義用のインポートが必要

まとめ

どの方法が適切かは、プロジェクトの規模や求める柔軟性に依存します。選択肢の中から最適な方法を見つけることで、型ヒントを活用し、コードのロバスト性を高めることができるでしょう。これらの方法を使いこなせるようになりたいですね。