pyo3_ffi/
abstract_.rs

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

pyo3_ffi/
abstract_.rs
