Autocompletion bug with multiple hyphens in options

[alexrosenfeld10]

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


app = typer.Typer(help="Testing 1234", no_args_is_help=True)

def autocomplete_test(incomplete: str):
    vals = ["foo-test-1234", "foo-anothertest-1234", "bar-test-1234"]
    return [val for val in vals if incomplete in val]


@app.command()
def test(
    name: str = typer.Option(None, "--name", "-n", help="Filter by name", autocompletion=autocomplete_test),
):
    typer.echo(f"foo {name}")

Description

When the above code is run in a CLI and the input my_cli test --name foo[TAB] is entered into the shell (where [TAB] indicates the user pressing tab to autocomplete the --name argument), the following is the result of the autocompletion:

❯ my_cli test --name foo--1234

I have observed similar behaviors in slightly different scenarios, for example, if the autocomplete function looks like this instead:

def autocomplete_test(incomplete: str):
    vals = ["foo-test-1234", "bar-test-1234"]
    return [val for val in vals if incomplete in val]

then a similar behavior happens when running my_cli test --name [TAB]:

❯ my_cli test --name -test-1234

Note - if the autocompletion options only have one typo, instead of two or more, it works fine. As in, this has no issue:

def autocomplete_test(incomplete: str):
    vals = [
        "foo-test",
        "foo-anothertest",
        "bar-test",
    ]
    return [val for val in vals if incomplete in val]

Operating System

macOS

Operating System Details

No response

Typer Version

0.12.5

Python Version

3.12.3

Additional Context

No response

[alexrosenfeld10]

@svlandeg @tiangolo this seems like a pretty clear bug, I took a look at the source code but didn't find any unit tests that trigger tab completion. If you can point me in the right direction I'll take a stab at fixing it

[svlandeg]

Hi @alexrosenfeld10, thanks for the report!

You can find some autocompletion tests in tests/test_completion, perhaps you have a look whether you can contribute some unit tests that fail on master? And then we can start looking into fixing the bug 🙏

[alexrosenfeld10]

Hmm. I tried this and wasn't able to reproduce through the unit tests. I'll find some time to make a minimal reproduction project and share it here

[alexrosenfeld10]

@svlandeg this doesn't seem to reproduce easily via unit tests... however, I've reproduced it for you here: https://github.com/alexrosenfeld10/typer-autocomplete-bug

Thanks in advance for taking a look. I'll be responsive here or in the issue page in my repo if you need any help setting up or reproducing the problem.

[alexrosenfeld10]

@svlandeg let me know if there's anything else I can to do help debug this

[alexrosenfeld10]

Hi @svlandeg , did you get a chance to try out the reproduction project? If you can point me in the right direction I'll take a stab at fixing the issue.

[alexrosenfeld10]

@tiangolo possible this could get looked at? It's a pretty common case to have hyphenated autocomplete suggestions, and this totally breaks that