IPython 8.4.0 Pypi GitHub Homepage
Other Docs
NotesParametersReturnsBackRef
complete(self, text, line=None, cursor_pos=None)

Notes

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.

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.

Return the completed text and a list of completions.

Examples

In [1]: x = 'hello'

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

See :

Back References

The following pages refer to to this document either explicitly or contain code examples using this.

papyri

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/interactiveshell.py#2118
type: <class 'function'>
Commit: