pyo3_ffi/
abstract_.rs

1use crate::object::*;
2use crate::pyport::Py_ssize_t;
3#[cfg(any(Py_3_12, not(Py_LIMITED_API)))]
4use libc::size_t;
5use std::ffi::{c_char, c_int};
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, std::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, std::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(not(Py_3_13))]
58    #[cfg_attr(PyPy, link_name = "_PyPyObject_CallFunction_SizeT")]
59    pub fn _PyObject_CallFunction_SizeT(
60        callable_object: *mut PyObject,
61        format: *const c_char,
62        ...
63    ) -> *mut PyObject;
64    #[cfg(not(Py_3_13))]
65    #[cfg_attr(PyPy, link_name = "_PyPyObject_CallMethod_SizeT")]
66    pub fn _PyObject_CallMethod_SizeT(
67        o: *mut PyObject,
68        method: *const c_char,
69        format: *const c_char,
70        ...
71    ) -> *mut PyObject;
72
73    #[cfg_attr(PyPy, link_name = "PyPyObject_CallFunctionObjArgs")]
74    pub fn PyObject_CallFunctionObjArgs(callable: *mut PyObject, ...) -> *mut PyObject;
75    #[cfg_attr(PyPy, link_name = "PyPyObject_CallMethodObjArgs")]
76    pub fn PyObject_CallMethodObjArgs(
77        o: *mut PyObject,
78        method: *mut PyObject,
79        ...
80    ) -> *mut PyObject;
81}
82#[cfg(any(Py_3_12, not(Py_LIMITED_API)))]
83pub const PY_VECTORCALL_ARGUMENTS_OFFSET: size_t =
84    1 << (8 * std::mem::size_of::<size_t>() as size_t - 1);
85
86extern_libpython! {
87    #[cfg_attr(PyPy, link_name = "PyPyObject_Vectorcall")]
88    #[cfg(any(Py_3_12, all(Py_3_11, not(Py_LIMITED_API))))]
89    pub fn PyObject_Vectorcall(
90        callable: *mut PyObject,
91        args: *const *mut PyObject,
92        nargsf: size_t,
93        kwnames: *mut PyObject,
94    ) -> *mut PyObject;
95
96    #[cfg(any(Py_3_12, all(Py_3_9, not(any(Py_LIMITED_API, PyPy)))))]
97    pub fn PyObject_VectorcallMethod(
98        name: *mut PyObject,
99        args: *const *mut PyObject,
100        nargsf: size_t,
101        kwnames: *mut PyObject,
102    ) -> *mut PyObject;
103    #[cfg_attr(PyPy, link_name = "PyPyObject_Type")]
104    pub fn PyObject_Type(o: *mut PyObject) -> *mut PyObject;
105    #[cfg_attr(PyPy, link_name = "PyPyObject_Size")]
106    pub fn PyObject_Size(o: *mut PyObject) -> Py_ssize_t;
107}
108
109#[inline]
110pub unsafe fn PyObject_Length(o: *mut PyObject) -> Py_ssize_t {
111    PyObject_Size(o)
112}
113
114extern_libpython! {
115    #[cfg_attr(PyPy, link_name = "PyPyObject_GetItem")]
116    pub fn PyObject_GetItem(o: *mut PyObject, key: *mut PyObject) -> *mut PyObject;
117    #[cfg_attr(PyPy, link_name = "PyPyObject_SetItem")]
118    pub fn PyObject_SetItem(o: *mut PyObject, key: *mut PyObject, v: *mut PyObject) -> c_int;
119    #[cfg_attr(PyPy, link_name = "PyPyObject_DelItemString")]
120    pub fn PyObject_DelItemString(o: *mut PyObject, key: *const c_char) -> c_int;
121    #[cfg_attr(PyPy, link_name = "PyPyObject_DelItem")]
122    pub fn PyObject_DelItem(o: *mut PyObject, key: *mut PyObject) -> c_int;
123}
124
125extern_libpython! {
126    #[cfg_attr(PyPy, link_name = "PyPyObject_Format")]
127    pub fn PyObject_Format(obj: *mut PyObject, format_spec: *mut PyObject) -> *mut PyObject;
128    #[cfg_attr(PyPy, link_name = "PyPyObject_GetIter")]
129    pub fn PyObject_GetIter(arg1: *mut PyObject) -> *mut PyObject;
130}
131
132extern_libpython! {
133    #[cfg_attr(PyPy, link_name = "PyPyIter_Check")]
134    pub fn PyIter_Check(obj: *mut PyObject) -> c_int;
135
136    #[cfg(Py_3_14)]
137    #[cfg_attr(PyPy, link_name = "PyPyIter_NextItem")]
138    pub fn PyIter_NextItem(iter: *mut PyObject, item: *mut *mut PyObject) -> c_int;
139    #[cfg_attr(PyPy, link_name = "PyPyIter_Next")]
140    pub fn PyIter_Next(arg1: *mut PyObject) -> *mut PyObject;
141    #[cfg(all(not(PyPy), Py_3_10))]
142    #[cfg_attr(PyPy, link_name = "PyPyIter_Send")]
143    pub fn PyIter_Send(
144        iter: *mut PyObject,
145        arg: *mut PyObject,
146        presult: *mut *mut PyObject,
147    ) -> PySendResult;
148
149    #[cfg_attr(PyPy, link_name = "PyPyNumber_Check")]
150    pub fn PyNumber_Check(o: *mut PyObject) -> c_int;
151    #[cfg_attr(PyPy, link_name = "PyPyNumber_Add")]
152    pub fn PyNumber_Add(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
153    #[cfg_attr(PyPy, link_name = "PyPyNumber_Subtract")]
154    pub fn PyNumber_Subtract(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
155    #[cfg_attr(PyPy, link_name = "PyPyNumber_Multiply")]
156    pub fn PyNumber_Multiply(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
157    #[cfg_attr(PyPy, link_name = "PyPyNumber_MatrixMultiply")]
158    pub fn PyNumber_MatrixMultiply(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
159    #[cfg_attr(PyPy, link_name = "PyPyNumber_FloorDivide")]
160    pub fn PyNumber_FloorDivide(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
161    #[cfg_attr(PyPy, link_name = "PyPyNumber_TrueDivide")]
162    pub fn PyNumber_TrueDivide(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
163    #[cfg_attr(PyPy, link_name = "PyPyNumber_Remainder")]
164    pub fn PyNumber_Remainder(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
165    #[cfg_attr(PyPy, link_name = "PyPyNumber_Divmod")]
166    pub fn PyNumber_Divmod(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
167    #[cfg_attr(PyPy, link_name = "PyPyNumber_Power")]
168    pub fn PyNumber_Power(o1: *mut PyObject, o2: *mut PyObject, o3: *mut PyObject)
169        -> *mut PyObject;
170    #[cfg_attr(PyPy, link_name = "PyPyNumber_Negative")]
171    pub fn PyNumber_Negative(o: *mut PyObject) -> *mut PyObject;
172    #[cfg_attr(PyPy, link_name = "PyPyNumber_Positive")]
173    pub fn PyNumber_Positive(o: *mut PyObject) -> *mut PyObject;
174    #[cfg_attr(PyPy, link_name = "PyPyNumber_Absolute")]
175    pub fn PyNumber_Absolute(o: *mut PyObject) -> *mut PyObject;
176    #[cfg_attr(PyPy, link_name = "PyPyNumber_Invert")]
177    pub fn PyNumber_Invert(o: *mut PyObject) -> *mut PyObject;
178    #[cfg_attr(PyPy, link_name = "PyPyNumber_Lshift")]
179    pub fn PyNumber_Lshift(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
180    #[cfg_attr(PyPy, link_name = "PyPyNumber_Rshift")]
181    pub fn PyNumber_Rshift(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
182    #[cfg_attr(PyPy, link_name = "PyPyNumber_And")]
183    pub fn PyNumber_And(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
184    #[cfg_attr(PyPy, link_name = "PyPyNumber_Xor")]
185    pub fn PyNumber_Xor(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
186    #[cfg_attr(PyPy, link_name = "PyPyNumber_Or")]
187    pub fn PyNumber_Or(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
188}
189
190// Defined as this macro in Python limited API, but relies on
191// non-limited PyTypeObject. Don't expose this since it cannot be used.
192#[cfg(not(any(Py_LIMITED_API, PyPy)))]
193#[inline]
194pub unsafe fn PyIndex_Check(o: *mut PyObject) -> c_int {
195    let tp_as_number = (*Py_TYPE(o)).tp_as_number;
196    (!tp_as_number.is_null() && (*tp_as_number).nb_index.is_some()) as c_int
197}
198
199extern_libpython! {
200    #[cfg(any(Py_LIMITED_API, PyPy))]
201    #[link_name = "PyPyIndex_Check"]
202    pub fn PyIndex_Check(o: *mut PyObject) -> c_int;
203
204    #[cfg_attr(PyPy, link_name = "PyPyNumber_Index")]
205    pub fn PyNumber_Index(o: *mut PyObject) -> *mut PyObject;
206    #[cfg_attr(PyPy, link_name = "PyPyNumber_AsSsize_t")]
207    pub fn PyNumber_AsSsize_t(o: *mut PyObject, exc: *mut PyObject) -> Py_ssize_t;
208    #[cfg_attr(PyPy, link_name = "PyPyNumber_Long")]
209    pub fn PyNumber_Long(o: *mut PyObject) -> *mut PyObject;
210    #[cfg_attr(PyPy, link_name = "PyPyNumber_Float")]
211    pub fn PyNumber_Float(o: *mut PyObject) -> *mut PyObject;
212    #[cfg_attr(PyPy, link_name = "PyPyNumber_InPlaceAdd")]
213    pub fn PyNumber_InPlaceAdd(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
214    #[cfg_attr(PyPy, link_name = "PyPyNumber_InPlaceSubtract")]
215    pub fn PyNumber_InPlaceSubtract(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
216    #[cfg_attr(PyPy, link_name = "PyPyNumber_InPlaceMultiply")]
217    pub fn PyNumber_InPlaceMultiply(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
218    #[cfg_attr(PyPy, link_name = "PyPyNumber_InPlaceMatrixMultiply")]
219    pub fn PyNumber_InPlaceMatrixMultiply(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
220    #[cfg_attr(PyPy, link_name = "PyPyNumber_InPlaceFloorDivide")]
221    pub fn PyNumber_InPlaceFloorDivide(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
222    #[cfg_attr(PyPy, link_name = "PyPyNumber_InPlaceTrueDivide")]
223    pub fn PyNumber_InPlaceTrueDivide(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
224    #[cfg_attr(PyPy, link_name = "PyPyNumber_InPlaceRemainder")]
225    pub fn PyNumber_InPlaceRemainder(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
226    #[cfg_attr(PyPy, link_name = "PyPyNumber_InPlacePower")]
227    pub fn PyNumber_InPlacePower(
228        o1: *mut PyObject,
229        o2: *mut PyObject,
230        o3: *mut PyObject,
231    ) -> *mut PyObject;
232    #[cfg_attr(PyPy, link_name = "PyPyNumber_InPlaceLshift")]
233    pub fn PyNumber_InPlaceLshift(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
234    #[cfg_attr(PyPy, link_name = "PyPyNumber_InPlaceRshift")]
235    pub fn PyNumber_InPlaceRshift(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
236    #[cfg_attr(PyPy, link_name = "PyPyNumber_InPlaceAnd")]
237    pub fn PyNumber_InPlaceAnd(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
238    #[cfg_attr(PyPy, link_name = "PyPyNumber_InPlaceXor")]
239    pub fn PyNumber_InPlaceXor(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
240    #[cfg_attr(PyPy, link_name = "PyPyNumber_InPlaceOr")]
241    pub fn PyNumber_InPlaceOr(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
242    pub fn PyNumber_ToBase(n: *mut PyObject, base: c_int) -> *mut PyObject;
243
244    #[cfg_attr(PyPy, link_name = "PyPySequence_Check")]
245    pub fn PySequence_Check(o: *mut PyObject) -> c_int;
246    #[cfg_attr(PyPy, link_name = "PyPySequence_Size")]
247    pub fn PySequence_Size(o: *mut PyObject) -> Py_ssize_t;
248
249    #[cfg(PyPy)]
250    #[link_name = "PyPySequence_Length"]
251    pub fn PySequence_Length(o: *mut PyObject) -> Py_ssize_t;
252}
253
254#[inline]
255#[cfg(not(PyPy))]
256pub unsafe fn PySequence_Length(o: *mut PyObject) -> Py_ssize_t {
257    PySequence_Size(o)
258}
259
260extern_libpython! {
261    #[cfg_attr(PyPy, link_name = "PyPySequence_Concat")]
262    pub fn PySequence_Concat(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
263    #[cfg_attr(PyPy, link_name = "PyPySequence_Repeat")]
264    pub fn PySequence_Repeat(o: *mut PyObject, count: Py_ssize_t) -> *mut PyObject;
265    #[cfg_attr(PyPy, link_name = "PyPySequence_GetItem")]
266    pub fn PySequence_GetItem(o: *mut PyObject, i: Py_ssize_t) -> *mut PyObject;
267    #[cfg_attr(PyPy, link_name = "PyPySequence_GetSlice")]
268    pub fn PySequence_GetSlice(o: *mut PyObject, i1: Py_ssize_t, i2: Py_ssize_t) -> *mut PyObject;
269    #[cfg_attr(PyPy, link_name = "PyPySequence_SetItem")]
270    pub fn PySequence_SetItem(o: *mut PyObject, i: Py_ssize_t, v: *mut PyObject) -> c_int;
271    #[cfg_attr(PyPy, link_name = "PyPySequence_DelItem")]
272    pub fn PySequence_DelItem(o: *mut PyObject, i: Py_ssize_t) -> c_int;
273    #[cfg_attr(PyPy, link_name = "PyPySequence_SetSlice")]
274    pub fn PySequence_SetSlice(
275        o: *mut PyObject,
276        i1: Py_ssize_t,
277        i2: Py_ssize_t,
278        v: *mut PyObject,
279    ) -> c_int;
280    #[cfg_attr(PyPy, link_name = "PyPySequence_DelSlice")]
281    pub fn PySequence_DelSlice(o: *mut PyObject, i1: Py_ssize_t, i2: Py_ssize_t) -> c_int;
282    #[cfg_attr(PyPy, link_name = "PyPySequence_Tuple")]
283    pub fn PySequence_Tuple(o: *mut PyObject) -> *mut PyObject;
284    #[cfg_attr(PyPy, link_name = "PyPySequence_List")]
285    pub fn PySequence_List(o: *mut PyObject) -> *mut PyObject;
286    #[cfg_attr(PyPy, link_name = "PyPySequence_Fast")]
287    pub fn PySequence_Fast(o: *mut PyObject, m: *const c_char) -> *mut PyObject;
288    // skipped PySequence_Fast_GET_SIZE
289    // skipped PySequence_Fast_GET_ITEM
290    // skipped PySequence_Fast_GET_ITEMS
291    pub fn PySequence_Count(o: *mut PyObject, value: *mut PyObject) -> Py_ssize_t;
292    #[cfg_attr(PyPy, link_name = "PyPySequence_Contains")]
293    pub fn PySequence_Contains(seq: *mut PyObject, ob: *mut PyObject) -> c_int;
294}
295
296#[inline]
297pub unsafe fn PySequence_In(o: *mut PyObject, value: *mut PyObject) -> c_int {
298    PySequence_Contains(o, value)
299}
300
301extern_libpython! {
302    #[cfg_attr(PyPy, link_name = "PyPySequence_Index")]
303    pub fn PySequence_Index(o: *mut PyObject, value: *mut PyObject) -> Py_ssize_t;
304    #[cfg_attr(PyPy, link_name = "PyPySequence_InPlaceConcat")]
305    pub fn PySequence_InPlaceConcat(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
306    #[cfg_attr(PyPy, link_name = "PyPySequence_InPlaceRepeat")]
307    pub fn PySequence_InPlaceRepeat(o: *mut PyObject, count: Py_ssize_t) -> *mut PyObject;
308    #[cfg_attr(PyPy, link_name = "PyPyMapping_Check")]
309    pub fn PyMapping_Check(o: *mut PyObject) -> c_int;
310    #[cfg_attr(PyPy, link_name = "PyPyMapping_Size")]
311    pub fn PyMapping_Size(o: *mut PyObject) -> Py_ssize_t;
312
313    #[cfg(PyPy)]
314    #[link_name = "PyPyMapping_Length"]
315    pub fn PyMapping_Length(o: *mut PyObject) -> Py_ssize_t;
316}
317
318#[inline]
319#[cfg(not(PyPy))]
320pub unsafe fn PyMapping_Length(o: *mut PyObject) -> Py_ssize_t {
321    PyMapping_Size(o)
322}
323
324#[inline]
325pub unsafe fn PyMapping_DelItemString(o: *mut PyObject, key: *mut c_char) -> c_int {
326    PyObject_DelItemString(o, key)
327}
328
329#[inline]
330pub unsafe fn PyMapping_DelItem(o: *mut PyObject, key: *mut PyObject) -> c_int {
331    PyObject_DelItem(o, key)
332}
333
334extern_libpython! {
335    #[cfg_attr(PyPy, link_name = "PyPyMapping_HasKeyString")]
336    pub fn PyMapping_HasKeyString(o: *mut PyObject, key: *const c_char) -> c_int;
337    #[cfg_attr(PyPy, link_name = "PyPyMapping_HasKey")]
338    pub fn PyMapping_HasKey(o: *mut PyObject, key: *mut PyObject) -> c_int;
339    #[cfg_attr(PyPy, link_name = "PyPyMapping_Keys")]
340    pub fn PyMapping_Keys(o: *mut PyObject) -> *mut PyObject;
341    #[cfg_attr(PyPy, link_name = "PyPyMapping_Values")]
342    pub fn PyMapping_Values(o: *mut PyObject) -> *mut PyObject;
343    #[cfg_attr(PyPy, link_name = "PyPyMapping_Items")]
344    pub fn PyMapping_Items(o: *mut PyObject) -> *mut PyObject;
345    #[cfg_attr(PyPy, link_name = "PyPyMapping_GetItemString")]
346    pub fn PyMapping_GetItemString(o: *mut PyObject, key: *const c_char) -> *mut PyObject;
347    #[cfg_attr(PyPy, link_name = "PyPyMapping_SetItemString")]
348    pub fn PyMapping_SetItemString(
349        o: *mut PyObject,
350        key: *const c_char,
351        value: *mut PyObject,
352    ) -> c_int;
353    #[cfg_attr(PyPy, link_name = "PyPyObject_IsInstance")]
354    pub fn PyObject_IsInstance(object: *mut PyObject, typeorclass: *mut PyObject) -> c_int;
355    #[cfg_attr(PyPy, link_name = "PyPyObject_IsSubclass")]
356    pub fn PyObject_IsSubclass(object: *mut PyObject, typeorclass: *mut PyObject) -> c_int;
357}
pyo3_ffi/abstract_.rs

pyo3_ffi/
abstract_.rs
