Function record_magic

IPython/core/magic.py:125–147

Utility function to store a function as a magic of a specific kind. Parameters ---------- dct : dict A dictionary with 'line' and 'cell' subdicts. magic_kind : str Kind of magic to be stored. magic_name : str Key to store the magic as. func : function

(
    dct: dict[str, dict[str, Any]],
    magic_kind: _MagicSpec,
    magic_name: str,
    func: Any,
)

def record_magic(
    dct: dict[str, dict[str, Any]],
    magic_kind: _MagicSpec,
    magic_name: str,
    func: Any,
) -> None:
    """Utility function to store a function as a magic of a specific kind.

    Parameters
    ----------
    dct : dict
        A dictionary with 'line' and 'cell' subdicts.
    magic_kind : str
        Kind of magic to be stored.
    magic_name : str
        Key to store the magic as.
    func : function
        Callable object to store.
    """
    if magic_kind == "line_cell":
        dct["line"][magic_name] = dct["cell"][magic_name] = func
    else:
        dct[magic_kind][magic_name] = func


def validate_type(magic_kind: str) -> None: