complete(self, text=None, line_buffer=None, cursor_pos=None) -> Tuple[str, Sequence[str]]

Note that both the text and the line_buffer are optional, but at least one of them must be given.

Notes

This API is likely to be deprecated and replaced by IPCompleter.completions in the future.

Parameters

text : string, optional

Text to perform the completion on. If not given, the line buffer is split using the instance's CompletionSplitter object.

line_buffer : string, optional

If not given, the completer attempts to obtain the current line buffer via readline. This keyword allows clients which are requesting for text completions in non-readline contexts to inform the completer of the entire text.

cursor_pos : int, optional

Index of the cursor in the full line buffer. Should be provided by remote frontends where kernel has no access to frontend state.

Returns

Tuple of two items:

text : str

Text that was actually used in the completion.

matches : list

A list of completion matches.

Find completions for the given text and line context.

Examples

See :

Local connectivity graph

Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.

Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)

SVG is more flexible but power hungry; and does not scale well to 50 + nodes.

All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them

---

GitHub : /IPython/core/completer.py#2010
type: <class 'function'>
Commit: