チュートリアル - ユーザーガイド - イントロダクション

Pythonの型¶

Pythonの型ヒントの使い方について復習が必要な場合は、FastAPIのPython型イントロダクションの最初の部分をご覧ください。

簡単に言うと（非常に簡単に）、次のようなパラメータを持つ関数を宣言できます。

from typing import Optional

def type_example(name: str, formal: bool = False, intro: Optional[str] = None):
    pass

すると、エディタ（およびTyper）は次のことがわかります。

これらの型ヒントは、エディタでのオートコンプリートやその他の機能を提供します。

Typerはこれらの型ヒントに基づいています。

このチュートリアルでは、Typerのすべての機能を段階的に使用する方法を説明します。

各セクションは前のセクションに基づいて徐々に構築されますが、トピックを分離するように構成されているため、特定のCLIニーズを解決するために特定のセクションに直接移動できます。

また、将来の参考資料としても機能するように構築されています。

そのため、戻ってきて必要なものを正確に確認できます。

すべてのコードブロックはコピーして直接使用できます（テスト済みのPythonファイルです）。

いずれかの例を実行するには、コードをファイルmain.pyにコピーして実行します。

$ python main.py

✨ The magic happens here ✨

コードを書いてコピーし、編集してローカルで実行することを強くお勧めします。

エディタでそれを使用することで、Typerの利点、記述するコードの少なさ、すべての型チェック、オートコンプリートなどが実際にわかります。

また、例を実行することで、何が起こっているのかを本当に理解するのに役立ちます。

ここでドキュメントをすべて読むよりも、いくつかの例を実行して試してみることで、はるかに多くのことを学ぶことができます。

最初のステップは、Typerをインストールすることです。

$ pip install typer
---> 100%
Successfully installed typer click shellingham rich

デフォルトでは、typerにはrichとshellinghamが含まれています。

注記

上級ユーザーで、これらのデフォルトの追加依存関係をオプトアウトしたい場合は、代わりにtyper-slimをインストールできます。

pip install typer

...には、次のようなオプションの依存関係が含まれています。

pip install "typer-slim[standard]"