]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-106320: Remove private PyLong C API functions (#108429)
authorVictor Stinner <vstinner@python.org>
Thu, 24 Aug 2023 16:53:50 +0000 (18:53 +0200)
committerGitHub <noreply@github.com>
Thu, 24 Aug 2023 16:53:50 +0000 (18:53 +0200)
Remove private PyLong C API functions:

* _PyLong_AsByteArray()
* _PyLong_DivmodNear()
* _PyLong_Format()
* _PyLong_Frexp()
* _PyLong_FromByteArray()
* _PyLong_FromBytes()
* _PyLong_GCD()
* _PyLong_Lshift()
* _PyLong_Rshift()

Move these functions to the internal C API. No longer export
_PyLong_FromBytes() function.

Include/cpython/longobject.h
Include/internal/pycore_long.h
Modules/_io/_iomodule.c
Modules/_pickle.c
Modules/_randommodule.c
Modules/_sqlite/util.c
Modules/_struct.c
Modules/arraymodule.c
Modules/cjkcodecs/multibytecodec.c
Python/hamt.c

index 90cc0f267ae8333dd8b93d1a91b805e4e7a524fe..c581f51cbcdf3898861fdced337792710cc460ae 100644 (file)
@@ -10,16 +10,7 @@ PyAPI_FUNC(int) _PyLong_UnsignedLong_Converter(PyObject *, void *);
 PyAPI_FUNC(int) _PyLong_UnsignedLongLong_Converter(PyObject *, void *);
 PyAPI_FUNC(int) _PyLong_Size_t_Converter(PyObject *, void *);
 
-/* _PyLong_Frexp returns a double x and an exponent e such that the
-   true value is approximately equal to x * 2**e.  e is >= 0.  x is
-   0.0 if and only if the input is 0 (in which case, e and x are both
-   zeroes); otherwise, 0.5 <= abs(x) < 1.0.  On overflow, which is
-   possible if the number of bits doesn't fit into a Py_ssize_t, sets
-   OverflowError and returns -1.0 for x, 0 for e. */
-PyAPI_FUNC(double) _PyLong_Frexp(PyLongObject *a, Py_ssize_t *e);
-
-PyAPI_FUNC(PyObject *) PyLong_FromUnicodeObject(PyObject *u, int base);
-PyAPI_FUNC(PyObject *) _PyLong_FromBytes(const char *, Py_ssize_t, int);
+PyAPI_FUNC(PyObject*) PyLong_FromUnicodeObject(PyObject *u, int base);
 
 /* _PyLong_Sign.  Return 0 if v is 0, -1 if v < 0, +1 if v > 0.
    v must not be NULL, and must be a normalized long.
@@ -36,65 +27,6 @@ PyAPI_FUNC(int) _PyLong_Sign(PyObject *v);
 */
 PyAPI_FUNC(size_t) _PyLong_NumBits(PyObject *v);
 
-/* _PyLong_DivmodNear.  Given integers a and b, compute the nearest
-   integer q to the exact quotient a / b, rounding to the nearest even integer
-   in the case of a tie.  Return (q, r), where r = a - q*b.  The remainder r
-   will satisfy abs(r) <= abs(b)/2, with equality possible only if q is
-   even.
-*/
-PyAPI_FUNC(PyObject *) _PyLong_DivmodNear(PyObject *, PyObject *);
-
-/* _PyLong_FromByteArray:  View the n unsigned bytes as a binary integer in
-   base 256, and return a Python int with the same numeric value.
-   If n is 0, the integer is 0.  Else:
-   If little_endian is 1/true, bytes[n-1] is the MSB and bytes[0] the LSB;
-   else (little_endian is 0/false) bytes[0] is the MSB and bytes[n-1] the
-   LSB.
-   If is_signed is 0/false, view the bytes as a non-negative integer.
-   If is_signed is 1/true, view the bytes as a 2's-complement integer,
-   non-negative if bit 0x80 of the MSB is clear, negative if set.
-   Error returns:
-   + Return NULL with the appropriate exception set if there's not
-     enough memory to create the Python int.
-*/
-PyAPI_FUNC(PyObject *) _PyLong_FromByteArray(
-    const unsigned char* bytes, size_t n,
-    int little_endian, int is_signed);
-
-/* _PyLong_AsByteArray: Convert the least-significant 8*n bits of long
-   v to a base-256 integer, stored in array bytes.  Normally return 0,
-   return -1 on error.
-   If little_endian is 1/true, store the MSB at bytes[n-1] and the LSB at
-   bytes[0]; else (little_endian is 0/false) store the MSB at bytes[0] and
-   the LSB at bytes[n-1].
-   If is_signed is 0/false, it's an error if v < 0; else (v >= 0) n bytes
-   are filled and there's nothing special about bit 0x80 of the MSB.
-   If is_signed is 1/true, bytes is filled with the 2's-complement
-   representation of v's value.  Bit 0x80 of the MSB is the sign bit.
-   Error returns (-1):
-   + is_signed is 0 and v < 0.  TypeError is set in this case, and bytes
-     isn't altered.
-   + n isn't big enough to hold the full mathematical value of v.  For
-     example, if is_signed is 0 and there are more digits in the v than
-     fit in n; or if is_signed is 1, v < 0, and n is just 1 bit shy of
-     being large enough to hold a sign bit.  OverflowError is set in this
-     case, but bytes holds the least-significant n bytes of the true value.
-*/
-PyAPI_FUNC(int) _PyLong_AsByteArray(PyLongObject* v,
-    unsigned char* bytes, size_t n,
-    int little_endian, int is_signed);
-
-/* _PyLong_Format: Convert the long to a string object with given base,
-   appending a base prefix of 0[box] if base is 2, 8 or 16. */
-PyAPI_FUNC(PyObject *) _PyLong_Format(PyObject *obj, int base);
-
-/* For use by the gcd function in mathmodule.c */
-PyAPI_FUNC(PyObject *) _PyLong_GCD(PyObject *, PyObject *);
-
-PyAPI_FUNC(PyObject *) _PyLong_Rshift(PyObject *, size_t);
-PyAPI_FUNC(PyObject *) _PyLong_Lshift(PyObject *, size_t);
-
-
 PyAPI_FUNC(int) PyUnstable_Long_IsCompact(const PyLongObject* op);
 PyAPI_FUNC(Py_ssize_t) PyUnstable_Long_CompactValue(const PyLongObject* op);
 
index 4eb70f7e3709dc5f12391704db075245a411d80e..a76494808bffdddfe301ad803fabf778366055ee 100644 (file)
@@ -79,9 +79,87 @@ static inline PyObject* _PyLong_FromUnsignedChar(unsigned char i)
     return (PyObject *)&_PyLong_SMALL_INTS[_PY_NSMALLNEGINTS+i];
 }
 
-extern PyObject *_PyLong_Add(PyLongObject *left, PyLongObject *right);
-extern PyObject *_PyLong_Multiply(PyLongObject *left, PyLongObject *right);
-extern PyObject *_PyLong_Subtract(PyLongObject *left, PyLongObject *right);
+// _PyLong_Frexp returns a double x and an exponent e such that the
+// true value is approximately equal to x * 2**e.  e is >= 0.  x is
+// 0.0 if and only if the input is 0 (in which case, e and x are both
+// zeroes); otherwise, 0.5 <= abs(x) < 1.0.  On overflow, which is
+// possible if the number of bits doesn't fit into a Py_ssize_t, sets
+// OverflowError and returns -1.0 for x, 0 for e.
+//
+// Export for 'math' shared extension
+PyAPI_DATA(double) _PyLong_Frexp(PyLongObject *a, Py_ssize_t *e);
+
+extern PyObject* _PyLong_FromBytes(const char *, Py_ssize_t, int);
+
+// _PyLong_DivmodNear.  Given integers a and b, compute the nearest
+// integer q to the exact quotient a / b, rounding to the nearest even integer
+// in the case of a tie.  Return (q, r), where r = a - q*b.  The remainder r
+// will satisfy abs(r) <= abs(b)/2, with equality possible only if q is
+// even.
+//
+// Export for '_datetime' shared extension.
+PyAPI_DATA(PyObject*) _PyLong_DivmodNear(PyObject *, PyObject *);
+
+// _PyLong_FromByteArray:  View the n unsigned bytes as a binary integer in
+// base 256, and return a Python int with the same numeric value.
+// If n is 0, the integer is 0.  Else:
+// If little_endian is 1/true, bytes[n-1] is the MSB and bytes[0] the LSB;
+// else (little_endian is 0/false) bytes[0] is the MSB and bytes[n-1] the
+// LSB.
+// If is_signed is 0/false, view the bytes as a non-negative integer.
+// If is_signed is 1/true, view the bytes as a 2's-complement integer,
+// non-negative if bit 0x80 of the MSB is clear, negative if set.
+// Error returns:
+// + Return NULL with the appropriate exception set if there's not
+//   enough memory to create the Python int.
+//
+// Export for '_multibytecodec' shared extension.
+PyAPI_DATA(PyObject*) _PyLong_FromByteArray(
+    const unsigned char* bytes, size_t n,
+    int little_endian, int is_signed);
+
+// _PyLong_AsByteArray: Convert the least-significant 8*n bits of long
+// v to a base-256 integer, stored in array bytes.  Normally return 0,
+// return -1 on error.
+// If little_endian is 1/true, store the MSB at bytes[n-1] and the LSB at
+// bytes[0]; else (little_endian is 0/false) store the MSB at bytes[0] and
+// the LSB at bytes[n-1].
+// If is_signed is 0/false, it's an error if v < 0; else (v >= 0) n bytes
+// are filled and there's nothing special about bit 0x80 of the MSB.
+// If is_signed is 1/true, bytes is filled with the 2's-complement
+// representation of v's value.  Bit 0x80 of the MSB is the sign bit.
+// Error returns (-1):
+// + is_signed is 0 and v < 0.  TypeError is set in this case, and bytes
+//   isn't altered.
+// + n isn't big enough to hold the full mathematical value of v.  For
+//   example, if is_signed is 0 and there are more digits in the v than
+//   fit in n; or if is_signed is 1, v < 0, and n is just 1 bit shy of
+//   being large enough to hold a sign bit.  OverflowError is set in this
+//   case, but bytes holds the least-significant n bytes of the true value.
+//
+// Export for '_struct' shared extension.
+PyAPI_DATA(int) _PyLong_AsByteArray(PyLongObject* v,
+    unsigned char* bytes, size_t n,
+    int little_endian, int is_signed);
+
+// _PyLong_Format: Convert the long to a string object with given base,
+// appending a base prefix of 0[box] if base is 2, 8 or 16.
+// Export for '_tkinter' shared extension.
+PyAPI_DATA(PyObject*) _PyLong_Format(PyObject *obj, int base);
+
+// For use by the math.gcd() function.
+// Export for 'math' shared extension.
+PyAPI_DATA(PyObject*) _PyLong_GCD(PyObject *, PyObject *);
+
+// Export for 'math' shared extension
+PyAPI_DATA(PyObject*) _PyLong_Rshift(PyObject *, size_t);
+
+// Export for 'math' shared extension
+PyAPI_DATA(PyObject*) _PyLong_Lshift(PyObject *, size_t);
+
+extern PyObject* _PyLong_Add(PyLongObject *left, PyLongObject *right);
+extern PyObject* _PyLong_Multiply(PyLongObject *left, PyLongObject *right);
+extern PyObject* _PyLong_Subtract(PyLongObject *left, PyLongObject *right);
 
 // Export for 'binascii' shared extension.
 PyAPI_DATA(unsigned char) _PyLong_DigitValue[256];
index 1a7920eebe0b611b46a48153d32445173aa78331..f56654227f1020b2d3f61226c1cdebc0eaa8a452 100644 (file)
@@ -8,9 +8,10 @@
 */
 
 #include "Python.h"
-#include "_iomodule.h"
-#include "pycore_pystate.h"       // _PyInterpreterState_GET()
 #include "pycore_initconfig.h"    // _PyStatus_OK()
+#include "pycore_pystate.h"       // _PyInterpreterState_GET()
+
+#include "_iomodule.h"
 
 #ifdef HAVE_SYS_TYPES_H
 #include <sys/types.h>
index c2b04cc513a6646737191d3b166fcfddd3d269cf..4f26ffe27d75f1fe416abef75e9c02f106672e63 100644 (file)
@@ -11,6 +11,7 @@
 #include "Python.h"
 #include "pycore_bytesobject.h"   // _PyBytesWriter
 #include "pycore_ceval.h"         // _Py_EnterRecursiveCall()
+#include "pycore_long.h"          // _PyLong_AsByteArray()
 #include "pycore_moduleobject.h"  // _PyModule_GetState()
 #include "pycore_object.h"        // _PyNone_Type
 #include "pycore_pystate.h"       // _PyThreadState_GET()
index 7daa1f9327966fa3b9448baa0ad8908c3785aaed..18811d03adb4510485fe6c5a50227e0f95a462f8 100644 (file)
@@ -71,9 +71,9 @@
 #endif
 
 #include "Python.h"
+#include "pycore_long.h"          // _PyLong_AsByteArray()
 #include "pycore_moduleobject.h"  // _PyModule_GetState()
 #include "pycore_pylifecycle.h"   // _PyOS_URandomNonblock()
-#include "pycore_runtime.h"
 #ifdef HAVE_PROCESS_H
 #  include <process.h>            // getpid()
 #endif
index 2b3bbfefa3cf5fc0410b91b74c2fa64d1529b603..833a666301d8ff9c979ba13a96b6caad2300d38f 100644 (file)
  * 3. This notice may not be removed or altered from any source distribution.
  */
 
+#ifndef Py_BUILD_CORE_BUILTIN
+#  define Py_BUILD_CORE_MODULE 1
+#endif
+
 #include "module.h"
+#include "pycore_long.h"          // _PyLong_AsByteArray()
 #include "connection.h"
 
 // Returns non-NULL if a new exception should be raised
index 425715ad030d4de1c18231b35cdff3b7decbc420..606ae5e4e199642bd728ed88d33bdbaeb90c8adf 100644 (file)
@@ -9,6 +9,7 @@
 
 #include "Python.h"
 #include "pycore_bytesobject.h"   // _PyBytesWriter
+#include "pycore_long.h"          // _PyLong_AsByteArray()
 #include "pycore_moduleobject.h"  // _PyModule_GetState()
 
 #include <ctype.h>
index a40a5b75b63d4f20b678a7ff0b463bccbfceecb3..5c1e6cb9cffbc34f62113220741561adc45e87c2 100644 (file)
@@ -8,9 +8,10 @@
 #endif
 
 #include "Python.h"
+#include "pycore_bytesobject.h"   // _PyBytes_Repeat
 #include "pycore_call.h"          // _PyObject_CallMethod()
+#include "pycore_long.h"          // _PyLong_FromByteArray()
 #include "pycore_moduleobject.h"  // _PyModule_GetState()
-#include "pycore_bytesobject.h"   // _PyBytes_Repeat
 
 #include <stddef.h>               // offsetof()
 #include <stdbool.h>
index 5d3c16a98423baaa7dc8da532a9c6225d8c430e6..7c1da9004549a66ef3621d35d4bd8b5de97ab205 100644 (file)
@@ -9,6 +9,7 @@
 #endif
 
 #include "Python.h"
+#include "pycore_long.h"          // _PyLong_FromByteArray()
 
 #include "multibytecodec.h"
 #include "clinic/multibytecodec.c.h"
index 24265edc2c3fd49ff849c4766d61fc97ca76a744..a8fbb00b807934064bbdfa098638cc9a18d62f8d 100644 (file)
@@ -1,9 +1,10 @@
 #include "Python.h"
-
-#include "pycore_bitutils.h"      // _Py_popcount32
+#include "pycore_bitutils.h"      // _Py_popcount32()
 #include "pycore_hamt.h"
 #include "pycore_initconfig.h"    // _PyStatus_OK()
+#include "pycore_long.h"          // _PyLong_Format()
 #include "pycore_object.h"        // _PyObject_GC_TRACK()
+
 #include <stddef.h>               // offsetof()
 
 /*