PEP561についてのメモ

https://peps.python.org/pep-0561/
PEP561 ではパッケージに型ヒント情報を組み込んで配布するための方法を定義している。

https://blog.ymyzk.com/2018/09/creating-packages-using-pep-561/

• パッケージに型ヒント情報を持たせて配布し、型チェックを可能にしたい場合、 py.typed というマーカーファイルが必要。
• マーカーファイルはパッケージに型ヒントを含めることを表し、再帰的にサブパッケージにも適用される。その為、トップ階層に配置しているケースが見られる。
  • (例)
    • https://github.com/pallets/flask/blob/main/src/flask/py.typed
    • https://github.com/tiangolo/fastapi/blob/master/fastapi/py.typed

PEP561に従うと以下のようなパッケージが作成可能。

• 型ヒント情報も含んだ状態のパッケージ
• 他のパッケージに対する型ヒント情報だけを含むパッケージ（スタブパッケージ）
  • 例えば、numpy に対する numpy-stabs

型ヒント情報も含んだ状態のパッケージ

• モジュールのトップの階層に py.typed を配置

project_root_directory
├── pyproject.toml
└── src
    └── mypkg
        ├── __init__.py
        └── py.typed

• パッケージングに Setuptools を使う場合は pyproject.toml に以下のように記述
  • Poetry や Flit を使う場合は、自動的に検出されるので特別な指定は不要

[tool.setuptools.package-data]
mypkg = ["py.typed"]