Function _method_magic_marker

IPython/core/magic.py:194–226

Decorator factory for methods in Magics subclasses.

(
    magic_kind: _MagicSpec,
)

def _method_magic_marker(
    magic_kind: _MagicSpec,
) -> Callable[[_F | str], _F | Callable[[_F], _F]]:
    """Decorator factory for methods in Magics subclasses."""

    validate_type(magic_kind)

    # This is a closure to capture the magic_kind.  We could also use a class,
    # but it's overkill for just that one bit of state.
    def magic_deco(arg: _F | str) -> _F | Callable[[_F], _F]:
        retval: _F | Callable[[_F], _F]
        if callable(arg):
            # "Naked" decorator call (just @foo, no args)
            func = arg
            name = func.__name__
            retval = arg
            record_magic(magics, magic_kind, name, name)
        elif isinstance(arg, str):
            # Decorator called with arguments (@foo('bar'))
            name = arg

            def mark(func: _F, *a: Any, **kw: Any) -> _F:
                record_magic(magics, magic_kind, name, func.__name__)
                return func

            retval = mark
        else:
            raise TypeError("Decorator can only be called with string or function")
        return retval

    # Ensure the resulting decorator has a usable docstring
    magic_deco.__doc__ = _docstring_template.format("method", magic_kind)
    return magic_deco


def _function_magic_marker(