学ぶ¶

この Tutorial - User Guide で、Typer の使い方をステップごとに学びましょう。

最もシンプルなスクリプト から 複雑な CLI アプリケーション まで、必要なことを一通りカバーしています。

このドキュメントは Typer を学ぶための公式かつ推奨の方法だと考えてよいでしょう。 😎

Python の型¶

Python の型ヒントの使い方をあらためて確認したい場合は、FastAPI の Python types intro の前半を参照してください。

mypy cheat sheet も確認できます。

要するに（本当に簡単に言うと）、次のようにパラメータ付きの関数を宣言できます。

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

✨ ここで魔法が起こります ✨

コードは実際に自分で書くかコピーして、編集し、ローカルで動かしてみることを 強くおすすめ します。

エディタで使ってみることで、どれだけ少ないコードで済むか、どのように インラインエラー や オートコンプリート などの恩恵を受けられるかが、Typer の本当の良さとして見えてきます。

そしてサンプルを実行することが、実際に何が起きているのかを理解するいちばんの助けになります。

ここにあるドキュメントをすべて読むよりも、いくつかの例を 実際に動かして 触ってみるほうが、ずっと多くを学べます。