READLINE_LIKE completer not completing

Open
#1,375 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Run the supplied prompt() example with WordCompleter, CompleteStyle.READLINE_LIKE, and bottom_toolbar to reproduce both behaviors. Start by tracing the READLINE_LIKE completion path and the toolbar redraw handling; done means completion continues after the common prefix, suggestions appear while typing, and the toolbar remains at the bottom.

Written by the indexing model from the issue text.

Description

Using a READLINE_LIKE completer doesn't function as expected. When there is a common prefix it will fill it in (e.g. '<' in the example code) but it will not tab complete any further than that or display suggestions when typing more than '<'.

Another minor bug with READLINE_LIKE completer is using a bottom toolbar is redisplaying it above the readline completions every time you press tab.

#!/usr/bin/env python

from prompt_toolkit.completion import WordCompleter
from prompt_toolkit.shortcuts import CompleteStyle, prompt

test_completer = WordCompleter(['<html>', '<body>', '<head>', '<title>'])

prompt_params = {}
prompt_params['completer'] = test_completer
prompt_params['complete_style'] = CompleteStyle.READLINE_LIKE
prompt_params['bottom_toolbar'] = "should only appear at the bottom"

while True:
	prompt(**prompt_params)
Dominant language
Python
Stars
10.6k
Forks
815
No merged PRs in 30d

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.

More from prompt-toolkit/python-prompt-toolkit

All issues in prompt-toolkit/python-prompt-toolkit

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.