`IPython.core.completer:IPCompleter.completions`

source: /IPython/core/completer.py :3272

Signature

def completions ( self , text : str , offset : int ) → Iterator[Completion]

Summary

Returns an iterator over the possible completions

Extended Summary

Parameters

text : str: Full text of the current input, multi line string.
offset : int: Integer representing the position of the cursor in text. Offset is 0-based indexed.

Yields

: Completion

Notes

The cursor on a text can either be seen as being "in between" characters or "On" a character depending on the interface visible to the user. For consistency the cursor being on "in between" characters X and Y is equivalent to the cursor being "on" character Y, that is to say the character the cursor is on is considered as being after the cursor.

Combining characters may span more that one position in the text.

Aliases

IPython.core.completer.IPCompleter.completions