args parameter in autocompletion functions is always the empty list.

[bckohan]

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

from typing import List

import typer
from rich.console import Console

valid_completion_items = [
    ("Camila", "The reader of books."),
    ("Carlos", "The writer of scripts."),
    ("Sebastian", "The type hints guy."),
]

err_console = Console(stderr=True)


def complete_name(args: List[str], incomplete: str):
    err_console.print(f"{args}")
    for name, help_text in valid_completion_items:
        if name.startswith(incomplete):
            yield (name, help_text)


app = typer.Typer()


@app.command()
def main(
    name: List[str] = typer.Option(
        ["World"], help="The name to say hi to.", autocompletion=complete_name
    ),
):
    for n in name:
        print(f"Hello {n}")


if __name__ == "__main__":
    app()

Description

The args: List[str] option on autocompletion functions is documented as containing all of the CLI arguments before the option being completed.. It however, is currently hard coded to always return an empty list. The tests that test this behavior are also incorrectly verifying that args is empty when it should not be.

Before the most recent version args was being set to Context.args. This was also incorrect (and almost always the empty list) because Context.args contains CLI parameters that Click did not understand (i.e. the leftovers when you use lenient parsing).

I had a suggested fix for this bug in #1006 but was asked to pull it out into a separate PR which I will now do.

Operating System

macOS

Operating System Details

No response

Typer Version

0.15.1

Python Version

3.12

Additional Context

No response

[bckohan]

PR: #1134