TenjintShell.complete

TenjintShell.complete(text, line=None, cursor_pos=None)

Return the completed text and a list of completions.

Parameters

  • text (string) – A string of text to be completed on. It can be given as empty and instead a line/position pair are given. In this case, the completer itself will split the line like readline does.

  • line (string, optional) – The complete line that text is part of.

  • cursor_pos (int, optional) – The position of the cursor on the input line.

Returns

  • text (string) – The actual text that was completed.

  • matches (list) – A sorted list with all possible completions.

The optional arguments allow the completion to take more context into account, and are part of the low-level completion API.

This is a wrapper around the completion mechanism, similar to what readline does at the command line when the TAB key is hit. By exposing it as a method, it can be used by other non-readline environments (such as GUIs) for text completion.

Simple usage example:

In [1]: x = ‘hello’

In [2]: _ip.complete(‘x.l’) Out[2]: (‘x.l’, [‘x.ljust’, ‘x.lower’, ‘x.lstrip’])