add PyLong* API (3.14+)

newsfragments/6016.added.md

@@ -0,0 +1 @@
+Added FFI wrappers for [PEP 757](https://peps.python.org/pep-0757/) `PyLong` import / export API on Python 3.14.

pyo3-ffi/src/cpython/longintrepr.rs

@@ -0,0 +1,55 @@
+use crate::{PyObject, Py_ssize_t};
+use core::ffi::{c_int, c_void};
+
+use crate::Py_uintptr_t;
+
+// skipped PyLong_BASE
+// skipped PyLong_MASK
+// skipped _PyLong_New
+// skipped _PyLong_Copy
+// skipped _PyLong_FromDigits
+// skipped _PyLong_SIGN_MASK
+// skipped _PyLong_NON_SIZE_BITS
+// skipped PyUnstable_Long_IsCompact
+// skipped PyUnstable_Long_CompactValue
+
+#[derive(Copy, Clone)]
+#[repr(C)]
+pub struct PyLongLayout {
+    pub bits_per_digit: u8,
+    pub digit_size: u8,
+    pub digits_order: i8,
+    pub digit_endianness: i8,
+}
+
+extern_libpython! {
+    pub fn PyLong_GetNativeLayout() -> *const PyLongLayout;
+}
+
+#[repr(C)]
+pub struct PyLongExport {
+    pub value: i64,
+    pub negative: u8,
+    pub ndigits: Py_ssize_t,
+    pub digits: *const c_void,
+    _reserved: Py_uintptr_t,
+}
+
+extern_libpython! {
+    pub fn PyLong_Export(obj: *mut PyObject, export_long: *mut PyLongExport) -> c_int;
+    pub fn PyLong_FreeExport(export_long: *mut PyLongExport);
+}
+
+opaque_struct!(pub PyLongWriter);
+
+extern_libpython! {
+    pub fn PyLongWriter_Create(
+        negative: c_int,
+        ndigits: Py_ssize_t,
+        digits: *mut *mut c_void,
+    ) -> *mut PyLongWriter;
+
+    pub fn PyLongWriter_Finish(writer: *mut PyLongWriter) -> *mut PyObject;
+
+    pub fn PyLongWriter_Discard(writer: *mut PyLongWriter);
+}

pyo3-ffi/src/cpython/longobject.rs

@@ -1,57 +1,31 @@
-use crate::longobject::*;
-use crate::object::*;
-#[cfg(Py_3_13)]
-use crate::pyport::Py_ssize_t;
-#[cfg(Py_3_13)]
-use core::ffi::c_void;
+use crate::{longobject::*, object::*};
 use core::ffi::{c_int, c_uchar};
 use libc::size_t;
 
-#[cfg(Py_3_13)]
+// skipped _PyLong_CAST
+
 extern_libpython! {
+    #[cfg(Py_3_13)]
     pub fn PyLong_FromUnicodeObject(u: *mut PyObject, base: c_int) -> *mut PyObject;
-}
-
-#[cfg(Py_3_13)]
-pub const Py_ASNATIVEBYTES_DEFAULTS: c_int = -1;
-#[cfg(Py_3_13)]
-pub const Py_ASNATIVEBYTES_BIG_ENDIAN: c_int = 0;
-#[cfg(Py_3_13)]
-pub const Py_ASNATIVEBYTES_LITTLE_ENDIAN: c_int = 1;
-#[cfg(Py_3_13)]
-pub const Py_ASNATIVEBYTES_NATIVE_ENDIAN: c_int = 3;
-#[cfg(Py_3_13)]
-pub const Py_ASNATIVEBYTES_UNSIGNED_BUFFER: c_int = 4;
-#[cfg(Py_3_13)]
-pub const Py_ASNATIVEBYTES_REJECT_NEGATIVE: c_int = 8;
 
-extern_libpython! {
-    // skipped _PyLong_Sign
+    // skipped PyUnstable_Long_IsCompact
+    // skipped PyUnstable_Long_CompactValue
 
-    #[cfg(Py_3_13)]
-    pub fn PyLong_AsNativeBytes(
-        v: *mut PyObject,
-        buffer: *mut c_void,
-        n_bytes: Py_ssize_t,
-        flags: c_int,
-    ) -> Py_ssize_t;
+    #[cfg(Py_3_14)]
+    pub fn PyLong_IsPositive(obj: *mut PyObject) -> c_int;
+    #[cfg(Py_3_14)]
+    pub fn PyLong_IsNegative(obj: *mut PyObject) -> c_int;
+    #[cfg(Py_3_14)]
+    pub fn PyLong_IsZero(obj: *mut PyObject) -> c_int;
 
-    #[cfg(Py_3_13)]
-    pub fn PyLong_FromNativeBytes(
-        buffer: *const c_void,
-        n_bytes: size_t,
-        flags: c_int,
-    ) -> *mut PyObject;
+    // skipped PyLong_GetSign
 
-    #[cfg(Py_3_13)]
-    pub fn PyLong_FromUnsignedNativeBytes(
-        buffer: *const c_void,
-        n_bytes: size_t,
-        flags: c_int,
-    ) -> *mut PyObject;
+    // skipped _PyLong_Sign
 
-    // skipped PyUnstable_Long_IsCompact
-    // skipped PyUnstable_Long_CompactValue
+    #[cfg_attr(PyPy, link_name = "_PyPyLong_NumBits")]
+    #[cfg(not(Py_3_13))]
+    #[doc(hidden)]
+    pub fn _PyLong_NumBits(obj: *mut PyObject) -> size_t;
 
     #[cfg_attr(PyPy, link_name = "_PyPyLong_FromByteArray")]
     pub fn _PyLong_FromByteArray(

pyo3-ffi/src/cpython/mod.rs

@@ -24,6 +24,8 @@ pub(crate) mod initconfig;
 pub(crate) mod listobject;
 #[cfg(Py_3_13)]
 pub(crate) mod lock;
+#[cfg(Py_3_14)]
+pub(crate) mod longintrepr;
 pub(crate) mod longobject;
 pub(crate) mod marshal;
 #[cfg(all(Py_3_9, not(PyPy)))]
@@ -71,6 +73,8 @@ pub use self::initconfig::*;
 pub use self::listobject::*;
 #[cfg(Py_3_13)]
 pub use self::lock::*;
+#[cfg(Py_3_14)]
+pub use self::longintrepr::*;
 pub use self::longobject::*;
 pub use self::marshal::*;
 #[cfg(all(Py_3_9, not(PyPy)))]

pyo3-ffi/src/lib.rs

@@ -536,7 +536,6 @@ mod import;
 mod intrcheck;
 mod iterobject;
 mod listobject;
-// skipped longintrepr.h
 mod longobject;
 mod memoryobject;
 mod methodobject;

pyo3-ffi/src/longobject.rs

@@ -45,7 +45,66 @@ extern_libpython! {
     pub fn PyLong_AsUnsignedLong(arg1: *mut PyObject) -> c_ulong;
     #[cfg_attr(PyPy, link_name = "PyPyLong_AsUnsignedLongMask")]
     pub fn PyLong_AsUnsignedLongMask(arg1: *mut PyObject) -> c_ulong;
-    // skipped non-limited _PyLong_AsInt
+
+    // skipped non-limited PyLong_AsInt
+
+    #[cfg(Py_3_14)]
+    pub fn PyLong_FromInt32(arg1: i32) -> *mut PyObject;
+    #[cfg(Py_3_14)]
+    pub fn PyLong_FromUInt32(arg1: u32) -> *mut PyObject;
+    #[cfg(Py_3_14)]
+    pub fn PyLong_FromInt64(arg1: i64) -> *mut PyObject;
+    #[cfg(Py_3_14)]
+    pub fn PyLong_FromUInt64(arg1: u64) -> *mut PyObject;
+
+    #[cfg(Py_3_14)]
+    pub fn PyLong_AsInt32(arg1: *mut PyObject, arg2: *mut i32) -> c_int;
+    #[cfg(Py_3_14)]
+    pub fn PyLong_AsUInt32(arg1: *mut PyObject, arg2: *mut u32) -> c_int;
+    #[cfg(Py_3_14)]
+    pub fn PyLong_AsInt64(arg1: *mut PyObject, arg2: *mut i64) -> c_int;
+    #[cfg(Py_3_14)]
+    pub fn PyLong_AsUInt64(arg1: *mut PyObject, arg2: *mut u64) -> c_int;
+}
+
+#[cfg(any(Py_3_14, all(Py_3_13, not(Py_LIMITED_API))))]
+pub const Py_ASNATIVEBYTES_DEFAULTS: c_int = -1;
+#[cfg(any(Py_3_14, all(Py_3_13, not(Py_LIMITED_API))))]
+pub const Py_ASNATIVEBYTES_BIG_ENDIAN: c_int = 0;
+#[cfg(any(Py_3_14, all(Py_3_13, not(Py_LIMITED_API))))]
+pub const Py_ASNATIVEBYTES_LITTLE_ENDIAN: c_int = 1;
+#[cfg(any(Py_3_14, all(Py_3_13, not(Py_LIMITED_API))))]
+pub const Py_ASNATIVEBYTES_NATIVE_ENDIAN: c_int = 3;
+#[cfg(any(Py_3_14, all(Py_3_13, not(Py_LIMITED_API))))]
+pub const Py_ASNATIVEBYTES_UNSIGNED_BUFFER: c_int = 4;
+#[cfg(any(Py_3_14, all(Py_3_13, not(Py_LIMITED_API))))]
+pub const Py_ASNATIVEBYTES_REJECT_NEGATIVE: c_int = 8;
+#[cfg(any(Py_3_14, all(Py_3_13, not(Py_LIMITED_API))))]
+pub const Py_ASNATIVEBYTES_ALLOW_INDEX: c_int = 16;
+
+extern_libpython! {
+    #[cfg(any(Py_3_14, all(Py_3_13, not(Py_LIMITED_API))))]
+    pub fn PyLong_AsNativeBytes(
+        v: *mut PyObject,
+        buffer: *mut c_void,
+        n_bytes: Py_ssize_t,
+        flags: c_int,
+    ) -> Py_ssize_t;
+
+    #[cfg(any(Py_3_14, all(Py_3_13, not(Py_LIMITED_API))))]
+    pub fn PyLong_FromNativeBytes(
+        buffer: *const c_void,
+        n_bytes: size_t,
+        flags: c_int,
+    ) -> *mut PyObject;
+
+    #[cfg(any(Py_3_14, all(Py_3_13, not(Py_LIMITED_API))))]
+    pub fn PyLong_FromUnsignedNativeBytes(
+        buffer: *const c_void,
+        n_bytes: size_t,
+        flags: c_int,
+    ) -> *mut PyObject;
+
     pub fn PyLong_GetInfo() -> *mut PyObject;
     // skipped PyLong_AS_LONG
 
@@ -54,15 +113,6 @@ extern_libpython! {
     // skipped _Py_PARSE_INTPTR
     // skipped _Py_PARSE_UINTPTR
 
-    // skipped non-limited _PyLong_UnsignedShort_Converter
-    // skipped non-limited _PyLong_UnsignedInt_Converter
-    // skipped non-limited _PyLong_UnsignedLong_Converter
-    // skipped non-limited _PyLong_UnsignedLongLong_Converter
-    // skipped non-limited _PyLong_Size_t_Converter
-
-    // skipped non-limited _PyLong_DigitValue
-    // skipped non-limited _PyLong_Frexp
-
     #[cfg_attr(PyPy, link_name = "PyPyLong_AsDouble")]
     pub fn PyLong_AsDouble(arg1: *mut PyObject) -> c_double;
     #[cfg_attr(PyPy, link_name = "PyPyLong_FromVoidPtr")]
@@ -89,23 +139,7 @@ extern_libpython! {
     ) -> *mut PyObject;
 }
 
-#[cfg(not(Py_LIMITED_API))]
-extern_libpython! {
-    #[cfg_attr(PyPy, link_name = "_PyPyLong_NumBits")]
-    #[cfg(not(Py_3_13))]
-    #[doc(hidden)]
-    pub fn _PyLong_NumBits(obj: *mut PyObject) -> size_t;
-}
-
-// skipped non-limited _PyLong_Format
-// skipped non-limited _PyLong_FormatWriter
-// skipped non-limited _PyLong_FormatBytesWriter
-// skipped non-limited _PyLong_FormatAdvancedWriter
-
 extern_libpython! {
     pub fn PyOS_strtoul(arg1: *const c_char, arg2: *mut *mut c_char, arg3: c_int) -> c_ulong;
     pub fn PyOS_strtol(arg1: *const c_char, arg2: *mut *mut c_char, arg3: c_int) -> c_long;
 }
-
-// skipped non-limited _PyLong_Rshift
-// skipped non-limited _PyLong_Lshift