Enum - Choices

To define a CLI parameter that can take a value from a predefined set of values you can use a standard Python enum.Enum:

from enum import Enum

import typer_cloup as typer


class NeuralNetwork(str, Enum):
    simple = "simple"
    conv = "conv"
    lstm = "lstm"


def main(network: NeuralNetwork = NeuralNetwork.simple):
    typer.echo(f"Training neural network of type: {network.value}")


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

Tip

Notice that the function parameter network will be an Enum, not a str.

To get the str value in your function's code use network.value.

Check it:

fast →python main.py --help
💬 Notice the predefined values [simple|conv|lstm]Usage: main.py [OPTIONS]

Options:
--network [simple|conv|lstm] [default: simple]
--help Show this message and exit.

💬 Try itpython main.py --network conv
Training neural network of type: conv

💬 Invalid valuepython main.py --network capsule
Usage: main.py [OPTIONS]
Try "main.py --help" for help.

Error: Invalid value for '--network': invalid choice: capsule. (choose from simple, conv, lstm)

restart ↻

Case insensitive Enum choices

You can make an Enum (choice) CLI parameter be case-insensitive with the case_sensitive parameter:

from enum import Enum

import typer_cloup as typer


class NeuralNetwork(str, Enum):
    simple = "simple"
    conv = "conv"
    lstm = "lstm"


def main(
    network: NeuralNetwork = typer.Option(NeuralNetwork.simple, case_sensitive=False)
):
    typer.echo(f"Training neural network of type: {network.value}")


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

And then the values of the Enum will be checked no matter if lower case, upper case, or a mix:

fast →💬 Notice the upper case CONVpython main.py --network CONV
Training neural network of type: conv

💬 A mix also workspython main.py --network LsTm
Training neural network of type: lstm

restart ↻