Remove again layout

* Remove layout parameter of PyLongWriter_Create() * Remove layout member of PyLong_DigitArray structure
python · vstinner · Dec 13, 2024 · Jul 2, 2024 · Jul 23, 2024 · Sep 3, 2024
commit 07552a71ca2e209c9482a5d6263612a7c171cc19
diff --git a/Doc/c-api/long.rst b/Doc/c-api/long.rst
@@ -689,10 +689,6 @@ Export API
 
       Read-only array of unsigned digits.
 
-   .. c:member:: const PyLongLayout *layout
-
-      Layout of the :c:member:`digits`.
-
 
 .. c:function:: int PyLong_AsDigitArray(PyObject *obj, PyLong_DigitArray *array)
 
@@ -727,7 +723,7 @@ The :c:type:`PyLongWriter` API can be used to import an integer.
    The instance must be destroyed by :c:func:`PyLongWriter_Finish`.
 
 
-.. c:function:: PyLongWriter* PyLongWriter_Create(int negative, size_t ndigits, void **digits, const PyLongLayout *layout)
+.. c:function:: PyLongWriter* PyLongWriter_Create(int negative, size_t ndigits, void **digits)
 
    Create a :c:type:`PyLongWriter`.
 

diff --git a/Include/cpython/longintrepr.h b/Include/cpython/longintrepr.h
@@ -168,7 +168,6 @@ typedef struct PyLong_DigitArray {
     int negative;
     size_t ndigits;
     const void *digits;
-    const PyLongLayout *layout;
 } PyLong_DigitArray;
 
 PyAPI_FUNC(int) PyLong_AsDigitArray(
@@ -185,8 +184,7 @@ typedef struct PyLongWriter PyLongWriter;
 PyAPI_FUNC(PyLongWriter*) PyLongWriter_Create(
     int negative,
     size_t ndigits,
-    void **digits,
-    const PyLongLayout *layout);
+    void **digits);
 PyAPI_FUNC(PyObject*) PyLongWriter_Finish(PyLongWriter *writer);
 PyAPI_FUNC(void) PyLongWriter_Discard(PyLongWriter *writer);
 

diff --git a/Lib/test/test_capi/test_long.py b/Lib/test/test_capi/test_long.py
@@ -687,11 +687,11 @@ def test_long_export(self):
         base = 2 ** layout['bits_per_digit']
 
         pylong_asdigitarray = _testcapi.pylong_asdigitarray
-        self.assertEqual(pylong_asdigitarray(0), (0, [0], layout))
-        self.assertEqual(pylong_asdigitarray(123), (0, [123], layout))
-        self.assertEqual(pylong_asdigitarray(-123), (1, [123], layout))
+        self.assertEqual(pylong_asdigitarray(0), (0, [0]))
+        self.assertEqual(pylong_asdigitarray(123), (0, [123]))
+        self.assertEqual(pylong_asdigitarray(-123), (1, [123]))
         self.assertEqual(pylong_asdigitarray(base**2 * 3 + base * 2 + 1),
-                         (0, [1, 2, 3], layout))
+                         (0, [1, 2, 3]))
 
         with self.assertRaises(TypeError):
             pylong_asdigitarray(1.0)
@@ -706,24 +706,24 @@ def test_longwriter_create(self):
         base = 2 ** layout['bits_per_digit']
 
         pylongwriter_create = _testcapi.pylongwriter_create
-        self.assertEqual(pylongwriter_create(0, [], layout), 0)
-        self.assertEqual(pylongwriter_create(0, [0], layout), 0)
-        self.assertEqual(pylongwriter_create(0, [123], layout), 123)
-        self.assertEqual(pylongwriter_create(1, [123], layout), -123)
-        self.assertEqual(pylongwriter_create(1, [1, 2], layout),
+        self.assertEqual(pylongwriter_create(0, []), 0)
+        self.assertEqual(pylongwriter_create(0, [0]), 0)
+        self.assertEqual(pylongwriter_create(0, [123]), 123)
+        self.assertEqual(pylongwriter_create(1, [123]), -123)
+        self.assertEqual(pylongwriter_create(1, [1, 2]),
                          -(base * 2 + 1))
-        self.assertEqual(pylongwriter_create(0, [1, 2, 3], layout),
+        self.assertEqual(pylongwriter_create(0, [1, 2, 3]),
                          base**2 * 3 + base * 2 + 1)
         max_digit = base - 1
-        self.assertEqual(pylongwriter_create(0, [max_digit, max_digit, max_digit], layout),
+        self.assertEqual(pylongwriter_create(0, [max_digit, max_digit, max_digit]),
                          base**2 * max_digit + base * max_digit + max_digit)
 
         # normalize
-        self.assertEqual(pylongwriter_create(0, [123, 0, 0], layout), 123)
+        self.assertEqual(pylongwriter_create(0, [123, 0, 0]), 123)
 
         # test singletons + normalize
         for num in (-2, 0, 1, 5, 42, 100):
-            self.assertIs(pylongwriter_create(bool(num < 0), [abs(num), 0], layout),
+            self.assertIs(pylongwriter_create(bool(num < 0), [abs(num), 0]),
                           num)
 
         # round trip: Python int -> export -> Python int
@@ -732,29 +732,9 @@ def test_longwriter_create(self):
         numbers.extend(-num for num in list(numbers))
         for num in numbers:
             with self.subTest(num=num):
-                negative, digits, layout = pylong_asdigitarray(num)
-                self.assertEqual(pylongwriter_create(negative, digits, layout), num,
-                                 (negative, digits, layout))
-
-        # invalid layout
-        with self.assertRaises(ValueError):
-            layout = _testcapi.get_pylong_layout()
-            layout['bits_per_digit'] += 1
-            pylongwriter_create(0, [123], layout)
-        with self.assertRaises(ValueError):
-            layout = _testcapi.get_pylong_layout()
-            layout['digit_size'] *= 2
-            pylongwriter_create(0, [123], layout)
-        def change_endian(endian):
-            return (-endian if endian else 1)
-        with self.assertRaises(ValueError):
-            layout = _testcapi.get_pylong_layout()
-            layout['digits_order'] = change_endian(layout['digits_order'])
-            pylongwriter_create(0, [123], layout)
-        with self.assertRaises(ValueError):
-            layout = _testcapi.get_pylong_layout()
-            layout['endian'] = change_endian(layout['endian'])
-            pylongwriter_create(0, [123], layout)
+                negative, digits = pylong_asdigitarray(num)
+                self.assertEqual(pylongwriter_create(negative, digits), num,
+                                 (negative, digits))
 
 
 if __name__ == "__main__":

diff --git a/Modules/_testcapi/long.c b/Modules/_testcapi/long.c
@@ -173,71 +173,6 @@ layout_to_dict(const PyLongLayout *layout)
 }
 
 
-static int
-layout_from_dict_get(PyObject *dict, const char *key, int is_signed, long *pvalue)
-{
-    PyObject *item;
-    int res = PyDict_GetItemStringRef(dict, key, &item);
-    if (res <= 0) {
-        return -1;
-    }
-
-    long value = PyLong_AsLong(item);
-    Py_DECREF(item);
-    if (value == -1 && PyErr_Occurred()) {
-        return -1;
-    }
-
-    if (is_signed) {
-        if (value < INT8_MIN || value > INT8_MAX) {
-            return -1;
-        }
-    }
-    else {
-        if (value < 0 || value > (long)UINT8_MAX) {
-            return -1;
-        }
-    }
-
-    *pvalue = value;
-    return 0;
-}
-
-
-static int
-layout_from_dict(PyLongLayout *layout, PyObject *dict)
-{
-    long value;
-    if (layout_from_dict_get(dict, "bits_per_digit", 0, &value) < 0) {
-        goto error;
-    }
-    layout->bits_per_digit = (uint8_t)value;
-
-    if (layout_from_dict_get(dict, "digit_size", 0, &value) < 0) {
-        goto error;
-    }
-    layout->digit_size = (uint8_t)value;
-
-    if (layout_from_dict_get(dict, "digits_order", 1, &value) < 0) {
-        goto error;
-    }
-    layout->digits_order = (int8_t)value;
-
-    if (layout_from_dict_get(dict, "endian", 1, &value) < 0) {
-        goto error;
-    }
-    layout->endian = (int8_t)value;
-
-    return 0;
-
-error:
-    if (!PyErr_Occurred()) {
-        PyErr_SetString(PyExc_ValueError, "invalid layout");
-    }
-    return -1;
-}
-
-
 static PyObject *
 pylong_asdigitarray(PyObject *module, PyObject *obj)
 {
@@ -246,7 +181,7 @@ pylong_asdigitarray(PyObject *module, PyObject *obj)
         return NULL;
     }
 
-    assert(array.layout->digit_size == sizeof(Py_digit));
+    assert(PyLong_GetNativeLayout()->digit_size == sizeof(Py_digit));
     const Py_digit *array_digits = array.digits;
 
     PyObject *digits = PyList_New(0);
@@ -264,12 +199,7 @@ pylong_asdigitarray(PyObject *module, PyObject *obj)
         Py_DECREF(digit);
     }
 
-    PyObject *layout_dict = layout_to_dict(array.layout);
-    if (layout_dict == NULL) {
-        goto error;
-    }
-
-    PyObject *res = Py_BuildValue("(iNN)", array.negative, digits, layout_dict);
+    PyObject *res = Py_BuildValue("(iN)", array.negative, digits);
     PyLong_FreeDigitArray(&array);
     return res;
 
@@ -284,22 +214,15 @@ static PyObject *
 pylongwriter_create(PyObject *module, PyObject *args)
 {
     int negative;
-    PyObject *list, *layout_dict;
-    if (!PyArg_ParseTuple(args, "iO!O!",
+    PyObject *list;
+    if (!PyArg_ParseTuple(args, "iO!",
                           &negative,
-                          &PyList_Type, &list,
-                          &PyDict_Type, &layout_dict))
+                          &PyList_Type, &list))
     {
         return NULL;
     }
     Py_ssize_t ndigits = PyList_GET_SIZE(list);
 
-    PyLongLayout layout;
-    memset(&layout, 0, sizeof(layout));
-    if (layout_from_dict(&layout, layout_dict) < 0) {
-        return NULL;
-    }
-
     Py_digit *digits = PyMem_Malloc(ndigits * sizeof(Py_digit));
     if (digits == NULL) {
         PyErr_NoMemory();
@@ -323,11 +246,11 @@ pylongwriter_create(PyObject *module, PyObject *args)
 
     void *writer_digits;
     PyLongWriter *writer = PyLongWriter_Create(negative, (size_t)ndigits,
-                                               &writer_digits, &layout);
+                                               &writer_digits);
     if (writer == NULL) {
         goto error;
     }
-    assert(layout.digit_size == sizeof(Py_digit));
+    assert(PyLong_GetNativeLayout()->digit_size == sizeof(Py_digit));
     memcpy(writer_digits, digits, ndigits * sizeof(Py_digit));
     PyObject *res = PyLongWriter_Finish(writer);
     PyMem_Free(digits);

diff --git a/Objects/longobject.c b/Objects/longobject.c
@@ -6806,7 +6806,6 @@ PyLong_AsDigitArray(PyObject *obj, PyLong_DigitArray *array)
         array->ndigits = 1;
     }
     array->digits = self->long_value.ob_digit;
-    array->layout = &PyLong_LAYOUT;
     return 0;
 }
 
@@ -6823,17 +6822,9 @@ PyLong_FreeDigitArray(PyLong_DigitArray *array)
 
 /* --- PyLongWriter API --------------------------------------------------- */
 
-PyLongWriter* PyLongWriter_Create(int negative, size_t ndigits, void **digits,
-                                  const PyLongLayout *layout)
+PyLongWriter* PyLongWriter_Create(int negative, size_t ndigits, void **digits)
 {
     assert(digits != NULL);
-    // First, compare pointers (fast-path) since it's faster
-    if (layout != &PyLong_LAYOUT
-        && (memcmp(layout, &PyLong_LAYOUT, sizeof(*layout)) != 0))
-    {
-        PyErr_SetString(PyExc_ValueError, "only the native layout is supported");
-        return NULL;
-    }
 
     if (ndigits > (size_t)PY_SSIZE_T_MAX) {
         PyErr_SetString(PyExc_OverflowError,