ENH: show warning when np.maximum receives more than 2 inputs #29052
Conversation
There was a problem hiding this comment.
I wouldn't mind discussing whether we should start forcing out= more generally, since the overhead of using out= is pretty low now.
But maybe we say maximum is special, which is fine:
- You are doing twice the same thing in the same code.
- Do not just go to an error, this should go through a
DeprecationWarning. Maybe one can argue that it is almost always a bug and we go directly to aVisibleDeprecationWarning. But I am a bit skeptical, also becauseDeprecationWarningsare seen more these days anyway.
There was a problem hiding this comment.
I don't think this should happen just for maximum (though that discussion is perhaps best done in #27639).
But it certainly shouldn't be in the hot path for every ufunc -- instead, on l.4321 (original one), one could do
if NPY_UNLIKELY(len_args != nin) {
if (len_args <= nop) {
/* new deprecation stuff */
}
else {
PyErrFormat(...);
goto fail;
}
}
275aba6 to
e4d6fa4
Compare
| @@ -4325,7 +4343,28 @@ ufunc_generic_fastcall(PyUFuncObject *ufunc, | |||
| ufunc_get_name_cstr(ufunc) , nin, nop, len_args); | |||
| goto fail; | |||
| } | |||
| /* Extra positional args but *no* keywords? */ | |||
| if (len_args > nin && (kwnames == NULL || PyTuple_GET_SIZE(kwnames) == 0)) { | |||
There was a problem hiding this comment.
Maybe marten suggested it, but no, this isn't the right place, please look around a bit (further down).
|
|
||
| /* legal out? -> skip */ | ||
| if (PyArray_Check(extra) || extra == Py_None || | ||
| _is_sequence_of_arrays_or_None(extra)) { |
There was a problem hiding this comment.
What is this logic for? To me it would seem to mean that the PR achieves only a slightly clearer error message, which I don't think is what we want.
| "is deprecated; use out=keyword or np.maximum.reduce."); | ||
| PyErr_Format(PyExc_TypeError, | ||
| "np.maximum() takes exactly 2 input arguments (%zd given).", | ||
| len_args); |
There was a problem hiding this comment.
It doesn't make sense to warn and error. You should just give the warning and test it. A warning can be turned into an error, in which case yuo need extra logic.
| } | ||
| /* otherwise, if this is np.maximum, raise */ | ||
| else if (ufunc == UFUNC_MAXIMUM) { | ||
| PyErr_WarnFormat(PyExc_DeprecationWarning, 1, |
There was a problem hiding this comment.
Can use DEPRECATE macro, also should include the deprecating NumPy version in the message and as a comment above, like /* DEPRECATED NumPy ..., 2025-... */
attempts to resolve #27639