prompt-toolkit / prompt-toolkit/python-prompt-toolkit

Question: autocomplete for custom cmd derived from click, How?

Open
#1,762 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
10.6k
Forks
815
PR merge metrics
No merged PRs in 30d

Description

I am writing a shell-like command REPL, the format of command is similar to shell. But it has nothing with shell. The program take input and use shlex to split and feed it to a collections of objects whose type is subclass of click.BaseCommand.

Something like that:

command_dict: dict[str, click.BaseCommand] 

while True:
    cmd_text = prompt_toolkit.prompt("$>>")
    args = shlex.split(cmd_text)
    command_dict[args[0]].main(args, standalone_mode=False)

What I hope is to make prompt_toolkit.prompt("$>>") provide autocomplete depend on the content in command_dict without any redundant definition, in other words, when the content in command_dict changed (for example add new command, or the Command object in command_dict become Group object, and add new sub-commands), the auto-complete content will automatically change accordingly.

Is it possible?

What is the best practice to achieve that?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the REPL loop using prompt_toolkit.prompt, shlex.split, and the command_dict of click.BaseCommand objects. Investigate how autocomplete can reflect command_dict changes, including when a Command becomes a Group with new subcommands. Done means the prompt's suggestions stay synchronized without redundant command definitions.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.