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

'RuntimeError: async generator ignored GeneratorExit' when ThreadedCompleter-> NestedCompleter->WordCompleter is given a large number of completions to asynchronously parse

Open
#1,556 2 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'm developing a REPL where one of the options has a large number of completions (a few thousand). Each time a character is inputted or a completion is chosen a Runtime error is raised somewhere in a generator and ignored - spawning this message into stdout (each error is a keypress):

image

The completer is a NestedCompleter ending in a WordCompleter (which is the one with many completions) and complete_in_thread=True. The prompt being used is prompt_async(). Prompt_toolkit version 3.0.25.

Is there something I can do as a caller to avoid this beyond reducing the number of completions, or is an underlying change required somewhere?

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 asynchronous path connecting ThreadedCompleter, NestedCompleter, and WordCompleter when prompt_async() is used with complete_in_thread=True. Reproduce the issue using a WordCompleter containing a few thousand completions, then trace the GeneratorExit handling; done means keypresses and completion selection no longer emit the ignored async-generator RuntimeError.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.