Allow to specify a bool option as a key value pair

[lorenzwalthert]

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 tutorial in the docs and didn't find an answer.
• I already checked if it is not related to Typer but to Click. Not sure it is but since typer does some type conversion given the type annotation, I think it could handle that complexity.

Commit to Help

• I commit to help with one of those options 👆
  I could not find an easy issue where I could contribute. But I did a one time sponsorship of $ 20.- to make up for that.

Example Code

import typer 

app = typer.Typer()


@app.command()
def hello(is_true: bool = typer.Option(True)):
    return 


if __name__ == "__main__":
    app()

Then, calling the script:

$ python scratch/typer-key-value.py --is-true=False
Error: Option '--is-true' does not take a value

Other ideas such as changing the type annotation to str is also hacky.

Description

I would like to specify a bool option as a key value pair. The use case for this is that in certains circumstances, it's only possible to specify key value pairs for a command line program. In my case, starting a training job on Sagemaker, the hyper-parameters have to be supplied as key-value pairs. So if I have a boolean hyper-parameter, I must type it as a string and then later convert it, which is a workaround.

Operating System

macOS

Operating System Details

No response

Typer Version

0.9.0

Python Version

3.11.4

Additional Context

No response

[lee-cq]

I tested the following code:

@app.command(name="test")
def tes(ver: bool = Option(
    False, "--verify", "-v",
    help="Verify SSL Certificates"
)):
    print("ver is", ver)

run __main__.py test -v , it works ver is True.

and typer.Option() has a parameter is_flag, It will be a flag.
like this:

@app.command(name="test")
def tes(ver: bool = Option(
    False, "--verify", "-v",
    is_flag=True,
    help="Verify SSL Certificates"
)):
    print("ver is", ver)

[lorenzwalthert]

But what I want to run is __main__.py test --verify=False. So you mean probably is_flag=False? If you edit your answer, I'll accept it 😄 .

@app.command(name="test")
def tes(ver: bool = Option(
    False, "--verify", "-v",
    is_flag=False,
    help="Verify SSL Certificates"
)):
    print("ver is", ver)

[riklopfer]

Poking around in the code, I see that is_flag is not supported, but I don't get the warning.

            warnings.warn(
                "The 'is_flag' and 'flag_value' parameters are not supported by Typer "
                "and will be removed entirely in a future release.",
                DeprecationWarning,
                stacklevel=2,
            )

Does this mean that passing booleans as values is not supported?

[lorenzwalthert]

Seems like support for it was removed in #987, but there is an ongoing discussion about the problems that arise with removal.