Merge branch 'main' into 2.0-highlights

[skip actions] [skip azp] [skip cirrus]

Author: rgommers

.circleci/config.yml

@@ -68,16 +68,6 @@ jobs:
             towncrier build --version $VERSION --yes
             ./tools/ci/test_all_newsfragments_used.py
 
-      - run:
-          name: run doctests on documentation
-          command: |
-            . venv/bin/activate
-            # Note: keep these two checks separate, because they seem to
-            # influence each other through changing global state (e.g., via
-            # `np.polynomial.set_default_printstyle`)
-            python tools/refguide_check.py --rst
-            python tools/refguide_check.py --doctests
-
       - run:
           name: build devdocs w/ref warnings
           command: |
@@ -104,6 +94,16 @@ jobs:
           path: doc/neps/_build/html/
      #      destination: neps
 
+      - run:
+          name: run doctests on documentation
+          command: |
+            . venv/bin/activate
+            # Note: keep these two checks separate, because they seem to
+            # influence each other through changing global state (e.g., via
+            # `np.polynomial.set_default_printstyle`)
+            python tools/refguide_check.py --rst
+            python tools/refguide_check.py --doctests
+
       - persist_to_workspace:
           root: ~/repo
           paths:

.github/workflows/wheels.yml

@@ -159,7 +159,7 @@ jobs:
           name: ${{ matrix.python }}-${{ matrix.buildplat[1] }}-${{ matrix.buildplat[2] }}
           path: ./wheelhouse/*.whl
 
-      - uses: mamba-org/setup-micromamba@v1
+      - uses: mamba-org/setup-micromamba@422500192359a097648154e8db4e39bdb6c6eed7
         with:
           # for installation of anaconda-client, required for upload to
           # anaconda.org

doc/release/upcoming_changes/21760.compatibility.rst

@@ -0,0 +1,6 @@
+Modified representation for ``Polynomial``
+------------------------------------------
+The representation method for `numpy.polynomial.Polynomial` was updated to include the domain in the representation.
+The plain text and latex representations are now consistent.
+For example the output of ``str(np.polynomial.Polynomial([1, 1], domain=[.1, .2]))`` used to be ``1.0 + 1.0 x``, but 
+now is ``1.0 + 1.0 (-3.0000000000000004 + 20.0 x)``.

doc/source/numpy_2_0_migration_guide.rst

@@ -117,6 +117,7 @@ dtype/descriptor itself is attached to an array (e.g. ``arr->descr->elsize``)
 this is best replaced with ``PyArray_ITEMSIZE(arr)``.
 
 Where not possible, new accessor functions are required:
+
 * ``PyDataType_ELSIZE`` and ``PyDataType_SET_ELSIZE`` (note that the result
   is now ``npy_intp`` and not ``int``).
 * ``PyDataType_ALIGNENT``

doc/source/reference/c-api/array.rst

@@ -38,13 +38,32 @@ and its sub-types).
 
     Return the (builtin) typenumber for the elements of this array.
 
+.. c:function:: int PyArray_Pack(  \
+        const PyArray_Descr *descr, void *item, const PyObject *value)
+
+    .. versionadded:: 2.0
+
+    Sets the memory location ``item`` of dtype ``descr`` to ``value``.
+
+    The function is equivalent to setting a single array element with a Python
+    assignment.  Returns 0 on success and -1 with an error set on failure.
+
+    .. note::
+        If the ``descr`` has the :c:data:`NPY_NEEDS_INIT` flag set, the
+        data must be valid or the memory zeroed.
+
 .. c:function:: int PyArray_SETITEM( \
         PyArrayObject* arr, void* itemptr, PyObject* obj)
 
     Convert obj and place it in the ndarray, *arr*, at the place
     pointed to by itemptr. Return -1 if an error occurs or 0 on
     success.
 
+    .. note::
+        In general, prefer the use of :c:func:`PyArray_Pack` when
+        handling arbitrary Python objects.  Setitem is for example not able
+        to handle arbitrary casts between different dtypes.
+
 .. c:function:: void PyArray_ENABLEFLAGS(PyArrayObject* arr, int flags)
 
     .. versionadded:: 1.7
@@ -762,7 +781,7 @@ cannot not be accessed directly.
 .. versionchanged:: 2.0
     Prior to NumPy 2.0 the ABI was different but unnecessary large for user
     DTypes.  These accessors were all added in 2.0 and can be backported
-    (see :ref:`_migration_c_descr`).
+    (see :ref:`migration_c_descr`).
 
 .. c:function:: npy_intp PyDataType_ELSIZE(PyArray_Descr *descr)
 

doc/source/reference/c-api/types-and-structures.rst

@@ -290,7 +290,7 @@ PyArrayDescr_Type and PyArray_Descr
           npy_intp alignment;
           NpyAuxData *c_metadata;
           npy_hash_t hash;
-          void *reserved_null;  // unused field, must be NULL.
+          void *reserved_null[2];  // unused field, must be NULLed.
       } PyArray_Descr;
 
    Some dtypes have additional members which are accessible through

doc/source/release/2.0.0-notes.rst

@@ -467,6 +467,12 @@ C API changes
 
   (`gh-25789 <https://github.com/numpy/numpy/pull/25789>`__)
 
+* NumPy now defines :c:function:`PyArray_Pack` to set an individual memory
+  address.  Unlike ``PyArray_SETITEM`` this function is equivalent to setting
+  an individual array item and does not require a NumPy array input.
+
+  (`gh-25954 <https://github.com/numpy/numpy/pull/25954>`__)
+
 * The ``->f`` slot has been removed from ``PyArray_Descr``.
   If you use this slot, replace accessing it with
   ``PyDataType_GetArrFuncs`` (see its documentation and the

numpy/__init__.cython-30.pxd

@@ -289,14 +289,31 @@ cdef extern from "numpy/arrayobject.h":
         # directly accessing this field.
         cdef char byteorder
         cdef int type_num
-        cdef int itemsize "elsize"
-        cdef int alignment
-        cdef object fields
-        cdef tuple names
+
+        @property
+        cdef inline npy_intp itemsize(self) nogil:
+            return PyDataType_ELSIZE(self)
+
+        @property
+        cdef inline npy_intp alignment(self) nogil:
+            return PyDataType_ALIGNMENT(self)
+
+        # Use fields/names with care as they may be NULL.  You must check
+        # for this using PyDataType_HASFIELDS.
+        @property
+        cdef inline object fields(self):
+            return <object>PyDataType_FIELDS(self)
+
+        @property
+        cdef inline tuple names(self):
+            return <tuple>PyDataType_NAMES(self)
+
         # Use PyDataType_HASSUBARRAY to test whether this field is
         # valid (the pointer can be NULL). Most users should access
         # this field via the inline helper method PyDataType_SHAPE.
-        cdef PyArray_ArrayDescr* subarray
+        @property
+        cdef inline PyArray_ArrayDescr* subarray(self) nogil:
+            return PyDataType_SUBARRAY(self)
 
         @property
         cdef inline npy_uint64 flags(self) nogil:
@@ -455,6 +472,13 @@ cdef extern from "numpy/arrayobject.h":
     bint PyTypeNum_ISEXTENDED(int) nogil
     bint PyTypeNum_ISOBJECT(int) nogil
 
+    npy_intp PyDataType_ELSIZE(dtype) nogil
+    npy_intp PyDataType_ALIGNMENT(dtype) nogil
+    PyObject* PyDataType_METADATA(dtype) nogil
+    PyArray_ArrayDescr* PyDataType_SUBARRAY(dtype) nogil
+    PyObject* PyDataType_NAMES(dtype) nogil
+    PyObject* PyDataType_FIELDS(dtype) nogil
+
     bint PyDataType_ISBOOL(dtype) nogil
     bint PyDataType_ISUNSIGNED(dtype) nogil
     bint PyDataType_ISSIGNED(dtype) nogil

numpy/__init__.pxd

@@ -286,14 +286,9 @@ cdef extern from "numpy/arrayobject.h":
         # Flags are not directly accessible on Cython <3. Use PyDataType_FLAGS.
         # cdef char flags
         cdef int type_num
-        cdef int itemsize "elsize"
-        cdef int alignment
-        cdef object fields
-        cdef tuple names
-        # Use PyDataType_HASSUBARRAY to test whether this field is
-        # valid (the pointer can be NULL). Most users should access
-        # this field via the inline helper method PyDataType_SHAPE.
-        cdef PyArray_ArrayDescr* subarray
+        # itemsize/elsize, alignment, fields, names, and subarray must
+        # use the `PyDataType_*` accessor macros. With Cython 3 you can
+        # still use getter attributes `dtype.itemsize`
 
     ctypedef class numpy.flatiter [object PyArrayIterObject, check_size ignore]:
         # Use through macros
@@ -375,6 +370,14 @@ cdef extern from "numpy/arrayobject.h":
     bint PyTypeNum_ISEXTENDED(int) nogil
     bint PyTypeNum_ISOBJECT(int) nogil
 
+    npy_intp PyDataType_ELSIZE(dtype) nogil
+    void PyDataType_SET_ELSIZE(dtype, npy_intp) nogil
+    npy_intp PyDataType_ALIGNMENT(dtype) nogil
+    PyObject* PyDataType_METADATA(dtype) nogil
+    PyArray_ArrayDescr* PyDataType_SUBARRAY(dtype) nogil
+    PyObject* PyDataType_NAMES(dtype) nogil
+    PyObject* PyDataType_FIELDS(dtype) nogil
+
     bint PyDataType_ISBOOL(dtype) nogil
     bint PyDataType_ISUNSIGNED(dtype) nogil
     bint PyDataType_ISSIGNED(dtype) nogil

numpy/_core/_add_newdocs.py

@@ -1698,7 +1698,7 @@
 
 add_newdoc('numpy._core.multiarray', 'arange',
     """
-    arange(start, / [, stop[, step,], dtype=None, *, device=None,, like=None)
+    arange([start,] stop[, step,], dtype=None, *, device=None, like=None)
 
     Return evenly spaced values within a given interval.