オプション解析モジュールTyperを使いこなそう

Typer について

TyperはFastAPIマイクロフレームワークの作者が Click を利用したオプション解析処理をしてくれる拡張モジュールです。

Click がデコレータでオプション解析処理の指示を与えるのに対して、Typer は変数のタイプヒントを利用して定義するため、より簡潔な記述となるのが特徴です。

そのため、Python 3.6 以降が必要になります。

typer は拡張モジュールなのでインストールする必要があります。

code: pip

$ pip install typer

typerの実装方法

typer を組み込んだコマンドの実装には次の２つの方法があります。

typer.run() から呼び出す方法

code: helloworld1.py

import typer

def hello_world():

typer.echo('Hello World')

if __name__ == "__main__":

typer.run(hello_world)

アプリケーションインスタンスに登録して呼び出す方法

詳しくは後述しますが、サブコマンドを持たせたいときは、複数のファイルにまたがるような場合に使用します。

code: helloworld2.py

import typer

app = typer.Typer()

@app.command("hello")

def hello_world():

typer.echo('Hello World')

if __name__ == "__main__":

app()

code: bash

% python helloworld2.py --help

Options:

--install-completion Install completion for the current shell.

--show-completion Show completion for the current shell, to copy it or

customize the installation.

--help Show this message and exit.

両方とも出力は同じになります。

code: helloworld3.py

import typer

app = typer.Typer(add_completion=False)

@app.command("hello")

def hello_world():

typer.echo('Hello World')

if __name__ == "__main__":

app()

code: bash

% python helloworld3.py --help

Options:

--help Show this message and exit.

typer.echo()

code: echo.py

import typer

def cmd():

typer.echo("This message oputput to stdout.")

typer.echo("This message oputput to stderr.", err=True)

if __name__ == '__main__':

cmd()

code: zsh

% python echo.py

This message oputput to stdout.

This message oputput to stderr.

% python echo.py 2>/dev/null

This message oputput to stdout.

typer.style()

typer.sytle(text, fg, bg, bold, dim, underline, blink, reverse, reset)

text: 任意の文字列

fg: 前景色/文字の色 ('red', 'green', 'yellow'など)

bg: 背景色

bold: ボールド表示

dim: 薄暗く表示する

underline: アンダーライン表示

blink: 点滅表示

reverse: 前景色、背景色の反転

reset: 設定のリセット、False にすると設定を引き継ぐ

code: style.py

import typer

def cmd():

typer.echo(typer.style('Hello World.',

fg='green', bg='red', reset=False))

typer.echo(typer.style('Hello Again.'))

if __name__ == '__main__':

cmd()

typer.launch()

次の例はブラウザでURLをオープンします。

code: launch.py

import typer

def open_google():

typer.echo("Opening Google...")

if __name__ == "__main__":

typer.run(open_google)

次のようにすると設定ファイルをオープンするような処理になります。

code: launch2.py

from pathlib import Path

import typer

APP_NAME = "typer_tutorial"

def main():

app_dir = typer.get_app_dir(APP_NAME)

app_dir_path = Path(app_dir)

app_dir_path.mkdir(parents=True, exist_ok=True)

config_path: Path = Path(app_dir) / "config.json"

if not config_path.is_file():

config_path.write_text('{"version": "1.0.0"}')

config_file_str = str(config_path)

typer.echo("Opening config directory")

typer.launch(config_file_str, locate=True)

if __name__ == "__main__":

typer.run(main)

XCodeがインストールされているMacでは、

Xcode がファイルをオープンします。

オプション解析

code: greeting.py

import typer

def hello(count: int = typer.Option(1, '-C', '--count',

help='Number of greetings.'),

name: str = typer.Option(..., prompt='Your Name: ',

help='The person to greet.'),

):

"""COUNTで与えた回数だけHelloする"""

for x in range(count):

typer.echo(f'Hello {name}')

if __name__ == '__main__':

typer.run(hello)

code: bash

$ python greeting.py --help

COUNTで与えた回数だけHelloする

Options:

Install completion for the specified shell.

Show completion for the specified shell, to

copy it or customize the installation.

--help Show this message and exit.

$ python greeting.py --name David

Hello David

$ python greeting.py -C 2

Your Name: Freddie

Hello Freddie

Hello Freddie

関数に記述した docstrings がヘルプ表示のときに使用されます。

パスワード入力の処理をしたい

code: optpassword.py

import typer

def cmd(password: str = typer.Option(...,

prompt='Password',

hide_input=True,

confirmation_prompt=True)

):

typer.echo( password )

if __name__ == '__main__':

typer.run(cmd)

オプションをフラグとして処理したい

code: optflag.py

import typer

def cmd(debug: bool = typer.Option(False,hidden=True

help='DEBUG mode'),

force: bool = typer.Option(False, '--force',

help='Force option')

):

typer.echo( f'debug: {debug}')

typer.echo( f'force: {force}')

if __name__ == '__main__':

typer.run(cmd)

code: bash

% python optflag.py --help

Options:

--install-completion Install completion for the current shell.

--show-completion Show completion for the current shell, to copy it or

customize the installation.

--help Show this message and exit.

% python optflag.py --debug

debug: True

force: False

% python optflag.py --no-debug

debug: False

force: False

% python optflag.py --force

debug: False

force: True

% python optflag.py --no-force

Try 'optflag.py --help' for help.

Error: no such option: --no-force

フラグオプションの文字列を変更したい

code: option_alterante.py

from typing import Optional

import typer

if accept is None:

typer.echo("I don't know what you want yet")

elif accept:

typer.echo("Accepting!")

else:

typer.echo("Rejecting!")

if __name__ == "__main__":

typer.run(main)

code: bash

% python option_alternate.py --help

Options:

--accept / --reject

--install-completion Install completion for the current shell.

--show-completion Show completion for the current shell, to copy it or

customize the installation.

--help Show this message and exit.

% python option_alternate.py --accept

Accepting!

% python option_alternate.py --reject

Rejecting!

% python option_alternate.py

I don't know what you want yet

オプションのプレフィックスを変更したい

code: option_prefix.py

import typer

def cmd(writable: bool = typer.Option(False, '+w/-w')):

typer.echo( f'writable: {writable}' )

if __name__ == '__main__':

typer.run(cmd)

code: bash

% python option_prefix.py --help

Options:

--install-completion Install completion for the current shell.

--show-completion Show completion for the current shell, to copy it or

customize the installation.

--help Show this message and exit.

% python option_prefix.py

writable: False

% python option_prefix.py -w

writable: False

% python option_prefix.py +w

writable: True

フラグオプションを与えたときだけFalseとして扱わせたい

フラグオプションを与えたときだけFalse となるようにするためには次のように定義します。

code: option_false.py

import typer

def main(in_prodaction: bool = typer.Option(True, " /--demo", " /-d")):

if in_prodaction:

typer.echo("Running in production")

else:

typer.echo("Running demo")

if __name__ == "__main__":

typer.run(main)

code: bash

% python option_false.py --help

Options:

--install-completion Install completion for the current shell.

--show-completion Show completion for the current shell, to copy it or

customize the installation.

--help Show this message and exit.

% python option_false.py --demo

Running demo

% python option_false.py -d

Running demo

% python option_false.py

Running in production

オプション引数の数を指定する

code: python

import typer

from typing import Tuple

help="Geometory: x y")):

typer.echo( position )

if __name__ == '__main__':

typer.run(cmd)

code: bash

$ python optmultiargs.py -P 1

Error: -P option requires 2 arguments

$ python optmultiargs.py -P 1 2

(1, 2)

$ python optmultiargs.py -P 1 2 3

Try 'optmultiargs.py --help' for help.

Error: Got unexpected extra argument (3)

同じオプションを複数回指定することを許す

オプションは複数回指定することができるようになります。デフォルトでは、同じオプションが複数回与えられた場合は、最後に与えられたオプションが有効になります。

code: multiopt.py

import typer

from typing import List

typer.echo( name )

if __name__ == '__main__':

typer.run(cmd)

code: bash

$ python　multiopts.py -N Beer -N Wine

('Beer', 'Wine')

オプションが指定された回数を知りたい

code: option_count.py

import typer

def cmd(verbose: int = typer.Option(0, '-v', '--verbose',

count=True,

help="Verbosly Mode")):

typer.echo(f'verbose level: {verbose}')

if __name__ == '__main__':

typer.run(cmd)

code: bash

$ python option_count.py

verbose level: 0

$ python option_count.py -v

verbose level: 1

$ python option_count.py -v -v

verbose level: 2

$ python click_optcount.py -vvvv

verbose level: 4

コマンド引数を処理したい

code: arguments.py

from typing import List

import typer

dst: str = typer.Argument(...)

):

"""Move file SRC to DST."""

for filename in src:

typer.echo(f'move {filename} to folder {dst}')

if __name__ == '__main__':

typer.run(copy)

code: bash

% python arguments.py

Try 'argument.py --help' for help.

Error: Missing argument 'SRC...'.

% python arguments.py --help

Move file SRC to DST.

Arguments:

Options:

--install-completion Install completion for the current shell.

--show-completion Show completion for the current shell, to copy it or

customize the installation.

--help Show this message and exit.

% python arguments.py a b c d

move a to folder d

move b to folder d

move c to folder d

typer はタイプヒントの対象となる変数名や型からをヘルプメッセージを生成します。

code: argument_metavar.py

from typing import List

import typer

dst: str = typer.Argument(..., metavar='DESTINATION')

):

"""Move file SOURCES to DESTINATION."""

for filename in src:

typer.echo(f'move {filename} to folder {dst}')

if __name__ == '__main__':

typer.run(copy)

code: bash

% python artument_metavar.py --help

Move file SOURCES to DESTINATION.

Arguments:

Options:

--install-completion Install completion for the current shell.

--show-completion Show completion for the current shell, to copy it or

customize the installation.

--help Show this message and exit.

終了処理

code: terminate.py

import typer

def abort_cmd():

raise typer.Abort()

def exit_cmd():

raise typer.Exit()

action = {

'exit': exit_cmd,

'abort': abort_cmd,

}

def cmd(subcmd: str = typer.Argument(...)):

if subcmd in action.keys():

typer.echo(f'subcmd: {subcmd}')

else:

typer.echo(f'Unknown subcommand: {subcmd}')

if __name__ == '__main__':

typer.run(cmd)

code: bash

% python terminate.py --help

Arguments:

Options:

--install-completion Install completion for the current shell.

--show-completion Show completion for the current shell, to copy it or

customize the installation.

--help Show this message and exit.

% python terminate.py exit

subcmd: exit

% python terminate.py abort

subcmd: abort

Aborted!

パラメタを限定させたい

code: choice.py

from enum import Enum

import typer

class HashType(str, Enum):

md5 = "md5"

sha1 = "sha1"

sha256 = "sha256"

def main(hash_type: HashType = HashType.md5):

typer.echo(f"Hash Type: {hash_type.value}")

if __name__ == "__main__":

typer.run(main)

code: bash

% python choice.py --help

Options:

--install-completion Install completion for the current shell.

--show-completion Show completion for the current shell, to

copy it or customize the installation.

--help Show this message and exit.

% python choice.py --hash-type sha256

Hash Type: sha256

% python choice.py --hash-type sha

Try 'choice.py --help' for help.

Error: Invalid value for '--hash-type': invalid choice: sha. (choose from md5, sha1, sha256)

パラメタの数値範囲を指定したい

code: validate_range.py

import typer

def main(

id: int = typer.Argument(..., min=0, max=1000),

age: int = typer.Option(20, min=18),

score: float = typer.Option(0, max=100, clamp=True),

):

typer.echo(f"ID is {id}")

typer.echo(f"--age is {age}")

typer.echo(f"--score is {score}")

if __name__ == "__main__":

typer.run(main)

code: bash

$ python validate_range.py --help

Arguments:

Options:

--install-completion Install completion for the current shell.

--show-completion Show completion for the current shell, to copy it or

customize the installation.

--help Show this message and exit.

$ python validate_range.py 5 --score 200

ID is 5

--age is 20

--score is 100

パラメタとしてUUIDを扱いたい

code: myuuid.py

from uuid import UUID

import typer

def main(user_id: UUID):

typer.echo(f"USER_ID is {user_id}")

typer.echo(f"UUID version is: {user_id.version}")

if __name__ == "__main__":

typer.run(main)

typer はユーザが与えた文字列がUUIDとして妥当かチェックしてくれます。

code: bash

% python myuuid.py --help

Arguments:

Options:

--install-completion Install completion for the current shell.

--show-completion Show completion for the current shell, to copy it or

customize the installation.

--help Show this message and exit.

% python uuid.py e6501a90-2a30-45aa-9a6f-bb2013264341

USER_ID is e6501a90-2a30-45aa-9a6f-bb2013264341

UUID version is: 4

% python uuid.py e6501a90-2a30-45aa-9a6f-bb201

Try 'uuid.py --help' for help.

Error: Invalid value for 'USER_ID': e6501a90-2a30-45aa-9a6f-bb201 is not a valid UUID value

パラメタに日時文字列を指定したい

code: mydatetime.py

from datetime import datetime

import typer

def main(start: datetime = typer.Option(...),

end: datetime = typer.Argument(

f'{datetime.today():%Y-%m-%d}'),

):

typer.echo(f'start: {start}')

typer.echo(f' end: {end}')

if __name__ == "__main__":

typer.run(main)

code: bash

% python mydatetime.py --help

%H:%M:%S]

Arguments:

Options:

--install-completion Install completion for the current shell.

--show-completion Show completion for the current shell, to

copy it or customize the installation.

--help Show this message and exit.

% python mydatetime.py --start '2000-10-02' '2020-12-02'

start: 2000-10-02 00:00:00

end: 2020-12-02 00:00:00

% python mydatetime.py --start '2000-10-02'

start: 2000-10-02 00:00:00

end: 2020-12-02 00:00:00

% python mydatetime.py --start '2000-15-33'

%H:%M:%S]

Error: Invalid value for '--start': invalid datetime format: 2000-15-33. (choose from %Y-%m-%d, %Y-%m-%dT%H:%M:%S, %Y-%m-%d %H:%M:%S)

デフォルトでは次の３つの日付指定を受け付けます。

%Y-%m-%d

%Y-%m-%dT%H:%M:%S

%Y-%m-%d %H:%M:%S

code: mydatetime_custom.py

rom datetime import datetime

import typer

def main(

):

typer.echo(f"Launch will be at: {launch_date}")

if __name__ == "__main__":

typer.run(main)

code: bash

% python mydatetime_custom.py --help

Arguments:

Options:

--install-completion Install completion for the current shell.

--show-completion Show completion for the current shell, to copy it or

customize the installation.

--help Show this message and exit.

% python mydatetime_custom.py 2020/12/25

Launch will be at: 2020-12-25 00:00:00

% python mydatetime_custom.py 2020-12-25

パラメタを環境変数でも指定できるようにしたい

code: argument_envvar.p

from pathlib import Path

import typer

def cmd(name: str = typer.Argument('anonymous',

envvar='USERNAME',

show_envvar=False),

config: Path = typer.Option('config.ini',

envvar='CONFIG_FILE')

):

if config.is_file():

text = config.read_text()

typer.echo(f"Config file contents: {text}")

else:

typer.echo(f"Config file missing: {config.name}")

typer.echo(f"Hello: {name}")

if __name__ == '__main__':

typer.run(cmd)

code: bash

% python argument_envvar.py --help

Arguments:

Options:

--install-completion Install completion for the current shell.

--show-completion Show completion for the current shell, to copy it or

customize the installation.

--help Show this message and exit.

% python argument_envvar.py Jack

Config file missing: config.ini

Hello: Jack

% python artument_envvar.py --config=data.txt Jack

Config file contents: Python Osaka

Hello: Jack

% export CONFIG_FILE=data.json

% python artument_envvar.py Jack

Config file missing: data.json

Hello: Jack

% export USERNAME=David

% python artument_envvar.py Jack

Config file missing: config.json

Hello: Jack

パラメタをファイル名として扱いたい

code: argument_file.py

import typer

def cmd(srcfile: typer.FileText = typer.Argument(...)):

lines = srcfile.readlines()

for line in lines:

if __name__ == '__main__':

typer.run(cmd)

code: bash

% python argument_file.py --help

Arguments:

Options:

--install-completion Install completion for the current shell.

--show-completion Show completion for the current shell, to copy it or

customize the installation.

--help Show this message and exit.

% echo "Python Osaka" > data.txt

% python argument_file.py data.txt

Python Osaka

% python argument_file.py data.json

Try 'argument_file.py --help' for help.

Error: Invalid value for 'SRCFILE': Could not open file: data.json: No such file or directory

code: mypathlib.py

from pathlib import Path

from typing import Optional

import typer

if config is None:

typer.echo("No config file")

raise typer.Abort()

if config.is_file():

text = config.read_text()

typer.echo(f"Config file contents: {text}")

elif config.is_dir():

typer.echo("Config is a directory, will use all its config files")

elif not config.exists():

typer.echo("The config doesn't exist")

if __name__ == "__main__":

typer.run(main)

code:bash

% python mypathlib.py --help

Options:

--config PATH

--install-completion Install completion for the current shell.

--show-completion Show completion for the current shell, to copy it or

customize the installation.

--help Show this message and exit.

% python mypathlib.py --config data.txt

Config file contents: Python Osaka

% python mypathlib.py --config ./data.txt

Config file contents: Python Osaka

% python mypathlib.py --config data.json

The config doesn't exist

code: mypathlib_check.py

from pathlib import Path

import typer

def main(

config: Path = typer.Option(

...,

exists=True,

file_okay=True,

dir_okay=False,

writable=False,

readable=True,

resolve_path=True,

)

):

text = config.read_text()

typer.echo(f"Config file contents: {text}")

if __name__ == "__main__":

typer.run(main)

オプション解析時にコールバック関数を与えたい

code: option_callback1.py

from typing import Optional

import typer

__version__ = "0.1.0"

def version_callback(value: bool):

if value:

typer.echo(f"Awesome CLI Version: {__version__}")

raise typer.Exit()

def name_callback(name: str):

if name != "Freddie":

raise typer.BadParameter("Only Freddie is allowed")

def main(

name: str = typer.Option(..., callback=name_callback),

None, "--version",

callback=version_callback

),

):

typer.echo(f"Hello {name}")

if __name__ == "__main__":

typer.run(main)

code: bash

% python option_callback1.py --help

Options:

--version

--install-completion Install completion for the current shell.

--show-completion Show completion for the current shell, to copy it or

customize the installation.

--help Show this message and exit.

% python option_callback1.py --version

Awesome CLI Version: 0.1.0

これは、うまく動作しているように見えます。

code: bash

% python option_callback1.py --name Jack --version

Error: Invalid value for '--name': Only Freddie is allowed

code: option_callback2.py

from typing import Optional

import typer

__version__ = "0.1.0"

def version_callback(value: bool):

if value:

typer.echo(f"Awesome CLI Version: {__version__}")

raise typer.Exit()

def name_callback(name: str):

if name != "Freddie":

raise typer.BadParameter("Only Freddie is allowed")

def main(

name: str = typer.Option(..., callback=name_callback),

None, "--version",

callback=version_callback,

is_eager=True

),

):

typer.echo(f"Hello {name}")

if __name__ == "__main__":

typer.run(main)

code: bash

% python option_callback2.py --name Jack --version

Awesome CLI Version: 0.1.0

入力補完

Linux系プラットフォームや Bash on Windows では、シェルとして Bash や Zsh を使用することができます。

これらのシェルではタブキーによるコマンドラインの入力補完が行えるようになっています。

code: choice.py

from enum import Enum

import typer

class HashType(str, Enum):

md5 = "md5"

sha1 = "sha1"

sha256 = "sha256"

def main(hash_type: HashType = HashType.md5):

typer.echo(f"Hash Type: {hash_type.value}")

if __name__ == "__main__":

typer.run(main)

code: bash

% python choice.py --help

Options:

--install-completion Install completion for the current shell.

--show-completion Show completion for the current shell, to

copy it or customize the installation.

--help Show this message and exit.

code: bash

$ python choice.py --install-completion

bash completion installed in /Users/goichiiisaka/.bash_completions/choice.py.sh

Completion will take effect once you restart the terminal

code: zsh

% python choice.py --install-completion

zsh completion installed in /Users/goichiiisaka/.zfunc/_choice.py

Completion will take effect once you restart the terminal

ここでは プラットフォームが Mac で シェルは zsh を使っているものとして説明します。

次のように $HOME/.zshrc を定義しておけば動作するようになります。

code: $HOME/.zshrc

if type brew &>/dev/null; then

FPATH=$(brew --prefix)/share/zsh-completions:$FPATH

FPATH=$HOME/.zfunc:$FPATH

autoload -Uz compinit

compinit

fi

シェルのリセット

code: bash or zsh

$ exec $SHELL -l

あるいは、 typer コマンドに続けてコマンドを入力します。

typer コマンドはインストールする必要があります。

code: pip

$ pip install typer-cli

code: zsh

すると typer は次のように入力補完をしてくれます。

code: zsh

% typer choice.py run --hash-type

ここでもう一度タブキーを押下すると選択候補が表示されます。

code: zsh

md5 sha1 sha256

code: zsh

md5 sha1 sha256

code: zsh

% typer choice.py run --hash-type md5

md5 sha1 sha256

コールバック関数を使った入力補完

typer はパラメタの入力補完にコールバック関数を与えて処理することができます。

code: autocompletion1.py

import typer

def complete_name():

def main(

name: str = typer.Option("World",

autocompletion=complete_name,

help="The name to say hi to."

)

):

typer.echo(f"Hello {name}")

if __name__ == "__main__":

typer.run(main)

code: zsh

% typer autocompletion1.py run --help

Run the provided Typer app.

Options:

--help Show this message and exit.

次のようにコマンドラインを入力します。

code: zsh

typer は次のようにコマンドラインを補完します。

code: zsh

% typer autocompletion1.py run --name

David Freddie Jack

Dに続けてタブキーを入力します。

code: zsh

typer は次のようにコマンドラインを補完します。

code: zsh

% typer autocompletion1.py run --name David

David Freddie Jack

選択候補が表示されたときにタブキーを押下するたびに、選択候補が変わっていきます。

パラメタの選択候補にヘルプメッセージをつけたい

入力補完させるパラメタの選択候補にヘルプメッセージをつけたいような場合は、

code: autocompletion2.py

import typer

valid_completion_items = [

("Brian", "The guitarist."),

("Freddie", "The vocalist."),

("John", "The bass guitarist."),

("Roger", "The drummer."),

]

def complete_name(incomplete: str):

for name, help_text in valid_completion_items:

if name.startswith(incomplete):

yield (name, help_text)

def main(

name: str = typer.Option("World",

autocompletion=complete_name,

help="The name to say hi to."

)

):

typer.echo(f"Hello {name}")

if __name__ == "__main__":

typer.run(main)

これまでと同様にオプションに続けてタブキーを２度押下すると選択候補が表示されます。

code: zsh

Brian -- The guitarist.

Freddie -- The vocalist.

John -- The bass guitarist.

Roger -- The drummer.

これも、選択候補が表示されたときにタブキーを押下するたびに、選択候補が変わっていきます。

Bash ではパラメタの選択候補にヘルプメッセージをつけることができません。

対応可能なシェル： zsh, fish, PowerShell

他のパラメタの選択を参照したい

これまでは選択候補を持つパラメタが１つ、もしくは１度だけでした。

code: autocompletion3.py

from typing import List

import typer

valid_completion_items = [

("Brian", "The guitarist."),

("Freddie", "The vocalist."),

("John", "The bass guitarist."),

("Roger", "The drummer."),

]

def complete_name(ctx: typer.Context, incomplete: str):

names = ctx.params.get("name") or []

for name, help_text in valid_completion_items:

if name.startswith(incomplete) and name not in names:

yield (name, help_text)

def main(

autocompletion=complete_name,

help="The name to say hi to."

)

):

for n in name:

typer.echo(f"Hello {n}")

if __name__ == "__main__":

typer.run(main)

code: zsh

Freddie -- The vocalist.

John -- The bass guitarist.

Roger -- The drummer.

これにより、選択済みのものが除かれた選択候補が表示されます。

コマンドラインの状態を参照したい

補完する前のマンドラインを参照することができます。

code: autocompletion4.py

from typing import List

import typer

valid_completion_items = [

("Brian", "The guitarist."),

("Freddie", "The vocalist."),

("John", "The bass guitarist."),

("Roger", "The drummer."),

]

typer.echo(f"{args}", err=True)

for name, help_text in valid_completion_items:

if name.startswith(incomplete):

yield (name, help_text)

def main(

name: str = typer.Option("World",

autocompletion=complete_name,

help="The name to say hi to."

)

):

typer.echo(f"Hello {name}")

if __name__ == "__main__":

typer.run(main)

code: zs

% typer autocompletion4.py run --name

typer autocompletion4.py run --name

Brian -- The guitarist.

Freddie -- The vocalist.

John -- The bass guitarist.

Roger -- The drummer.

サブコマンド処理

code: subcommand.py

import typer

app = typer.Typer()

@app.command()

def initdb(dbname: str):

typer.echo(f'Initialized the database {dbname}')

@app.command()

def dropdb(force: bool = typer.Option(False, '--force',

help='drop db anyway'),

dbname: str = typer.Argument(...)

):

typer.echo(f'Force Flag: {force}')

typer.echo(f'Droped the database: {dbname}')

if __name__ == "__main__":

app()

code: bash

% python subcommand.py --help

Options:

--install-completion Install completion for the current shell.

--show-completion Show completion for the current shell, to copy it or

customize the installation.

--help Show this message and exit.

Commands:

dropdb

initdb

% python subcommand.py initdb --help

Arguments:

Options:

--help Show this message and exit.

% python subcommand.py dropdb --help

Arguments:

Options:

--help Show this message and exit.

% python subcommand.py initdb mydb

Initialized the database mydb

% python subcommand.py dropdb mydb

Force Flag: False

Droped the database: mydb

% python subcommand.py dropdb --force mydb

Force Flag: True

Droped the database: mydb

サブコマンドの右側はすべてそのサブコマンドの関数に渡されるコマンドラインとなります。

サブコマンドのヘルプ表示

サブコマンド名はデフォルトでは関数名が使用されますが、別名にしたいときは

code: subcommand2.py

import typer

app = typer.Typer(help='Database manager')

@app.command(help='Initializing DATABASE')

def initdb(dbname: str):

"""

initializing database.

"""

typer.echo(f'Initialized the database {dbname}')

@app.command("dropdb")

def delete_db(force: bool = typer.Option(False, '--force',

help='drop db anyway'),

dbname: str = typer.Argument(...)

):

"""

Drop database.

"""

typer.echo(f'Force Flag: {force}')

typer.echo(f'Droped the database: {dbname}')

code: zsh

% python subcommand2.py --help

Database manager

Options:

--install-completion Install completion for the current shell.

--show-completion Show completion for the current shell, to copy it or

customize the installation.

--help Show this message and exit.

Commands:

dropdb Drop database.

initdb Initializing DATABASE.

サブコマンド共通のパラメタを処理したい

各サブコマンドをこの値を参照するようにしています。

code: subcommand3.py

import typer

state = {'verbose': False }

app = typer.Typer(help='Database manager')

@app.command(help='Initializing DATABASE')

def initdb(dbname: str):

"""

Initializing database.

"""

typer.echo("running initializing database")

typer.echo(f'Initialized the database {dbname}')

typer.echo(f'Force Flag: {force}')

typer.echo("running drop database")

typer.echo(f'Droped the database: {dbname}')

@app.callback()

def main(verbose: bool = typer.Option(False, '--verbose')):

if verbose:

typer.echo("Will write verbose output")

if __name__ == "__main__":

app()

code: zsh

% python subcommand3.py --help

Database manager

Options:

--install-completion Install completion for the current shell.

--show-completion Show completion for the current shell, to copy it or

customize the installation.

--help Show this message and exit.

Commands:

dropdb Drop database.

initdb Initializing DATABASE

% python subcommand3.py initdb mydb

Initialized the database mydb

% python subcommand3.py --verbose initdb mydb

Will write verbose output

running initializing database

Initialized the database mydb

code: subcommand4.py

import typer

state = {'verbose': False }

def app_callback(

ctx: typer.Context,

verbose: bool = typer.Option(False, '--verbose')):

typer.echo(f"Running a command {ctx.invoked_subcommand}")

if verbose:

typer.echo("Will write verbose output")

app = typer.Typer(help='Database manager',

callback=app_callback)

@app.command(help='Initializing DATABASE')

def initdb(dbname: str):

"""

Initializing database.

"""

typer.echo("running initializing database")

typer.echo(f'Initialized the database {dbname}')

@app.command("dropdb")

def delete_db(force: bool = typer.Option(False, '--force',

help='drop db anyway'),

dbname: str = typer.Argument(...)

):

"""

Drop database.

"""

typer.echo(f'Force Flag: {force}')

typer.echo("running drop database")

typer.echo(f'Droped the database: {dbname}')

if __name__ == "__main__":

app()

code: zsh

% python subcommand4.py --help

Database manager

Options:

--install-completion Install completion for the current shell.

--show-completion Show completion for the current shell, to copy it or

customize the installation.

--help Show this message and exit.

Commands:

dropdb Drop database.

initdb Initializing DATABASE

% python subcommand4.py initdb mydb

Running a command initdb

Initialized the database mydb

% python subcommand4.py --verbose initdb mydb

Running a command initdb

Will write verbose output

running initializing database

Initialized the database mydb

ヘルプメッセージを表示するためにコールバック関数を使用することもできます。

code: subcommand.py

import typer

app = typer.Typer()

@app.callback()

def callback():

"""

Manage users CLI app.

Use it with the create command.

A new user with the given NAME will be created.

"""

@app.command()

def create(name: str):

typer.echo(f"Creating user: {name}")

@app.command()

def delete(name: str):

typer.echo(f"Deleting user: {name}")

if __name__ == "__main__":

app()

デフォルトではコールバック関数はサブコマンドが実行される直前に呼び出されます。このときサブコマンドが与えられていないとヘルプメッセージが表示されます。

code: subcommand6.py

import os

import typer

__MYPROG__ = os.path.basename(__file__)

__VERSION__ = '1.0'

app = typer.Typer()

@app.command()

def initdb(dbname: str):

typer.echo(f'Initialized the database {dbname}')

@app.command()

def dropdb(force: bool = typer.Option(False, '--force',

help='drop db anyway'),

dbname: str = typer.Argument(...)

):

typer.echo(f'Force Flag: {force}')

typer.echo(f'Droped the database: {dbname}')

@app.callback(invoke_without_command=True)

def print_version(ctx: typer.Context,

version: bool = typer.Option(False, '--version')

):

if version:

typer.echo(f'{__MYPROG__} - Version: {__VERSION__}')

raise typer.Exit()

if ctx.invoked_subcommand is None:

typer.echo('This is main command')

if __name__ == "__main__":

app()

code: zsh

% python subcommand6.py --help

Options:

--install-completion Install completion for the current shell.

--show-completion Show completion for the current shell, to copy it or

customize the installation.

--help Show this message and exit.

Commands:

dropdb

initdb

% python subcommand6.py --version

subcommand6.py - Version: 1.0

% python subcommand6.py

This is main command

% python subcommand6.py initdb mydb

Initialized the database mydb

コマンドラインの文字列をそのまま受け取りたい

コマンドのオプションや引数として登録したパラメタの他に、コマンドラインの文字列をそのまま受け取ることもできます。

code: context.py

import typer

app = typer.Typer()

@app.command(

context_settings={'allow_extra_args': True,

'ignore_unknown_options': True}

)

def main(version: bool = typer.Option(False, '--version'),

unkown_args: typer.Context = typer.Option(None)

):

typer.echo(f'Got known arg version: {version}')

for unknown_arg in unkown_args.args:

typer.echo(f'Got unknown arg: {unknown_arg}')

if __name__ == "__main__":

app()

code: zsh

% python context.py --help

Options:

--install-completion Install completion for the current shell.

--show-completion Show completion for the current shell, to copy it or

customize the installation.

--help Show this message and exit.

% python context.py --version --name Jack

Got known arg version: True

Got unknown arg: --name

Got unknown arg: Jack

処理中にプログレスバーを表示させたい

code: progressbar.py

import time

import typer

def count_something(count):

for num in range(count):

yield num

def main(count: int = typer.Option(100,

'--count', min=10, max=500)

):

total = 0

with typer.progressbar(count_something(count),

length=count,

label="Processing") as progress:

for value in progress:

# Fake processing time

time.sleep(0.01)

total += 1

typer.echo(f"Processed {total} things.")

if __name__ == "__main__":

typer.run(main)

アプリケーションのテスト

もとのコードではテストを実行することができないので、次のように修正します。

code: greeting2.py

import typer

app = typer.Typer()

@app.command()

def hello(count: int = typer.Option(1, '-C', '--count',

help='Number of greetings.'),

name: str = typer.Option(..., prompt='Your Name',

help='The person to greet.'),

):

"""COUNTで与えた回数だけHelloする"""

for x in range(count):

typer.echo(f'Hello {name}')

if __name__ == '__main__':

app()

これをテストするためのコードは次のようになります。

code: test_greeting.py

from typer.testing import CliRunner

from greeting2 import app

runner = CliRunner()

def test_app():

assert result.exit_code == 0

assert result.output == 'Hello Peter\n'

assert result.exit_code == 0

assert result.output == 'Hello Jack\nHello Jack\n'

if __name__ == '__main__':

test_app()

pytest

pytestはPythonのテストフレームワークで、テストに失敗した原因がわかりやすく、よく利用されているものです。

code: conda

$ conda install pytest

code: pip

$ pip install pytest

code: zsh

% pytest

============================= test session starts ==============================

platform darwin -- Python 3.8.6, pytest-6.1.2, py-1.9.0, pluggy-0.13.1

rootdir: /Users/goichiiisaka/Projects/Python.Osaka/Typer_tutorial

collected 1 item

============================== 1 passed in 0.08s ===============================

参考：