フューチャー技術ブログ

2021年版Pythonの型ヒントの書き方 (for Python 3.9)

Pythonに型ヒントが入ってからしばらく経ちます。型ヒントの立ち位置も、なんでもできるアノテーションとして導入されましたが、型ヒント以外の用途はあまり育たず、型ヒントが中心になり、PEPや仕様もそれに合わせて変化したり、より書きやすいように機能が追加されてきました。

本エントリーでは、Python 3.9時点での最新情報を元に、現在サポート中のPythonバージョン(3.6以上)との互換性の情報も織り交ぜながら、最新の型ヒントの書き方を紹介します。

本エントリーの執筆には、Pythonの型の有識者の@moriyoshi@aodag@tk0miya にアドバイスをもらいました。ありがとうございます。

環境構築

Visual Studio Code

Visual Studio Codeの場合は、事前にどのインタプリタを利用するかを設定しておきます。その環境にインストールします。venvを使うにはvenvPathを設定します。

.vscode/settings.json
1
2
3
{
"python.venvPath": "${workspaceFolder}/.venv"
}

mypyを有効にします。デフォルトの動作だと、型付けをしていない関数内部のチェックがされないので、--check-untyped-defsをつけたり、より厳しい--strictをつけたりすると良いでしょう。

.vscode/settings.json
1
2
3
4
5
6
7
8
9
10
{
"python.linting.mypyEnabled": true,
"python.linting.enabled": true,
"python.linting.mypyArgs": [
"--ignore-missing-imports",
"--follow-imports=silent",
"--show-column-numbers",
"--check-untyped-defs" // 追加
]
}

必要な追加パッケージのインストールが実行されますが、3.9特有の機能はまだPyPIにリリースされている安定板の0.790では対応していません。masterブランチにはいくつかの機能が実装済みなので、0.800リリースまでは最新の開発版をインストールしましょう。

1
2
3
4
$ git clone https://github.com/python/mypy.git
$ cd mypy
$ git submodule --update init
$ python setup.py install

PyCharm

PyCharmはPythonインタプリタ(IntelliJ IDEA Ultimateを使っている場合はSDK設定で追加)の設定をすればmypyのインストールは不要です。

IntelliJ IDEA Ultimateを使っている場合はSDK設定で追加の様子

変数の型の型付け

変数名の後ろにコロンと型を付与することで型をつけられます。

変数の型付け
1
2
3
4
5
i_love_python: bool = True

# 代入を後回しにしてもよい
i_love_python: bool
i_love_python = True

以前はPythonのコメントの中に記入していましたが、Python 3.5はすでにEOLなので、PyPIで配布されるライブラリ開発者ももう上記の書き方に統一しても問題ないでしょう。

古い書き方
1
2
# Python 3.5以前の書き方
i_love_python = True # type: bool

関数やメソッドの型付け

関数やメソッドは引数リストと返り値の情報を付与できます。返り値がない場合は-> None(あるいはtyping.NoReturn)をつけます。

関数の型付け
1
2
3
4
5
6
7
8
def greeting(name: str) -> str:
return f'Hello Guido, my name is {name}'

greeting(10) # エラー

# 返り値がない場合は-> Noneをつける
def show_python_version() -> None:
print(sys.version)

mypyは--check-untyped-defsオプションが付与されていない場合、-> Noneが付いてない関数は型付けされていないとみなしてエラーチェックしません。返り値がない関数でも忘れずにつけるようにしましょう。PyCharmであれば警告は表示されます。

1
2
3
# mypyは返り値宣言されてない関数の中のエラーはチェックしない
def main():
greeting(10) # エラーにならない

ユーザー定義クラスの型つけ

クラスは乱暴にいってしまえば、変数と関数を固めたものであるので、これまで説明してきた要素でほぼ説明できます。

クラスの型付け
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
class UnidentifiedMysteriousAnimal:
"""
未確認生物クラス
"""

name: str = "unknown" # デフォルト値
country: str
year: int

def __init__(self, name: str, country: str, year: int) -> None:
self.name = name
self.country = country
self.year = int

killerRabbit = UnidentifiedMysteriousAnimal("殺人ウサギ", "Great Britain", 1975)

なお、クラス変数を設定するには、 typing.ClassVarを利用します。

1
2
3
4
from typing import ClassVar

# classの中にこれを追加
joke: ClassVar[bool] = true

あらゆる型を受け付けるAny

型のある言語にはたいてい「あらゆる型のインスタンスを保持できるany型」があります。Pythonにもtyping.Anyがあります。もちろん、なるべく静的に型を決めていき、Anyが登場しないに越したことはないのですが、外部からやってくる情報をハンドリングするときなど、どうしても必要な``ことがあります。

1
2
3
from typing import Any

user_input: Any

型よりも厳しく、特定の文字列や数値のリテラルのみを許可する

型ヒントというと、変数に代入できるオブジェクトの型を限定することが想像されますが、「文字列」ではなくて、「特定の文字列」、「数値」ではなく、「特定の数値」など、特定のリテラルのみを保持できる制約を与えることができます。これにより、他の言語のenumのようなことが実現できます。

これはPython 3.8以降のみ対応していますが、PyPIのtyping-extensionsパッケージを利用すれば以前のバージョンでも利用できます。

リテラル
1
2
3
4
5
6
7
8
9
10
11
12
13
# Python 3.6, 3.7はpip install typing-extensionsが必要
try:
from typing import Literal
except ImportError:
from typing_extensions import Literal

train_type: Literal['各駅停車', '準急', '急行']

# この文字列は許可されているのでOK
train_type = '準急'

# この文字列は許可されていないのでエラー
train_type = '超特急'

ジェネリクス

リストや集合の型付けを行うには、次のように型名[要素の型]、辞書はdict[キーの型, 値の型]など、ブラケットで型変数の設定を行います。mypyは現在リリースされている0.790ではこの書き方はできないので、0.800の開発版が必要です。

Python3.7以降の書き方
1
2
3
4
# Python 3.9以降のみであればこの行は不要
from __future__ import annotations

my_favorite_pokemons: list[str] = ["フォッコ", "ルカリオ"]

Python 3.8以前はこのような書き方はできず、typingパッケージのものを利用していました。Python 3.9ではこの書き方はdeprecatedになります。Python 3.7とPython 3.8はfrom __future__ import annotationsを先頭に記述すれば使えるようになります。2021年12月がEOLのPython 3.6は__future__を使った回避はできないため、Python 3.6をサポートするのであれば(広く公開するライブラリの場合など)、こちらの書き方が必要です。

Python3.6もサポートする場合の書き方
1
2
3
from typing import List

my_favorite_pokemons: List[str] = ["フォッコ", "ルカリオ"]

https://www.python.org/dev/peps/pep-0585/#implementation

新と旧で使うべきジェネリック型定義がどこにあるかは上記のPEPにまとまっています。大雑把にいえば、以前はtypingパッケージがそのすべてを担っていましたが、Python 3.9以降は次のように各パッケージに分散されています。

  • 実際にオブジェクトとして使う型そのものであれば、その型定義をそのまま利用
    • リスト、タプル、辞書などの__builtins__の要素であれば、listtupledictなど
    • collectionsパッケージの各クラスであれば、collections.dequeなど
  • iterable、callableなどのPythonのプロトコル関係はcollections.abc以下
  • コンテキスト関係はcontextlib、正規表現はre

例えば、コールバック用にcallableオブジェクトを関数引数に渡したり、インスタンス変数に保存したいとします。この場合は関数を受け取れる宣言は次のようにcollections.abc.Callableを使って書きます。型パラメータの最初は引数の型のリスト、後者は返り値です。

callableな引数の設定
1
2
3
4
import collections
from collections.abc import Callable

def wait_callback(cb: Callable[[str], None]) -> None:

古い環境はtyping.Callableを代わりに使います。

古い書き方
1
2
3
from typing import Callable

def wait_callback(cb: Callable[[str], None]) -> None:

コレクションの種類の使い分け

collections.abcには多数の型があります。今までのコーディングで、これらを細かく区別して利用することは基本的になかったと思いますが、型付けを行うにあたっては、なるべく制約(メソッド)の少ないコレクションを選択する方がポータビリティが上がります。次の図はcollections.abcおよび組み込み型のシーケンスの継承関係(実装上の継承ではなく、メソッドの包含で定義した)の図です。左に行くほど、少ないメソッドを持っており、右側に行くほど、メソッドが多くなります。関数の中で使用しているメソッドを見て、なるべくこの図の左側にある型を選んで使うと良いでしょう。

collections.abcおよび組み込み型のシーケンスの継承関係

例えば、関数の中で引数のシーケンスに対して、forでループを回すだけの使い方をするならばcollections.abc.Iterableを、さらにinで存在確認をする必要があれば、Collectionを使うと、さまざまなシーケンスのインスタンスを受けて利用できるようになります。ランダムアクセスが必要であればSequenceを使います。値の変更が必要であればMutableがついた型を利用します。

例えば、引数の型を安易にlistを指定してしまうと、setdictを渡せなくなります。特に慣れているからといって安易に具象型(リスト、タプル、辞書、集合)を設定しない方が良いです。といっても、これらの具象型を使う方が理解はしやすいと思うので、まずはこの具象型を当てはめてみて、使う演算子やメソッドが少なくても済むことをを確認したら、少しずつ左側の型に寄せていくと良いかもしれません。

タプルと他のシーケンスの違い

タプルは長さ情報まで固定ですので、要素数分、型を指定します。tuple[int, str, float]など、型を混ぜて指定もできます。一方、リストなどのシーケンスは要素内の全要素が同じ制約になります。1要素だけ設定すればシーケンスの長さによらず、利用できます。

1
2
3
4
5
6
7
8
9
10
# Python 3.9の例

# 要素数があっているのでOK
t1: tuple[str, str, str] = ("空飛ぶ", "モンティ", "パイソン")

# こちらはあっていないのでNG
t2: tuple[str] = ("Monty", "Python's", "Flying", "Circus")

# リストは全要素が同じ型。1つだけ型定義すれば長さは自由
l: list[str] = ["Monty", "Python", "and", "the", "Holy", "Grail"]

タプルで同じ型の要素を任意長持つインスタンスに適合する型を書くには、ellipsis演算子(...)を使います。

1
t: tuple[str, ...] = ("Monty", "Python's", "Flying", "Circus")

合併型(Union Type) / オプショナル

引数の型は常に1種類だけ、とは限りません。条件によって文字列や数字の両方を受け入れる関数を作りたいこともあります。

Python 3.10では文字列でも数字でもいい、という条件は次のように|を使って書きます。この記法も、mypy 0.790では対応せず、mypyのmasterブランチ版のインストールが必要です。

合併型
1
def normalize_year(year: int | str) -> int:

Python 3.7から3.9であれば、from __future__ import annotationsを記述すればこの記法が使えるようになります。

Python 3.6もサポートしたい場合は、旧式のtyping.Unionを利用して書きます。

古い書き方
1
2
3
from typing import Union

def normalize_year(year: Union[int, str]) -> int:

合併型は同じ型のまま受け入れてくれる関数にそのまま渡す以外は、型を分解しなければ利用できません。isinstance()などで型のチェックを行うと、その条件を見て、ブロック内の型を絞ってくれます。

ロジック内で型を分離
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
def normalize_year(year: int | str) -> int:
if isinstance(year, int):
# ここではyearは数値
return year
else:
# ここではyearは文字列
if year.startswith("昭和"):
return int(year[2:]) + 1925
elif year.startswith("平成"):
return int(year[2:]) + 1988
elif year.startswith("令和"):
return int(year[2:]) + 2018
raise ValueError('unsupported style')

print(normalize_year('昭和55'))

合併型の1つの形として他の言語でいうnullable(未初期化がありえる)のような概念を表現するために、typing.Optionalが提供されています。これはNoneとの合併型と等価です。

Optionalの定義
1
2
3
4
5
6
7
8
from typing import Optional

age: Optional[int]
age = 18 # 数値を入れることもできる
age = None # 年齢未回答も選択可能

# こうも書ける
age: int | None

キャスト

合併型やAnyなど、型が一意に決まらない変数のうち、状況から、特定の型である確信がある場合、キャストを使って特定の型であると処理系に伝える方法が提供されています。本来なら、ifの条件分岐などを行う方法の方が実際の変数の値を見ての判断になりますが、緊急的な脱出ハッチとして利用可能です。

キャスト
1
2
3
4
5
6
from typing import cast

r = httpx.get('https://api.example.com')
if r.status_code == 200:
# Anyからdict[str, str]に変換
res = cast(dict[str, str], r.json())

関数のオーバーロード

複数の関数で、入力の型、および返り値の型が異なる関数を作りたいとします。その時に使うのがオーバーロードです。次の例は、画面表示のときの文字数を計算する関数です。入力の型のバリエーションが増える場合は合併型で対応できますし、返り値も合併型で書くことで、雑に対応は可能ですが、入力値の型によって返り値が決定される(例えば、boolの時はboolしか返らない)ことを表現するためにはオーバーロードを使う必要があります。

  • @overloadを付与したスタブ定義を並べて書く。これはmypyなどの型チェック用の情報提供のためだけのもので、Pythonで実際には実行されるときは上書きされて消えるだけなので、実装はellipse演算子(...)やpassでよい
  • 最後に@overloadがつかない実際の実装を書く。これは入出力はオーバーロードしたすべてを受け入れる必要があるのでAnyを使うか、型を付けないで実装(mypyオプションに--strictをつけるとこれはエラーになるが)のどちらかで実装

次の関数は、JSON化にあたっての前処理を行う関数です。例えば、JavaScriptは2**53を超える数値は浮動小数点数になってしまうので、規格上は制約はないが実装的にintは入れられないものが多いのでfloat変換するようにしています。

関数のオーバーロード
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# JSONに出力するのに安全な形式に変換

@overload
def json_safe(i: str) -> str:
...

@overload
def json_safe(i: bytes) -> str:
...

@overload
def json_safe(i: bool) -> bool:
...

@overload
def json_safe(i: int) -> Union[int, float]:
...

@overload
def json_safe(i: float) -> float:
...

def json_safe(i: Any) -> Any:
if isinstance(i, (str, bool, float)):
return i
elif isinstance(i, int):
if i >= 2 ** 53:
return float(i)
return i
else:
raise ValueError(f'length only support str and int, but {type(i)}')

まとめ

ここ数年、バージョンアップのたびに大きく改善されてきた型ヒント。今回の3.9でも大きな変化がありました。一部、from __future__を使わないと3.10未満では使えない機能もありました。3.10でもさらに進展予定です。

ここでは紹介していない、細かい機能もいくつかあります。より詳細な情報はtypingパッケージや、関連PEPを見ると書かれています。

また、mypyのサイトにあるcheatsheetも参考になると思います。