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

Nesting custom Completer in FuzzyCompleter overwrites "display" parameter

Open
#1,179 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

Tried nesting my custom completer in a fuzzy completer and my display tag was overwritten everywhere. Might be that FuzzyCompleter adjusts the style based on "text" instead of "display".

How to re-create:

class MyCustomCompleter(Completer):
    def get_completions(self, document, complete_event):

        yield Completion(text="123", display="456", start_position=0)

text = prompt('> ', completer=FuzzyCompleter(MyCustomCompleter()))

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 FuzzyCompleter and reproduce the issue using the MyCustomCompleter example, focusing on how Completion.text and Completion.display are handled. Confirm that nesting the custom completer preserves the display value "456" rather than replacing it with "123".

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.