Add an Option argument, to mask its value in case of exceptions

[HansAarneLiblik]

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 typer import Option, Typer

cli = Typer(no_args_is_help=True, add_completion=False)


@cli.command()
def deploy(
    env: str = Option(...), 
    version: str = Option(...), 
    api_token: str = Option(...)  # <--- I'd like ONLY thos value to not be displayed on exception
) -> None:
    raise Exception("blah")

Description

I have a Typer script, that does... well a lot 😆 .

In some cases, it handles secrets (passwords, tokens, etc.), and when errors happen in those codepaths, I'd like to hide ONLY those values and not other arguments, as they provide helpful information regarding debugging.

Perhaps Option could have a new argument pretty_exceptions_show to disable ONLY this option from being prettified to logs when exceptions happen? (Similar to Typer having pretty_exceptions_show_locals)

Operating System

macOS

Operating System Details

No response

Typer Version

0.15.1

Python Version

3.13.2

Additional Context

No response

[YuriiMotov]

You can specify expose_value=False for such options. They will appear as None in the output

[HansAarneLiblik]

But I need this variable to be passed to the function. This is a valid arg that the code uses (but wont be logged anywhere). Just in case of exceptions, I would like it to NOT be logged.

Setting expose_value=False removes the value of this option, which is not what I desire

[YuriiMotov]

Oh, sorry.. You are right.

Is it suitable for you to use SecretStr from Pydantic?

from pydantic import SecretStr
from typer import Option, Typer, echo

cli = Typer(no_args_is_help=True, add_completion=False)

@cli.command()
def deploy(
    api_token: SecretStr = Option(..., parser=SecretStr)
) -> None:
    echo(api_token.get_secret_value())
    raise Exception(f"{api_token=}")

if __name__ == "__main__":
    cli()

As I understand, the way you would do it with Click is to set expose_value=False and use callback to store it into context:

from typer import Option, Typer, echo, Context

cli = Typer(no_args_is_help=True, add_completion=False)


def store_to_context(ctx: Context, param, value):
    ctx.obj = ctx.obj or {}
    ctx.obj[param.name] = value
    return value


@cli.command()
def deploy(
    ctx: Context,
    api_token: str = Option(..., expose_value=False, is_eager=True, callback=store_to_context),
) -> None:
    echo(ctx.obj.get("api_token"))
    raise Exception(f"{api_token=}")


if __name__ == "__main__":
    cli()

[HansAarneLiblik]

Wow thanks! I implemented a version of pydantic.SecretStr myself, and it's working preperly!

[lachaib]

I invite you to upvote my PR #723 that enables pydantic types to be natively supported by Typer, I'm still waiting for it to be merged and it avoids you to have to re-invent the wheel