IPython 8.4.0 Pypi GitHub Homepage
Other Docs
ParametersReturns
_complete(self, *, cursor_line, cursor_pos, line_buffer=None, text=None, full_text=None) -> IPython.core.completer._CompleteResult

With current provisional API, cursor_pos act both (depending on the caller) as the offset in the text or line_buffer , or as the column when passing multiline strings this could/should be renamed but would add extra noise.

Parameters

cursor_line :

Index of the line the cursor is on. 0 indexed.

cursor_pos :

Position of the cursor in the current line/line_buffer/text. 0 indexed.

line_buffer : optional, str

The current line the cursor is in, this is mostly due to legacy reason that readline could only give a us the single current line. Prefer :None:None:`full_text`.

text : str

The current "token" the cursor is in, mostly also for historical reasons. as the completer would trigger only after the current line was parsed.

full_text : str

Full text of the current cell.

Returns

A tuple of N elements which are (likely):

matched_text: ? the text that the complete matched matches: list of completions ? matches_origin: ? list same length as matches, and where each completion came from jedi_matches: list of Jedi matches, have it's own structure.

Like complete but can also returns raw jedi completions as well as the origin of the completion text. This could (and should) be made much cleaner but that will be simpler once we drop the old (and stateful) complete API.

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#2051
type: <class 'function'>
Commit: