numpy._core.overrides:array_function_dispatch

Parameters

dispatcher : callable or None

Function that when called like dispatcher(*args, **kwargs) with arguments from the NumPy function call returns an iterable of array-like arguments to check for __array_function__.

If None, the first argument is used as the single like= argument and not passed on. A function implementing like= must call its dispatcher with like as the first non-keyword argument.

module : str, optional

__module__ attribute to set on new function, e.g., module='numpy'. By default, module is copied from the decorated function.

verify : bool, optional

If True, verify the that the signature of the dispatcher and decorated function signatures match exactly: all required and optional arguments should appear in order with the same names, but the default values for all optional arguments should be None. Only disable verification if the dispatcher's signature needs to deviate for some particular reason, e.g., because the function has a signature like func(*args, **kwargs).

docs_from_dispatcher : bool, optional

If True, copy docs from the dispatcher function onto the dispatched function, rather than from the implementation. This is useful for functions defined in C, which otherwise don't have docstrings.