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

Built-in completers provided with a `map(...)` iterable instead of a `list(...)` only complete once

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

If a WordCompleter or FuzzyWordCompleter is provided with a map(...) iterable instead of a list(...), the completion will only work once, and then the map will be exhausted and future completions will fail.

Example:
choices = [{
    'text': 'Choice 1',
    # ... more data ...
},{
    'text': 'Choice 2',
    # ...
}]

selected_choice = prompt("> ", completer=FuzzyWordCompleter(map(lambda c: c['text'], choices)))
Temporary workaround:

Turn your map(...) into a list(...) before submitting it to the Completer:

selected_choice = prompt("> ", completer=FuzzyWordCompleter(list(map(lambda c: c['text'], choices))))

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 by locating the WordCompleter and FuzzyWordCompleter implementations and reproduce the issue with the map(...) example from this report. Confirm that repeated completion attempts continue to work with an iterable, while preserving existing list behavior; the workaround in the issue provides a comparison case.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.