Important

This documentation covers IPython versions 6.0 and higher. Beginning with version 6.0, IPython stopped supporting compatibility with Python versions lower than 3.3 including all versions of Python 2.7.

If you are looking for an IPython version compatible with Python 2.7, please use the IPython 5.x LTS release and refer to its documentation (LTS is the long term support release).

Module: terminal.shortcuts.filters

Filters restricting scope of IPython Terminal shortcuts.

13 Functions

IPython.terminal.shortcuts.filters.has_focus(value: Union[str, Buffer, UIControl, Container, MagicContainer])

Wrapper around has_focus adding a nice __name__ to tester function

IPython.terminal.shortcuts.filters.ebivim() bool

Turn any callable into a Filter. The callable is supposed to not take any arguments.

This can be used as a decorator:

@Condition
def feature_is_active():  # `feature_is_active` becomes a Filter.
    return True
Parameters

func – Callable which takes no inputs and returns a boolean.

IPython.terminal.shortcuts.filters.supports_suspend() bool

Turn any callable into a Filter. The callable is supposed to not take any arguments.

This can be used as a decorator:

@Condition
def feature_is_active():  # `feature_is_active` becomes a Filter.
    return True
Parameters

func – Callable which takes no inputs and returns a boolean.

IPython.terminal.shortcuts.filters.auto_match() bool

Turn any callable into a Filter. The callable is supposed to not take any arguments.

This can be used as a decorator:

@Condition
def feature_is_active():  # `feature_is_active` becomes a Filter.
    return True
Parameters

func – Callable which takes no inputs and returns a boolean.

IPython.terminal.shortcuts.filters.all_quotes_paired(quote, buf)
IPython.terminal.shortcuts.filters.preceding_text(pattern: Union[str, Callable])
IPython.terminal.shortcuts.filters.following_text(pattern)
IPython.terminal.shortcuts.filters.not_inside_unclosed_string() bool

Turn any callable into a Filter. The callable is supposed to not take any arguments.

This can be used as a decorator:

@Condition
def feature_is_active():  # `feature_is_active` becomes a Filter.
    return True
Parameters

func – Callable which takes no inputs and returns a boolean.

IPython.terminal.shortcuts.filters.navigable_suggestions() bool

Turn any callable into a Filter. The callable is supposed to not take any arguments.

This can be used as a decorator:

@Condition
def feature_is_active():  # `feature_is_active` becomes a Filter.
    return True
Parameters

func – Callable which takes no inputs and returns a boolean.

IPython.terminal.shortcuts.filters.readline_like_completions() bool

Turn any callable into a Filter. The callable is supposed to not take any arguments.

This can be used as a decorator:

@Condition
def feature_is_active():  # `feature_is_active` becomes a Filter.
    return True
Parameters

func – Callable which takes no inputs and returns a boolean.

IPython.terminal.shortcuts.filters.is_windows_os() bool

Turn any callable into a Filter. The callable is supposed to not take any arguments.

This can be used as a decorator:

@Condition
def feature_is_active():  # `feature_is_active` becomes a Filter.
    return True
Parameters

func – Callable which takes no inputs and returns a boolean.

IPython.terminal.shortcuts.filters.eval_node(node: Optional[AST])
IPython.terminal.shortcuts.filters.filter_from_string(code: str)