Validating combinations of Options

[menzenski]

First Check

• I added a very descriptive title here.
• I used the GitHub search to find a similar question and didn't find it.
• I searched the Typer documentation, with the integrated search.
• I already searched in Google "How to X in Typer" and didn't find any information.
• I already read and followed all the tutorials in the docs and didn't find an answer.
• I already checked if it is not related to Typer but to Click.

Commit to Help

• I commit to help with one of those options 👆

Example Code

from typing import Optional
from typing_extensions import Annotated

import typer


def main(
        username: Annotated[Optional[str], typer.Option()] = None,
        password: Annotated[Optional[str], typer.Option()] = None,
        token: Annotated[Optional[str], typer.Option()] = None,
    ):
    if username and password and not token:
        typer.echo("Using username and password authentication")
    elif token and not username and not password:
        typer.echo("Using token authentication")
    else:
        typer.echo("Please provide either a username and password or a token, but not both.")
        raise typer.Exit(code=1)


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

Description

I'd like to define a CLI command that supports two sorts of options - either username and password, or token. I've attached a self-contained example that implements this, but I'm interested to know if there is a better way to accomplish this with Typer.

Passing --username and --password (and not passing --token) is valid:

$ python mwe.py --username admin --password password
Using username and password authentication

Passing --token (and not passing --username or --password) is also valid:

$ python mwe.py --token api-token
Using token authentication

Passing other combinations of these options is not valid:

$ python mwe.py --username admin --password password --token api-token
Please provide either a username and password or a token, but not both.

$ python mwe.py
Please provide either a username and password or a token, but not both.

Operating System

macOS

Operating System Details

No response

Typer Version

0.12.3

Python Version

3.12.2

Additional Context

No response

[Hetari]

I am unsure if this is the best way of doing it, but I would like to rewrite your code as follows:

import typer


# Create CLI app
app = typer.Typer(
    name="simple",
    add_completion=False,
)

username = typer.Option(
    "", # or None
    "-u",
    "--username",
    help="Username for authentication",
)
password = typer.Option(
    "", # or None
    "-p",
    "--password",
    help="Password for authentication",
)
token = typer.Option(
    "", # or None
    "-t",
    "--token",
    help="Token for authentication",
)


@app.command()
def main(
    username=username,
    password=password,
    token=token,
):
    if username and password and token:
        typer.echo(
            "Using username, password, and token in authentication is not allowed. Please try again.")
        raise typer.Exit(code=1)

    if username and password:
        typer.echo("Using username and password authentication")
    elif token:
        typer.echo("Using token authentication")
    else:
        typer.echo(
            "Please provide either a username and password OR a token, but not both.")
        raise typer.Exit(code=1)


if __name__ == "__main__":
    app()

the output should be like this:
with token

python main.py - t api-token
Using token authentication

with username and password:

python main.py - u myUserName - p passw0rd
Using username and password authentication

and it will check for validation:

python main.py - t ""
Please provide either a username and password OR a token, but not both.


python main.py - u myUserName
Please provide either a username and password OR a token, but not both.


python main.py - p passw0rd
Please provide either a username and password OR a token, but not both.