Module: core.builtin_trap

A context manager for managing things injected into builtins.

1 Class

class IPython.core.builtin_trap.BuiltinTrap(*args: t.Any, **kwargs: t.Any)

Bases: Configurable

__init__(shell: Any = None) → None

Create a configurable given a config config.

Parameters:

  • config (Config) – If this is empty, default values are used. If config is a Config instance, it will be used to configure the instance.

  • parent (Configurable instance, optional) – The parent Configurable instance of this object.

Notes

Subclasses of Configurable must call the __init__() method of Configurable before doing anything else and using super():

class MyConfigurable(Configurable):
    def __init__(self, config=None):
        super(MyConfigurable, self).__init__(config=config)
        # Then any other code you need to finish initialization.

This ensures that instances will be configured properly.

activate() → None

Store ipython references in the __builtin__ namespace.

add_builtin(key: str, value: Any) → None

Add a builtin and save the original.

deactivate() → None

Remove any builtins which might have been added by add_builtins, or restore overwritten ones to their previous values.

remove_builtin(key: str, orig: Any) → None

Remove an added builtin and re-set the original.