Python の型ヒント（Type Hint）　Literalとは？

2024年6月8日2024年6月17日

Literal は Python の型ヒント（Type Hint）の一種であり、特定の値のリテラルを型として指定するために使用されます。Literal を使うことで、関数やメソッドの引数が取りうる値を明示的に指定することができます。

通常、Literal は文字列や整数などのリテラル値を使って型を指定します。たとえば、Literal['foo', 'bar'] は文字列型であり、’foo’ または 'bar’ のいずれかを取ることができる型を表します。

例えば、次のように関数の引数に Literal を使用することができます：

python
from typing import Literal

def example_func(value: Literal['foo', 'bar']) -> None:
    print(value)

# 'foo' または 'bar' のいずれかを渡す
example_func('foo')  # OK
example_func('bar')  # OK

# 'baz' を渡すとエラーになる
example_func('baz')  # TypeError: example_func() argument must be 'foo' or 'bar'

Literal を使うことで、関数やメソッドの引数が特定の値を取ることが期待される場合に、その制約をより明示的に指定することができます。