MAINT: remove wrapper functions from numpy.core.multiarray #12470
Conversation
The original motivation for the style of these wrapper functions, introduced in numpygh-12175, was to preserve introspection. But it turns out NumPy's functions defined in C don't support introspection anyways, so the extra wrapper functions are entirely pointless. This version reverts the additional wrapper functions, which put default arguments in two places and introduced slow-down due to the overhead of another function call. I've retained docstrings in multiarray.py, since it's definitely more readable to keep docstrings and dispatchers together rather than leaving docstrings in _add_newdocs.py. One bonus of this approach is that dispatcher functions have the same name as their implementations, so `np.concatenate(unknown=True)` gives an error message mentioning "concatenate" rather than "_concatenate_dispatcher": `TypeError: concatenate() got an unexpected keyword argument 'unknown'`
|
Might the C functions ever support introspection? That is, is it possible to set |
|
Actually, I think that last time it was discussed, it wasn't feasible to remove the signatures from the docstrings because |
|
@ahaldane The good part about this current approach is that if we ever do add signatures on C functions, they'll get copied over onto the generated dispatched functions. To be honest, I'm not sure what I was thinking for adding this extra layers of indirection at all. |
| @@ -1158,6 +1158,27 @@ arr_unravel_index(PyObject *self, PyObject *args, PyObject *kwds) | |||
|
|
|||
| char *kwlist[] = {"indices", "shape", "order", NULL}; | |||
|
|
|||
| /* TODO: remove this in favor of warning raised in the dispatcher when | |||
There was a problem hiding this comment.
The style for multiline comments is
/*
* blah
* blah
*/
|
Thanks Stephan. |
The original motivation for the style of these wrapper functions, introduced
in gh-12175, was to preserve introspection. But it turns out NumPy's functions
defined in C don't support introspection anyways, so the extra wrapper
functions are entirely pointless.
This version reverts the additional wrapper functions, which put default
arguments in two places and introduced slow-down due to the overhead of
another function call.
I've retained docstrings in multiarray.py, since it's definitely more readable
to keep docstrings and dispatchers together rather than leaving docstrings in
_add_newdocs.py.
One bonus of this approach is that dispatcher functions have the same name
as their implementations, so
np.concatenate(unknown=True)gives anerror message mentioning "concatenate" rather than "_concatenate_dispatcher":
TypeError: concatenate() got an unexpected keyword argument 'unknown'