Python Typer によるコマンドを作成するためのガイド

2年 ago
桜, 春樹
1 minute

Python Typer は、対話型の CLI ツールを作成したり、CLI 向けインターフェイスを構築するのに役立つ、Python 製の CLI 作成フレームワークです。Python Typer を使い始めるための簡単なガイドを用意しましたので、ご覧ください。

  1. Python Typerのインストール：
pip install typer
  1. main.py などの新しい Python ファイルを作成します。
  2. typer モジュールをインポートします：
import typer
  1. アプリケーションインスタンスを作成する。
app = typer.Typer()
  1. コマンドライン関数を作成します：
@app.command()
def hello(name: str):
typer.echo(f"Hello, {name}!")

この例では、hello というコマンドライン関数を作り、この関数は name パラメーターを受け取り Hello, ! と出力します。

  1. アプリを実行する：
if __name__ == "__main__":
app()

このやり方では、コマンドラインパーサーを使用してアプリを実行します。

  1. コマンドラインでアプリケーションを使用する
python main.py hello --name World

これは「Hello, World!」を出力します。

Python Typer の用途は基本的な使用方法だけではなく、サブコマンド、オプション引数、型アノテーションなど、他にも多くの機能とオプションがあります。詳細については、公式ドキュメントを参照してください: https://typer.tiangolo.com/

bannerAds