diff options
| author | Sebastian Berg <sebastian@sipsolutions.net> | 2020-08-11 19:13:05 -0500 |
|---|---|---|
| committer | Sebastian Berg <sebastian@sipsolutions.net> | 2020-08-11 19:13:05 -0500 |
| commit | 0328a8c3d4b734be8a4be82ab85f1971093da3da (patch) | |
| tree | a49e49b57e32106cb21a4570f092b1592f063304 | |
| parent | 101192cbb5eedd8da97237a73ef2754fb9c65ddf (diff) | |
| download | numpy-0328a8c3d4b734be8a4be82ab85f1971093da3da.tar.gz | |
DOC: Add release note for casting error changes
| -rw-r--r-- | doc/release/upcoming_changes/17029.compatibility.rst | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/release/upcoming_changes/17029.compatibility.rst b/doc/release/upcoming_changes/17029.compatibility.rst new file mode 100644 index 000000000..351b228a8 --- /dev/null +++ b/doc/release/upcoming_changes/17029.compatibility.rst @@ -0,0 +1,23 @@ +Casting errors interrupt Iteration +---------------------------------- +NumPy sometimes has issues reporting errors during casting +correctly. This is rare, since the vast majority of casts +will never result in errors. +However, in some cases of casting errors less of the result +may be written back. The state of arrays involved in errors +should *always* be considered undefined. +Possible changes occur for: + +* Universal functions when casting is unsafe (rare) +* Advanced index assignments +* The lowlevel `numpy.nditer` API. + +For users of the ``NpyIter`` C-API such cast errors will now +cause the `iternext()` function to return 0 and thus abort +iteration. +Currently, there is no API to detect such an error directly. +It is necessary to check ``PyErr_Occurred()``, which +may be problematic in combination with ``NpyIter_Reset``. +These issues always existed, but new API could be added +if required by users. + |
