How to make arguments with underscores instead of dashes?

[AreopagX]

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

import typer

def main(local_rank: Optional[int] = 0):
    print(f"local_rank: {local_rank}")
    # do fancy neural network stuff

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

Description

Hello everyone,

I'm currently using Typer for a project with neural networks. I'd like to start my main script using torch.distributed.launch, which passes the argument "local_rank" to the main script.

python main.py --local_rank=0

However, when doing so Typer complains that this option is unknown. That is due to the standardized conversion of "_" to "-". How can I make my script accept the CLI option "local_rank"?

There is an related issue #341 , however, this deals with command names. In this case, it is about argument names AND I can't influence the way they are passed to my script.

Operating System

Linux

Operating System Details

No response

Typer Version

0.12.5

Python Version

3.10.14

Additional Context

No response

[YuriiMotov]

There is no option to configure this for now, but you can use the following "hack" (from mentioned issue):

from typing import Optional

import typer

typer.main.get_command_name = lambda name: name  # Override the name conversion function

def main(local_rank: Optional[int] = 0):
    print(f"local_rank: {local_rank}")
    # do fancy neural network stuff

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

Note, it will also change naming convention for commands!