This is a development version (9.14.0.dev) and may be unstable. Go to latest (9.13.0)
{ } Raw JSON

bundles / IPython 9.14.0.dev / IPython / core / completer / Completion

class

IPython.core.completer:Completion

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

Signature

class   Completion ( start : int end : int text : str * type : Optional[str] = None _origin = '' signature = '' )  →  None

Members

Summary

Completion object used and returned by IPython completers.

Extended Summary

This act as a middle ground Completion object between the jedi.api.classes.Completion object and the Prompt Toolkit completion object. While Jedi need a lot of information about evaluator and how the code should be ran/inspected, PromptToolkit (and other frontend) mostly need user facing information.

  • Which range should be replaced replaced by what.

  • Some metadata (like completion type), or meta information to displayed to the use user.

For debugging purpose we can also store the origin of the completion (jedi, IPython.python_matches, IPython.magics_matches...).

Aliases

  • IPython.core.completer.Completion