pyo3_ffi/
abstract_.rs

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

pyo3_ffi/
abstract_.rs
