[FEATURE] Allow Arguments with alternative / custom names.

[feluxe]

Is your feature request related to a problem

Is your feature request related to a problem? Yes

In this example I'd like to use the name id_ internally, but for the CLI I would like to provide an alternative name id:

def user(id_: Optional[str] = typer.Argument(None)):
   ...

For Commands and Options, this is already possible using @app.command("foo") and typer.Option(..., "--foo", "-f").

For Arguments it seems there is no way of doing this... if there was it would be nice to include a section for it in the docs, similar to CLI Option Name

The solution you would like

Maybe this:

typer.Argument(None, "id")

or

typer.Argument(None, name="id")

?

[daddycocoaman]

You would use the metavar field. It's also in the docs. https://typer.tiangolo.com/tutorial/arguments/help/#custom-help-name-metavar

@app.command()
def print_id(id_: str = typer.Argument(..., metavar="id")):
    print(id_)

Usage: typerarg.py [OPTIONS] id

Arguments:
  id  [required]

Options:
  --install-completion  Install completion for the current shell.
  --show-completion     Show completion for the current shell, to copy it or
                        customize the installation.

  --help                Show this message and exit.

[feluxe]

Ah, thanks a lot! I guess I was intuitively looking for it to have its own section. Commands and Options do have extra sections for this:

• Custom Command Name
• CLI Option Name

I didn't expect to find it in the CLI Arguments with Help section.

Just some feedback from someone new to typer :-)

Otherwise I'm really amazed by the project, same as FastApi. Both are such a joy to code with!

[tiangolo]

Thanks for the help here @daddycocoaman ! 👏 🙇

If that solves the original problem, then you can close this issue @feluxe ✔️

Sorry for the long delay! 🙈 I wanted to personally address each issue/PR and they piled up through time, but now I'm checking each one in order.

[github-actions]

Assuming the original issue was solved, it will be automatically closed now. But feel free to add more comments or create new issues.