TypeError - <argument/option name> is defined twice

[glass-ships]

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

In main file: 

import typer 

app = typer.Typer()
app.add_typer(solr_cli.solr_app, name="solr")

... # main commands

In solr_cli.py:

import typer

solr_app = typer.Typer()

@solr_app.command("download")
def download(
    version: Annotated[
        str,
        typer.Option(
            "latest",
            "--version",
            help="The version of the Solr KG to download (latest, dev, or a specific version)",
        ),
    ] = "latest",
    overwrite: Annotated[
        bool,
        typer.Option(
            False,
            "--overwrite",
            help="Overwrite the existing Solr KG if it exists",
        ),
    ] = False,
):
    """Download the Monarch Solr KG."""
    ensure_solr(version, overwrite)   # util that uses pystow to download a file if missing
    raise typer.Exit()

... # other commands, none of which have version as an argument

Description

I have a primary CLI file, and a secondary solr_cli file with some sub-commands.

But when I run any command at all, I get:

TypeError: Name 'version' defined twice

This was apparently happening before the release of typer v0.12, when we were using 0.7 with typer-cli separate, but I can't pin down when it started happening or why

Operating System

Linux

Operating System Details

No LSB modules are available.
Distributor ID: Ubuntu
Description: Ubuntu 24.04 LTS
Release: 24.04
Codename: noble

Typer Version

0.12.3

Python Version

3.11.9

Additional Context

Related code with issue can be seen in cli.py and solr_cli.py of this repository

Some additional notes:

• If I don't do add_typer(solr_cli.solr_app) I'm able to run the commands defined in the main CLI file
• If I remove version as an argument to download(), I instead get:

AttributeError: 'bool' object has no attribute 'isidentifier'

It's possible this issue is with click itself and not typer, but given the first note above, I'm suspicious it has to do with how typer is constructing things to pass to click

Full stack trace:

╭─────────────────────────────── Traceback (most recent call last) ────────────────────────────────╮
│ /mnt/dev/dev/TISLab/monarch-app/backend/.venv/bin/monarch:6 in <module>                          │
│                                                                                                  │
│   3 from monarch_py.cli import app                                                               │
│   4                                                                                              │
│   5 if __name__ == '__main__':                                                                   │
│ ❱ 6 │   sys.exit(app())                                                                          │
│   7                                                                                              │
│                                                                                                  │
│ ╭───────────────────── locals ──────────────────────╮                                            │
│ │ app = <typer.main.Typer object at 0x7c7412addcd0> │                                            │
│ │ sys = <module 'sys' (built-in)>                   │                                            │
│ ╰───────────────────────────────────────────────────╯                                            │
│                                                                                                  │
│ /mnt/dev/dev/TISLab/monarch-app/backend/.venv/lib/python3.11/site-packages/typer/main.py:326 in  │
│ __call__                                                                                         │
│                                                                                                  │
│ /mnt/dev/dev/TISLab/monarch-app/backend/.venv/lib/python3.11/site-packages/typer/main.py:309 in  │
│ __call__                                                                                         │
│                                                                                                  │
│ /mnt/dev/dev/TISLab/monarch-app/backend/.venv/lib/python3.11/site-packages/typer/main.py:348 in  │
│ get_command                                                                                      │
│                                                                                                  │
│ /mnt/dev/dev/TISLab/monarch-app/backend/.venv/lib/python3.11/site-packages/typer/main.py:330 in  │
│ get_group                                                                                        │
│                                                                                                  │
│ /mnt/dev/dev/TISLab/monarch-app/backend/.venv/lib/python3.11/site-packages/typer/main.py:493 in  │
│ get_group_from_info                                                                              │
│                                                                                                  │
│ /mnt/dev/dev/TISLab/monarch-app/backend/.venv/lib/python3.11/site-packages/typer/main.py:485 in  │
│ get_group_from_info                                                                              │
│                                                                                                  │
│ /mnt/dev/dev/TISLab/monarch-app/backend/.venv/lib/python3.11/site-packages/typer/main.py:579 in  │
│ get_command_from_info                                                                            │
│                                                                                                  │
│ /mnt/dev/dev/TISLab/monarch-app/backend/.venv/lib/python3.11/site-packages/typer/main.py:555 in  │
│ get_params_convertors_ctx_param_name_from_function                                               │
│                                                                                                  │
│ /mnt/dev/dev/TISLab/monarch-app/backend/.venv/lib/python3.11/site-packages/typer/main.py:888 in  │
│ get_click_param                                                                                  │
│                                                                                                  │
│ /mnt/dev/dev/TISLab/monarch-app/backend/.venv/lib/python3.11/site-packages/typer/core.py:423 in  │
│ __init__                                                                                         │
│                                                                                                  │
│ /mnt/dev/dev/TISLab/monarch-app/backend/.venv/lib/python3.11/site-packages/click/core.py:2536 in │
│ __init__                                                                                         │
│                                                                                                  │
│ /mnt/dev/dev/TISLab/monarch-app/backend/.venv/lib/python3.11/site-packages/click/core.py:2111 in │
│ __init__                                                                                         │
│                                                                                                  │
│ /mnt/dev/dev/TISLab/monarch-app/backend/.venv/lib/python3.11/site-packages/click/core.py:2653 in │
│ _parse_decls                                                                                     │
╰──────────────────────────────────────────────────────────────────────────────────────────────────╯
TypeError: Name 'version' defined twice

[wstrydom-ebsco]

Whenever I use Annotated to define parameters to my command, the issue appears. When I don't, everything works fine.

[Renal-Of-Loon]

So I ended up here due to getting the same error. My issue was, however, completely different.

With the code

input_folder: str = typer.Option(
            None,
            "--input-folder",
            "in",
            help="Folder where ALL the reference data is present"
        ),

I get the error: TypeError: Name 'input_folder' defined twice

If I change the declaration "in" to "-in", the error is resolved. I'm not sure why the error displayed was so off-base.

[CrazyOlolosh]

Try removing the “default” values from typer.Option(). It should help.

@solr_app.command("download")
def download(
    version: Annotated[
        str,
        typer.Option(
            "--version",
            help="The version of the Solr KG to download (latest, dev, or a specific version)",
        ),
    ] = "latest",
    overwrite: Annotated[
        bool,
        typer.Option(
            "--overwrite",
            help="Overwrite the existing Solr KG if it exists",
        ),
    ] = False,
):

[justanotherbody]

This just solved my problem. I had defined the default only in typer.Option() and it turned out moving that to the parameter definition was the key.

Weird that providing the default only in typer.Option() still generates this error.