Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions src/prompt_toolkit/completion/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -307,10 +307,11 @@ async def get_completions_async(
) -> AsyncGenerator[Completion, None]:
completer = self.get_completer() or DummyCompleter()

async for completion in completer.get_completions_async(
document, complete_event
):
yield completion
async with aclosing(
completer.get_completions_async(document, complete_event)
) as async_generator:
async for completion in async_generator:
yield completion

def __repr__(self) -> str:
return f"DynamicCompleter({self.get_completer!r} -> {self.get_completer()!r})"
Expand Down
73 changes: 73 additions & 0 deletions tests/test_completion.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,16 @@
import re
import shutil
import tempfile
from asyncio import run, sleep
from contextlib import contextmanager

import pytest

from prompt_toolkit.completion import (
CompleteEvent,
Completer,
Completion,
DynamicCompleter,
FuzzyWordCompleter,
NestedCompleter,
PathCompleter,
Expand All @@ -17,6 +23,73 @@
from prompt_toolkit.document import Document


@pytest.mark.parametrize("throw", [False, True])
def test_dynamic_completer_closes_async_generator(throw):
class ResourceCompleter(Completer):
def __init__(self):
self.closed = False
self.generator = None

def get_completions(self, document, complete_event):
raise AssertionError("The asynchronous implementation should be used.")

def get_completions_async(self, document, complete_event):
async def generate():
try:
yield Completion("first")
yield Completion("second")
finally:
await sleep(0)
self.closed = True

# Retain the generator so garbage collection cannot close it for us.
self.generator = generate()
return self.generator

async def check():
inner = ResourceCompleter()
outer = DynamicCompleter(lambda: inner).get_completions_async(
Document(""), CompleteEvent()
)
try:
assert (await anext(outer)).text == "first"
assert not inner.closed
if throw:
with pytest.raises(RuntimeError, match="stop completion"):
await outer.athrow(RuntimeError("stop completion"))
else:
await outer.aclose()
assert inner.closed
finally:
await outer.aclose()
if inner.generator is not None:
await inner.generator.aclose()

run(check())


def test_dynamic_completer_async_switching():
async def check():
current = WordCompleter(["first", "second"])
completer = DynamicCompleter(lambda: current)

async def complete():
return [
item.text
async for item in completer.get_completions_async(
Document(""), CompleteEvent()
)
]

assert await complete() == ["first", "second"]
current = WordCompleter(["third"])
assert await complete() == ["third"]
current = None
assert await complete() == []

run(check())


@contextmanager
def chdir(directory):
"""Context manager for current working directory temporary change."""
Expand Down
Loading