Typerの使い方

$ python3 sample1.py
Usage: sample1.py [OPTIONS] NAME
Try 'sample1.py --help' for help.

Error: Missing argument 'NAME'.

$ python3 sample1.py World
Hello World!

$ pip install typer

import typer

def hello(name: str):
    typer.echo(f"Hello {name}!")

if __name__ == "__main__":
    typer.run(hello)

$ python3 sample1.py
Usage: sample1.py [OPTIONS] NAME
Try 'sample1.py --help' for help.

Error: Missing argument 'NAME'.

$ python3 sample1.py --help
Usage: sample1.py [OPTIONS] NAME

Arguments:
  NAME  [required]

Options:
  --install-completion [bash|zsh|fish|powershell|pwsh]
                                  Install completion for the specified shell.
  --show-completion [bash|zsh|fish|powershell|pwsh]
                                  Show completion for the specified shell, to
                                  copy it or customize the installation.
  --help                          Show this message and exit.

$ python3 sample1.py World
Hello World!

import typer

app = typer.Typer()

@app.command()  # hello関数をhelloコマンドとして登録
def hello(name: str):
    typer.echo(f"Hello {name}!")

@app.command("bye")  # goodbye関数をbyeコマンドとして登録
def goodbye(name: str):
    typer.echo(f"Bye {name}!")

if __name__ == "__main__":
    app()

$ python3 sample2.py
Usage: sample2.py [OPTIONS] COMMAND [ARGS]...
Try 'sample2.py --help' for help.

Error: Missing command.

$ python3 sample2.py --help
Usage: sample2.py [OPTIONS] COMMAND [ARGS]...

Options:
  --install-completion [bash|zsh|fish|powershell|pwsh]
                                  Install completion for the specified shell.
  --show-completion [bash|zsh|fish|powershell|pwsh]
                                  Show completion for the specified shell, to
                                  copy it or customize the installation.
  --help                          Show this message and exit.

Commands:
  bye
  hello

$ python3 sample2.py bye --help
Usage: sample2.py bye [OPTIONS] NAME

Arguments:
  NAME  [required]

Options:
  --help  Show this message and exit.

$ python3 sample2.py hello --help
Usage: sample2.py hello [OPTIONS] NAME

Arguments:
  NAME  [required]

Options:
  --help  Show this message and exit.

$ python3 sample2.py hello World
Hello World!

from typing import Optional

import typer


def main(
    first_name: str,  # 位置・必須
    last_name: Optional[str] = typer.Argument(None, help="the last name"),  # 位置・任意
    formal: bool = False,  # オプション・任意
    age: int = typer.Option(...),  # オプション・必須
    title: Optional[str] = typer.Option(None),  # オプション・任意
):
    """Say hello!"""
    if formal:
        full_name = first_name
        if last_name is not None:
            full_name = full_name + f" {last_name}"
        if title is not None:
            full_name = f"{title} " + full_name
        typer.echo(
            f"Hello {full_name} ({age})."
        )
    else:
        typer.echo(f"Hi {first_name}!")


if __name__ == "__main__":
    typer.run(main)

$ python3 sample3.py
Usage: sample3.py [OPTIONS] FIRST_NAME [LAST_NAME]
Try 'sample3.py --help' for help.

Error: Missing argument 'FIRST_NAME'.

$ python3 sample3.py --help
Usage: sample3.py [OPTIONS] FIRST_NAME [LAST_NAME]

  Say hello!

Arguments:
  FIRST_NAME   [required]
  [LAST_NAME]  the last name

Options:
  --formal / --no-formal          [default: no-formal]
  --age INTEGER                   [required]
  --title TEXT
  --install-completion [bash|zsh|fish|powershell|pwsh]
                                  Install completion for the specified shell.
  --show-completion [bash|zsh|fish|powershell|pwsh]
                                  Show completion for the specified shell, to
                                  copy it or customize the installation.
  --help                          Show this message and exit.

$ python3 sample3.py John
Usage: sample3.py [OPTIONS] FIRST_NAME [LAST_NAME]
Try 'sample3.py --help' for help.

Error: Missing option '--age'.

$ python3 sample3.py John --age 20
Hi John!

$ python3 sample3.py John --age 20 --formal
Hello John (20).

$ python3 sample3.py John Doe --age 20 --formal
Hello John Doe (20).

$ python3 sample3.py John --age 20 --formal Doe
Hello John Doe (20).

$ python3 sample3.py John --age 20 --formal Doe --title Mr.
Hello Mr. John Doe (20).

import typer

app_greet = typer.Typer()

@app_greet.command()
def hello(name: str):
    typer.echo(f"Hello {name}!")

@app_greet.command()
def goodbye(name: str):
    typer.echo(f"Bye {name}!")

app_calc = typer.Typer()

@app_calc.command()
def add(a: float, b: float):
    typer.echo(a + b)

@app_calc.command()
def sub(a: float, b: float):
    typer.echo(a - b)

app = typer.Typer()
app.add_typer(app_greet, name="greet")
app.add_typer(app_calc, name="calc")

if __name__ == "__main__":
    app()

$ python3 sample4.py --help
Usage: sample4.py [OPTIONS] COMMAND [ARGS]...

Options:
  --install-completion [bash|zsh|fish|powershell|pwsh]
                                  Install completion for the specified shell.
  --show-completion [bash|zsh|fish|powershell|pwsh]
                                  Show completion for the specified shell, to
                                  copy it or customize the installation.
  --help                          Show this message and exit.

Commands:
  calc
  greet

$ python3 sample4.py calc --help
Usage: sample4.py calc [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  add
  sub

$ python3 sample4.py calc add 1 2
3.0

import typer


def main(
    username: str = typer.Argument(..., envvar="LOGNAME"),
):
    typer.echo(f"Hello {username}!")


if __name__ == "__main__":
    typer.run(main)

$ python3 sample5.py --help
Usage: sample5.py [OPTIONS] USERNAME

Arguments:
  USERNAME  [env var: LOGNAME;required]

Options:
  --install-completion [bash|zsh|fish|powershell|pwsh]
                                  Install completion for the specified shell.
  --show-completion [bash|zsh|fish|powershell|pwsh]
                                  Show completion for the specified shell, to
                                  copy it or customize the installation.
  --help                          Show this message and exit.

$ printenv | grep LOGNAME
LOGNAME=author

$ python3 sample5.py
Hello author!

$ python3 sample5.py John
Hello John!

import typer

app = typer.Typer()

state = {"verbose": False, "name": None}

@app.command()
def create():
    if state["verbose"]:
        name = state["name"]
        typer.echo(f"Creating user: {name}")


@app.command()
def delete():
    if state["verbose"]:
        name = state["name"]
        typer.echo(f"Deleting user: {name}")


@app.callback()
def callback(name: str, verbose: bool = False):
    state["name"] = name
    state["verbose"] = verbose
    if state["verbose"]:
        typer.echo("Verbose output ON")


if __name__ == "__main__":
    app()

$ python3 sample6.py --help
Usage: sample6.py [OPTIONS] NAME COMMAND [ARGS]...

Arguments:
  NAME  [required]

Options:
  --verbose / --no-verbose        [default: no-verbose]
  --install-completion [bash|zsh|fish|powershell|pwsh]
                                  Install completion for the specified shell.
  --show-completion [bash|zsh|fish|powershell|pwsh]
                                  Show completion for the specified shell, to
                                  copy it or customize the installation.
  --help                          Show this message and exit.

Commands:
  create
  delete

$ python3 sample6.py John create
$ python3 sample6.py --verbose John create
Verbose output ON
Creating user: John

$ python3 sample6.py --verbose John delete
Verbose output ON
Deleting user: John

import typer


def name_callback(ctx: typer.Context, param: typer.CallbackParam, value: str):
    if ctx.resilient_parsing:
        return
    typer.echo(f"Validating param: {param.name}")
    if value != "Camila":
        raise typer.BadParameter("Only Camila is allowed")
    return value


def main(name: str = typer.Argument(..., callback=name_callback)):
    typer.echo(f"Hello {name}.")


if __name__ == "__main__":
    typer.run(main)

$ python3 sample7.py
Usage: sample7.py [OPTIONS] NAME
Try 'sample7.py --help' for help.

Error: Missing argument 'NAME'.

$ python3 sample7.py John
Validating param: name
Usage: sample7.py [OPTIONS] NAME
Try 'sample7.py --help' for help.

Error: Invalid value for 'NAME': Only Camila is allowed

$ python3 sample7.py Camila
Validating param: name
Hello Camila.

import typer

def hello(name: str):
    name_enc = typer.style(
        name,
        fg=typer.colors.GREEN,  # 文字色
        bg=typer.colors.WHITE,  # 背景色
        bold=True,  # 太字にするか
        blink=True,  # 点滅するか
        underline=True,  # 下線を引くか
    )

    print([name_enc])
    #> ['\x1b[32m\x1b[1m\x1b[4m\x1b[5mWorld\x1b[0m']

    typer.echo(f"Hello {name_enc}!")

if __name__ == "__main__":
    typer.run(hello)