pyo3_ffi/
abstract_.rs

1use crate::object::*;
2use crate::pyport::Py_ssize_t;
3use core::ffi::{c_char, c_int};
4#[cfg(any(Py_3_12, not(Py_LIMITED_API)))]
5use libc::size_t;
6
7#[inline]
8#[cfg(all(
9    not(Py_3_13), // CPython exposed as a function in 3.13, in object.h
10    not(all(PyPy, not(Py_3_11))) // PyPy exposed as a function until PyPy 3.10, macro in 3.11+
11))]
12pub unsafe fn PyObject_DelAttrString(o: *mut PyObject, attr_name: *const c_char) -> c_int {
13    PyObject_SetAttrString(o, attr_name, core::ptr::null_mut())
14}
15
16#[inline]
17#[cfg(all(
18    not(Py_3_13), // CPython exposed as a function in 3.13, in object.h
19    not(all(PyPy, not(Py_3_11))) // PyPy exposed as a function until PyPy 3.10, macro in 3.11+
20))]
21pub unsafe fn PyObject_DelAttr(o: *mut PyObject, attr_name: *mut PyObject) -> c_int {
22    PyObject_SetAttr(o, attr_name, core::ptr::null_mut())
23}
24
25extern_libpython! {
26    #[cfg(all(
27        not(PyPy),
28        any(Py_3_10, all(not(Py_LIMITED_API), Py_3_9)) // Added to python in 3.9 but to limited API in 3.10
29    ))]
30    #[cfg_attr(PyPy, link_name = "PyPyObject_CallNoArgs")]
31    pub fn PyObject_CallNoArgs(func: *mut PyObject) -> *mut PyObject;
32    #[cfg_attr(PyPy, link_name = "PyPyObject_Call")]
33    pub fn PyObject_Call(
34        callable_object: *mut PyObject,
35        args: *mut PyObject,
36        kw: *mut PyObject,
37    ) -> *mut PyObject;
38    #[cfg_attr(PyPy, link_name = "PyPyObject_CallObject")]
39    pub fn PyObject_CallObject(
40        callable_object: *mut PyObject,
41        args: *mut PyObject,
42    ) -> *mut PyObject;
43    #[cfg_attr(PyPy, link_name = "PyPyObject_CallFunction")]
44    pub fn PyObject_CallFunction(
45        callable_object: *mut PyObject,
46        format: *const c_char,
47        ...
48    ) -> *mut PyObject;
49    #[cfg_attr(PyPy, link_name = "PyPyObject_CallMethod")]
50    pub fn PyObject_CallMethod(
51        o: *mut PyObject,
52        method: *const c_char,
53        format: *const c_char,
54        ...
55    ) -> *mut PyObject;
56
57    #[cfg(all(PyPy, not(Py_3_13)))] // called internally in PyUnicodeDecodeError_Create on PyPy
58    #[cfg_attr(PyPy, link_name = "_PyPyObject_CallFunction_SizeT")]
59    pub(crate) fn _PyObject_CallFunction_SizeT(
60        callable_object: *mut PyObject,
61        format: *const c_char,
62        ...
63    ) -> *mut PyObject;
64
65    #[cfg_attr(PyPy, link_name = "PyPyObject_CallFunctionObjArgs")]
66    pub fn PyObject_CallFunctionObjArgs(callable: *mut PyObject, ...) -> *mut PyObject;
67    #[cfg_attr(PyPy, link_name = "PyPyObject_CallMethodObjArgs")]
68    pub fn PyObject_CallMethodObjArgs(
69        o: *mut PyObject,
70        method: *mut PyObject,
71        ...
72    ) -> *mut PyObject;
73
74    #[cfg(all(Py_3_12, Py_LIMITED_API))] // is an inline function in cpython/abstract.rs on version-specific ABI
75    #[cfg_attr(PyPy, link_name = "PyPyVectorcall_NARGS")]
76    pub fn PyVectorcall_NARGS(nargsf: size_t) -> Py_ssize_t;
77
78    #[cfg_attr(not(any(Py_3_12, PyPy)), link_name = "_PyVectorcall_Call")] // symbol made public in 3.12
79    #[cfg_attr(PyPy, link_name = "PyPyVectorcall_Call")]
80    pub fn PyVectorcall_Call(
81        callable: *mut PyObject,
82        tuple: *mut PyObject,
83        dict: *mut PyObject,
84    ) -> *mut PyObject;
85}
86
87#[cfg(any(Py_3_12, not(Py_LIMITED_API)))]
88pub const PY_VECTORCALL_ARGUMENTS_OFFSET: size_t = (1 as size_t)
89    .checked_shl((8 * core::mem::size_of::<size_t>() - 1) as u32)
90    .expect("size_t should fit the flag bits");
91
92extern_libpython! {
93    #[cfg_attr(PyPy, link_name = "PyPyObject_Vectorcall")]
94    #[cfg(any(Py_3_12, all(Py_3_11, not(Py_LIMITED_API))))]
95    pub fn PyObject_Vectorcall(
96        callable: *mut PyObject,
97        args: *const *mut PyObject,
98        nargsf: size_t,
99        kwnames: *mut PyObject,
100    ) -> *mut PyObject;
101
102    #[cfg(any(Py_3_12, all(Py_3_9, not(any(Py_LIMITED_API, PyPy)))))]
103    pub fn PyObject_VectorcallMethod(
104        name: *mut PyObject,
105        args: *const *mut PyObject,
106        nargsf: size_t,
107        kwnames: *mut PyObject,
108    ) -> *mut PyObject;
109    #[cfg_attr(PyPy, link_name = "PyPyObject_Type")]
110    pub fn PyObject_Type(o: *mut PyObject) -> *mut PyObject;
111    #[cfg_attr(PyPy, link_name = "PyPyObject_Size")]
112    pub fn PyObject_Size(o: *mut PyObject) -> Py_ssize_t;
113
114    // PyObject_Length is a direct alias for PyObject_Size
115    #[cfg_attr(not(PyPy), link_name = "PyObject_Size")]
116    #[cfg_attr(PyPy, link_name = "PyPyObject_Size")]
117    pub fn PyObject_Length(o: *mut PyObject) -> Py_ssize_t;
118
119    #[cfg_attr(PyPy, link_name = "PyPyObject_GetItem")]
120    pub fn PyObject_GetItem(o: *mut PyObject, key: *mut PyObject) -> *mut PyObject;
121    #[cfg_attr(PyPy, link_name = "PyPyObject_SetItem")]
122    pub fn PyObject_SetItem(o: *mut PyObject, key: *mut PyObject, v: *mut PyObject) -> c_int;
123    #[cfg_attr(PyPy, link_name = "PyPyObject_DelItemString")]
124    pub fn PyObject_DelItemString(o: *mut PyObject, key: *const c_char) -> c_int;
125    #[cfg_attr(PyPy, link_name = "PyPyObject_DelItem")]
126    pub fn PyObject_DelItem(o: *mut PyObject, key: *mut PyObject) -> c_int;
127
128    #[cfg_attr(PyPy, link_name = "PyPyObject_Format")]
129    pub fn PyObject_Format(obj: *mut PyObject, format_spec: *mut PyObject) -> *mut PyObject;
130    #[cfg_attr(PyPy, link_name = "PyPyObject_GetIter")]
131    pub fn PyObject_GetIter(arg1: *mut PyObject) -> *mut PyObject;
132    #[cfg(Py_3_10)]
133    #[cfg_attr(PyPy, link_name = "PyPyObject_GetAIter")]
134    pub fn PyObject_GetAIter(arg1: *mut PyObject) -> *mut PyObject;
135
136    #[cfg_attr(PyPy, link_name = "PyPyIter_Check")]
137    pub fn PyIter_Check(obj: *mut PyObject) -> c_int;
138    #[cfg(Py_3_10)]
139    #[cfg_attr(PyPy, link_name = "PyPyAIter_Check")]
140    pub fn PyAIter_Check(obj: *mut PyObject) -> c_int;
141
142    #[cfg(Py_3_14)]
143    #[cfg_attr(PyPy, link_name = "PyPyIter_NextItem")]
144    pub fn PyIter_NextItem(iter: *mut PyObject, item: *mut *mut PyObject) -> c_int;
145    #[cfg_attr(PyPy, link_name = "PyPyIter_Next")]
146    pub fn PyIter_Next(arg1: *mut PyObject) -> *mut PyObject;
147    #[cfg(all(not(PyPy), Py_3_10))]
148    #[cfg_attr(PyPy, link_name = "PyPyIter_Send")]
149    pub fn PyIter_Send(
150        iter: *mut PyObject,
151        arg: *mut PyObject,
152        presult: *mut *mut PyObject,
153    ) -> PySendResult;
154
155    #[cfg_attr(PyPy, link_name = "PyPyNumber_Check")]
156    pub fn PyNumber_Check(o: *mut PyObject) -> c_int;
157    #[cfg_attr(PyPy, link_name = "PyPyNumber_Add")]
158    pub fn PyNumber_Add(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
159    #[cfg_attr(PyPy, link_name = "PyPyNumber_Subtract")]
160    pub fn PyNumber_Subtract(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
161    #[cfg_attr(PyPy, link_name = "PyPyNumber_Multiply")]
162    pub fn PyNumber_Multiply(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
163    #[cfg_attr(PyPy, link_name = "PyPyNumber_MatrixMultiply")]
164    pub fn PyNumber_MatrixMultiply(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
165    #[cfg_attr(PyPy, link_name = "PyPyNumber_FloorDivide")]
166    pub fn PyNumber_FloorDivide(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
167    #[cfg_attr(PyPy, link_name = "PyPyNumber_TrueDivide")]
168    pub fn PyNumber_TrueDivide(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
169    #[cfg_attr(PyPy, link_name = "PyPyNumber_Remainder")]
170    pub fn PyNumber_Remainder(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
171    #[cfg_attr(PyPy, link_name = "PyPyNumber_Divmod")]
172    pub fn PyNumber_Divmod(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
173    #[cfg_attr(PyPy, link_name = "PyPyNumber_Power")]
174    pub fn PyNumber_Power(o1: *mut PyObject, o2: *mut PyObject, o3: *mut PyObject)
175        -> *mut PyObject;
176    #[cfg_attr(PyPy, link_name = "PyPyNumber_Negative")]
177    pub fn PyNumber_Negative(o: *mut PyObject) -> *mut PyObject;
178    #[cfg_attr(PyPy, link_name = "PyPyNumber_Positive")]
179    pub fn PyNumber_Positive(o: *mut PyObject) -> *mut PyObject;
180    #[cfg_attr(PyPy, link_name = "PyPyNumber_Absolute")]
181    pub fn PyNumber_Absolute(o: *mut PyObject) -> *mut PyObject;
182    #[cfg_attr(PyPy, link_name = "PyPyNumber_Invert")]
183    pub fn PyNumber_Invert(o: *mut PyObject) -> *mut PyObject;
184    #[cfg_attr(PyPy, link_name = "PyPyNumber_Lshift")]
185    pub fn PyNumber_Lshift(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
186    #[cfg_attr(PyPy, link_name = "PyPyNumber_Rshift")]
187    pub fn PyNumber_Rshift(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
188    #[cfg_attr(PyPy, link_name = "PyPyNumber_And")]
189    pub fn PyNumber_And(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
190    #[cfg_attr(PyPy, link_name = "PyPyNumber_Xor")]
191    pub fn PyNumber_Xor(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
192    #[cfg_attr(PyPy, link_name = "PyPyNumber_Or")]
193    pub fn PyNumber_Or(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
194
195    #[cfg_attr(PyPy, link_name = "PyPyIndex_Check")]
196    pub fn PyIndex_Check(o: *mut PyObject) -> c_int;
197
198    #[cfg_attr(PyPy, link_name = "PyPyNumber_Index")]
199    pub fn PyNumber_Index(o: *mut PyObject) -> *mut PyObject;
200    #[cfg_attr(PyPy, link_name = "PyPyNumber_AsSsize_t")]
201    pub fn PyNumber_AsSsize_t(o: *mut PyObject, exc: *mut PyObject) -> Py_ssize_t;
202    #[cfg_attr(PyPy, link_name = "PyPyNumber_Long")]
203    pub fn PyNumber_Long(o: *mut PyObject) -> *mut PyObject;
204    #[cfg_attr(PyPy, link_name = "PyPyNumber_Float")]
205    pub fn PyNumber_Float(o: *mut PyObject) -> *mut PyObject;
206    #[cfg_attr(PyPy, link_name = "PyPyNumber_InPlaceAdd")]
207    pub fn PyNumber_InPlaceAdd(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
208    #[cfg_attr(PyPy, link_name = "PyPyNumber_InPlaceSubtract")]
209    pub fn PyNumber_InPlaceSubtract(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
210    #[cfg_attr(PyPy, link_name = "PyPyNumber_InPlaceMultiply")]
211    pub fn PyNumber_InPlaceMultiply(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
212    #[cfg_attr(PyPy, link_name = "PyPyNumber_InPlaceMatrixMultiply")]
213    pub fn PyNumber_InPlaceMatrixMultiply(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
214    #[cfg_attr(PyPy, link_name = "PyPyNumber_InPlaceFloorDivide")]
215    pub fn PyNumber_InPlaceFloorDivide(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
216    #[cfg_attr(PyPy, link_name = "PyPyNumber_InPlaceTrueDivide")]
217    pub fn PyNumber_InPlaceTrueDivide(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
218    #[cfg_attr(PyPy, link_name = "PyPyNumber_InPlaceRemainder")]
219    pub fn PyNumber_InPlaceRemainder(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
220    #[cfg_attr(PyPy, link_name = "PyPyNumber_InPlacePower")]
221    pub fn PyNumber_InPlacePower(
222        o1: *mut PyObject,
223        o2: *mut PyObject,
224        o3: *mut PyObject,
225    ) -> *mut PyObject;
226    #[cfg_attr(PyPy, link_name = "PyPyNumber_InPlaceLshift")]
227    pub fn PyNumber_InPlaceLshift(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
228    #[cfg_attr(PyPy, link_name = "PyPyNumber_InPlaceRshift")]
229    pub fn PyNumber_InPlaceRshift(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
230    #[cfg_attr(PyPy, link_name = "PyPyNumber_InPlaceAnd")]
231    pub fn PyNumber_InPlaceAnd(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
232    #[cfg_attr(PyPy, link_name = "PyPyNumber_InPlaceXor")]
233    pub fn PyNumber_InPlaceXor(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
234    #[cfg_attr(PyPy, link_name = "PyPyNumber_InPlaceOr")]
235    pub fn PyNumber_InPlaceOr(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
236    pub fn PyNumber_ToBase(n: *mut PyObject, base: c_int) -> *mut PyObject;
237
238    #[cfg_attr(PyPy, link_name = "PyPySequence_Check")]
239    pub fn PySequence_Check(o: *mut PyObject) -> c_int;
240    #[cfg_attr(PyPy, link_name = "PyPySequence_Size")]
241    pub fn PySequence_Size(o: *mut PyObject) -> Py_ssize_t;
242
243    // PySequence_Length is a direct alias for PySequence_Size
244    #[cfg_attr(not(PyPy), link_name = "PySequence_Size")]
245    #[cfg_attr(PyPy, link_name = "PyPySequence_Size")]
246    pub fn PySequence_Length(o: *mut PyObject) -> Py_ssize_t;
247
248    #[cfg_attr(PyPy, link_name = "PyPySequence_Concat")]
249    pub fn PySequence_Concat(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
250    #[cfg_attr(PyPy, link_name = "PyPySequence_Repeat")]
251    pub fn PySequence_Repeat(o: *mut PyObject, count: Py_ssize_t) -> *mut PyObject;
252    #[cfg_attr(PyPy, link_name = "PyPySequence_GetItem")]
253    pub fn PySequence_GetItem(o: *mut PyObject, i: Py_ssize_t) -> *mut PyObject;
254    #[cfg_attr(PyPy, link_name = "PyPySequence_GetSlice")]
255    pub fn PySequence_GetSlice(o: *mut PyObject, i1: Py_ssize_t, i2: Py_ssize_t) -> *mut PyObject;
256    #[cfg_attr(PyPy, link_name = "PyPySequence_SetItem")]
257    pub fn PySequence_SetItem(o: *mut PyObject, i: Py_ssize_t, v: *mut PyObject) -> c_int;
258    #[cfg_attr(PyPy, link_name = "PyPySequence_DelItem")]
259    pub fn PySequence_DelItem(o: *mut PyObject, i: Py_ssize_t) -> c_int;
260    #[cfg_attr(PyPy, link_name = "PyPySequence_SetSlice")]
261    pub fn PySequence_SetSlice(
262        o: *mut PyObject,
263        i1: Py_ssize_t,
264        i2: Py_ssize_t,
265        v: *mut PyObject,
266    ) -> c_int;
267    #[cfg_attr(PyPy, link_name = "PyPySequence_DelSlice")]
268    pub fn PySequence_DelSlice(o: *mut PyObject, i1: Py_ssize_t, i2: Py_ssize_t) -> c_int;
269    #[cfg_attr(PyPy, link_name = "PyPySequence_Tuple")]
270    pub fn PySequence_Tuple(o: *mut PyObject) -> *mut PyObject;
271    #[cfg_attr(PyPy, link_name = "PyPySequence_List")]
272    pub fn PySequence_List(o: *mut PyObject) -> *mut PyObject;
273    #[cfg_attr(PyPy, link_name = "PyPySequence_Fast")]
274    pub fn PySequence_Fast(o: *mut PyObject, m: *const c_char) -> *mut PyObject;
275    pub fn PySequence_Count(o: *mut PyObject, value: *mut PyObject) -> Py_ssize_t;
276    #[cfg_attr(PyPy, link_name = "PyPySequence_Contains")]
277    pub fn PySequence_Contains(seq: *mut PyObject, ob: *mut PyObject) -> c_int;
278
279    // PySequence_In is a direct alias for PySequence_Contains
280    #[cfg_attr(not(PyPy), link_name = "PySequence_Contains")]
281    #[cfg_attr(PyPy, link_name = "PyPySequence_Contains")]
282    pub fn PySequence_In(o: *mut PyObject, value: *mut PyObject) -> c_int;
283
284    #[cfg_attr(PyPy, link_name = "PyPySequence_Index")]
285    pub fn PySequence_Index(o: *mut PyObject, value: *mut PyObject) -> Py_ssize_t;
286    #[cfg_attr(PyPy, link_name = "PyPySequence_InPlaceConcat")]
287    pub fn PySequence_InPlaceConcat(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
288    #[cfg_attr(PyPy, link_name = "PyPySequence_InPlaceRepeat")]
289    pub fn PySequence_InPlaceRepeat(o: *mut PyObject, count: Py_ssize_t) -> *mut PyObject;
290    #[cfg_attr(PyPy, link_name = "PyPyMapping_Check")]
291    pub fn PyMapping_Check(o: *mut PyObject) -> c_int;
292    #[cfg_attr(PyPy, link_name = "PyPyMapping_Size")]
293    pub fn PyMapping_Size(o: *mut PyObject) -> Py_ssize_t;
294
295    // PyMapping_Length is a direct alias for PyMapping_Size
296    #[cfg_attr(not(PyPy), link_name = "PyMapping_Size")]
297    #[cfg_attr(PyPy, link_name = "PyPyMapping_Size")]
298    pub fn PyMapping_Length(o: *mut PyObject) -> Py_ssize_t;
299}
300
301#[inline]
302pub unsafe fn PyMapping_DelItemString(o: *mut PyObject, key: *mut c_char) -> c_int {
303    PyObject_DelItemString(o, key)
304}
305
306#[inline]
307pub unsafe fn PyMapping_DelItem(o: *mut PyObject, key: *mut PyObject) -> c_int {
308    PyObject_DelItem(o, key)
309}
310
311extern_libpython! {
312    #[cfg_attr(PyPy, link_name = "PyPyMapping_HasKeyString")]
313    pub fn PyMapping_HasKeyString(o: *mut PyObject, key: *const c_char) -> c_int;
314    #[cfg_attr(PyPy, link_name = "PyPyMapping_HasKey")]
315    pub fn PyMapping_HasKey(o: *mut PyObject, key: *mut PyObject) -> c_int;
316    #[cfg(Py_3_13)]
317    #[cfg_attr(PyPy, link_name = "PyPyMapping_HasKeyWithError")]
318    pub fn PyMapping_HasKeyWithError(o: *mut PyObject, key: *mut PyObject) -> c_int;
319    #[cfg(Py_3_13)]
320    #[cfg_attr(PyPy, link_name = "PyPyMapping_HasKeyStringWithError")]
321    pub fn PyMapping_HasKeyStringWithError(o: *mut PyObject, key: *const c_char) -> c_int;
322    #[cfg_attr(PyPy, link_name = "PyPyMapping_Keys")]
323    pub fn PyMapping_Keys(o: *mut PyObject) -> *mut PyObject;
324    #[cfg_attr(PyPy, link_name = "PyPyMapping_Values")]
325    pub fn PyMapping_Values(o: *mut PyObject) -> *mut PyObject;
326    #[cfg_attr(PyPy, link_name = "PyPyMapping_Items")]
327    pub fn PyMapping_Items(o: *mut PyObject) -> *mut PyObject;
328    #[cfg_attr(PyPy, link_name = "PyPyMapping_GetItemString")]
329    pub fn PyMapping_GetItemString(o: *mut PyObject, key: *const c_char) -> *mut PyObject;
330    #[cfg(Py_3_13)]
331    #[cfg_attr(PyPy, link_name = "PyPyMapping_GetOptionalItem")]
332    pub fn PyMapping_GetOptionalItem(
333        o: *mut PyObject,
334        key: *mut PyObject,
335        result: *mut *mut PyObject,
336    ) -> c_int;
337    #[cfg(Py_3_13)]
338    #[cfg_attr(PyPy, link_name = "PyPyMapping_GetOptionalItemString")]
339    pub fn PyMapping_GetOptionalItemString(
340        o: *mut PyObject,
341        key: *const c_char,
342        result: *mut *mut PyObject,
343    ) -> c_int;
344    #[cfg_attr(PyPy, link_name = "PyPyMapping_SetItemString")]
345    pub fn PyMapping_SetItemString(
346        o: *mut PyObject,
347        key: *const c_char,
348        value: *mut PyObject,
349    ) -> c_int;
350    #[cfg_attr(PyPy, link_name = "PyPyObject_IsInstance")]
351    pub fn PyObject_IsInstance(object: *mut PyObject, typeorclass: *mut PyObject) -> c_int;
352    #[cfg_attr(PyPy, link_name = "PyPyObject_IsSubclass")]
353    pub fn PyObject_IsSubclass(object: *mut PyObject, typeorclass: *mut PyObject) -> c_int;
354}
pyo3_ffi/abstract_.rs

pyo3_ffi/
abstract_.rs
