Add autocompletion for text prompts

[WilliamVenner]

(Branches off of #256)

This adds the ability to add an autocompletion function to Text prompts. The autocompletion function has similar semantics as readline.set_completer. Pressing TAB will call the autocompletion function and set the current text to whatever it returns.

[Cube707]

@WilliamVenner please remove the merge. Instead, rebase your feature branch onto the current master and force push it (after reafirming it still works)

[WilliamVenner]

Hey, do you need me to fix that code coverage thing? It seems a bit overzealous

[staticdev]

@WilliamVenner first of, autocompletion is a great feature and thanks for that.

I understand that is seems a overkill to have all this coverage, but also we are trying to maintain a well tested software so it is good for everyone. If you could add some unit tests for it would be great. If not, we see how we can deal with it and not loose also your effort.

[WilliamVenner]

Hmmm I'm having trouble of thinking how to come up with a test for this code, which I think is the culprit of the code coverage check fail.

python-inquirer/src/inquirer/render/console/_text.py

Lines 26 to 39 in c4bbef7

	if pressed == key.TAB and self.question.autocomplete:
	if self._autocomplete_state is None:
	self._autocomplete_state = [self.current, 0]
	[text, state] = self._autocomplete_state
	autocomplete = self.question.autocomplete(text, state)
	if isinstance(autocomplete, str):
	self.current = autocomplete
	self._autocomplete_state[1] += 1
	else:
	self._autocomplete_state = None
	return
	self._autocomplete_state = None

I would be inclined to say that the test added by this PR and the already present tests should cover this code, but that's understandably not being picked up by the code coverage tool - any thoughts?

[staticdev]

@WilliamVenner we have tests to render text here: https://github.com/magmax/python-inquirer/blob/main/tests/integration/console_render/test_text.py

You could add a case for autocomplete when you have tab key pressed.

[WilliamVenner]

Thanks for your help @staticdev :)

[staticdev]

Lgtm. @Cube707 ?

[Cube707]

I am missing some documentation. Code looks fine as is, but I tried fiddeling arround in the example and couldn't easiely get some basict to work:

• What is expected to be passed to autocomplete?
• what do functons need to return when passed to autocomplete?

I tried the obvios thing and passed a list of strings, which just failed silently..

• an example of using multiple suggestions would be helpful. Maybe something similar to this:

from itertools import cycle

suggestions = cycle(["inquirer", "hello"])
def autocomplete_fn(_text, _state):
    return next(suggestions)

[Cube707]

LGTM

[staticdev]

Thanks a lot @WilliamVenner !

[WilliamVenner]

hey guys, when do you plan on releasing this one? :p