numpy.core.overrides

Constant	`ARRAY_FUNCTION_ENABLED`	Undocumented
Variable	`ArgSpec`	Undocumented
Variable	`array_function_like_doc`	Undocumented
Function	`array_function_dispatch`	Decorator for adding dispatch with the __array_function__ protocol.
Function	`array_function_from_dispatcher`	Like array_function_dispatcher, but with function arguments flipped.
Function	`set_array_function_like_doc`	Undocumented
Function	`set_module`	Decorator for overriding __module__ on a function or class.
Function	`verify_matching_signatures`	Verify that a dispatcher function has the right signature.

ARRAY_FUNCTION_ENABLED =

Undocumented

Value

bool(int(os.environ.get('NUMPY_EXPERIMENTAL_ARRAY_FUNCTION', 1)))

ArgSpec =

Undocumented

array_function_like_doc: str =

Undocumented

def array_function_dispatch(dispatcher, module=None, verify=True, docs_from_dispatcher=False):

Decorator for adding dispatch with the __array_function__ protocol.

See NEP-18 for example usage.

Parameters

dispatcher : callable: 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__.
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.

Function suitable for decorating the implementation of a NumPy function.

def array_function_from_dispatcher(implementation, module=None, verify=True, docs_from_dispatcher=True):

Like array_function_dispatcher, but with function arguments flipped.

def set_array_function_like_doc(public_api):

Undocumented

def set_module(module):

Decorator for overriding __module__ on a function or class.

Example usage:

@set_module('numpy')
def example():
    pass

assert example.__module__ == 'numpy'

def verify_matching_signatures(implementation, dispatcher):

Verify that a dispatcher function has the right signature.