`IPython.core.completer:completion_matcher`

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

Signature

   def     completion_matcher (  * ,     priority  :  Optional[float]    =  None   ,    identifier  :  Optional[str]    =  None   ,    api_version  :  int    =  1     )   →  Callable[[Matcher], Matcher]

Summary

Adds attributes describing the matcher.

Parameters

priority : Optional[float]

The priority of the matcher, determines the order of execution of matchers. Higher priority means that the matcher will be executed first. Defaults to 0.

identifier : Optional[str]

identifier of the matcher allowing users to modify the behaviour via traitlets, and also used to for debugging (will be passed as origin with the completions).

Defaults to matcher function's __qualname__ (for example, IPCompleter.file_matcher for the built-in matched defined as a file_matcher method of the IPCompleter class).

api_version: Optional[int]

version of the Matcher API used by this matcher. Currently supported values are 1 and 2. Defaults to 1.

Aliases

IPython.core.completer.completion_matcher