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::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 "C" {
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, all(Py_3_8, 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 "C" {
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 "C" {
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 "C" {
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
132// Before 3.8 PyIter_Check was defined in CPython as a macro,
133// but the implementation of that in PyO3 did not work, see
134// https://github.com/PyO3/pyo3/pull/2914
135//
136// This is a slow implementation which should function equivalently.
137#[cfg(not(any(Py_3_8, PyPy)))]
138#[inline]
139pub unsafe fn PyIter_Check(o: *mut PyObject) -> c_int {
140    crate::PyObject_HasAttrString(crate::Py_TYPE(o).cast(), c"__next__".as_ptr())
141}
142
143extern "C" {
144    #[cfg(any(Py_3_8, PyPy))]
145    #[cfg_attr(PyPy, link_name = "PyPyIter_Check")]
146    pub fn PyIter_Check(obj: *mut PyObject) -> c_int;
147
148    #[cfg(Py_3_14)]
149    #[cfg_attr(PyPy, link_name = "PyPyIter_NextItem")]
150    pub fn PyIter_NextItem(iter: *mut PyObject, item: *mut *mut PyObject) -> c_int;
151    #[cfg_attr(PyPy, link_name = "PyPyIter_Next")]
152    pub fn PyIter_Next(arg1: *mut PyObject) -> *mut PyObject;
153    #[cfg(all(not(PyPy), Py_3_10))]
154    #[cfg_attr(PyPy, link_name = "PyPyIter_Send")]
155    pub fn PyIter_Send(
156        iter: *mut PyObject,
157        arg: *mut PyObject,
158        presult: *mut *mut PyObject,
159    ) -> PySendResult;
160
161    #[cfg_attr(PyPy, link_name = "PyPyNumber_Check")]
162    pub fn PyNumber_Check(o: *mut PyObject) -> c_int;
163    #[cfg_attr(PyPy, link_name = "PyPyNumber_Add")]
164    pub fn PyNumber_Add(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
165    #[cfg_attr(PyPy, link_name = "PyPyNumber_Subtract")]
166    pub fn PyNumber_Subtract(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
167    #[cfg_attr(PyPy, link_name = "PyPyNumber_Multiply")]
168    pub fn PyNumber_Multiply(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
169    #[cfg_attr(PyPy, link_name = "PyPyNumber_MatrixMultiply")]
170    pub fn PyNumber_MatrixMultiply(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
171    #[cfg_attr(PyPy, link_name = "PyPyNumber_FloorDivide")]
172    pub fn PyNumber_FloorDivide(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
173    #[cfg_attr(PyPy, link_name = "PyPyNumber_TrueDivide")]
174    pub fn PyNumber_TrueDivide(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
175    #[cfg_attr(PyPy, link_name = "PyPyNumber_Remainder")]
176    pub fn PyNumber_Remainder(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
177    #[cfg_attr(PyPy, link_name = "PyPyNumber_Divmod")]
178    pub fn PyNumber_Divmod(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
179    #[cfg_attr(PyPy, link_name = "PyPyNumber_Power")]
180    pub fn PyNumber_Power(o1: *mut PyObject, o2: *mut PyObject, o3: *mut PyObject)
181        -> *mut PyObject;
182    #[cfg_attr(PyPy, link_name = "PyPyNumber_Negative")]
183    pub fn PyNumber_Negative(o: *mut PyObject) -> *mut PyObject;
184    #[cfg_attr(PyPy, link_name = "PyPyNumber_Positive")]
185    pub fn PyNumber_Positive(o: *mut PyObject) -> *mut PyObject;
186    #[cfg_attr(PyPy, link_name = "PyPyNumber_Absolute")]
187    pub fn PyNumber_Absolute(o: *mut PyObject) -> *mut PyObject;
188    #[cfg_attr(PyPy, link_name = "PyPyNumber_Invert")]
189    pub fn PyNumber_Invert(o: *mut PyObject) -> *mut PyObject;
190    #[cfg_attr(PyPy, link_name = "PyPyNumber_Lshift")]
191    pub fn PyNumber_Lshift(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
192    #[cfg_attr(PyPy, link_name = "PyPyNumber_Rshift")]
193    pub fn PyNumber_Rshift(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
194    #[cfg_attr(PyPy, link_name = "PyPyNumber_And")]
195    pub fn PyNumber_And(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
196    #[cfg_attr(PyPy, link_name = "PyPyNumber_Xor")]
197    pub fn PyNumber_Xor(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
198    #[cfg_attr(PyPy, link_name = "PyPyNumber_Or")]
199    pub fn PyNumber_Or(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
200}
201
202// Defined as this macro in Python limited API, but relies on
203// non-limited PyTypeObject. Don't expose this since it cannot be used.
204#[cfg(not(any(Py_LIMITED_API, PyPy)))]
205#[inline]
206pub unsafe fn PyIndex_Check(o: *mut PyObject) -> c_int {
207    let tp_as_number = (*Py_TYPE(o)).tp_as_number;
208    (!tp_as_number.is_null() && (*tp_as_number).nb_index.is_some()) as c_int
209}
210
211extern "C" {
212    #[cfg(any(all(Py_3_8, Py_LIMITED_API), PyPy))]
213    #[link_name = "PyPyIndex_Check"]
214    pub fn PyIndex_Check(o: *mut PyObject) -> c_int;
215
216    #[cfg_attr(PyPy, link_name = "PyPyNumber_Index")]
217    pub fn PyNumber_Index(o: *mut PyObject) -> *mut PyObject;
218    #[cfg_attr(PyPy, link_name = "PyPyNumber_AsSsize_t")]
219    pub fn PyNumber_AsSsize_t(o: *mut PyObject, exc: *mut PyObject) -> Py_ssize_t;
220    #[cfg_attr(PyPy, link_name = "PyPyNumber_Long")]
221    pub fn PyNumber_Long(o: *mut PyObject) -> *mut PyObject;
222    #[cfg_attr(PyPy, link_name = "PyPyNumber_Float")]
223    pub fn PyNumber_Float(o: *mut PyObject) -> *mut PyObject;
224    #[cfg_attr(PyPy, link_name = "PyPyNumber_InPlaceAdd")]
225    pub fn PyNumber_InPlaceAdd(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
226    #[cfg_attr(PyPy, link_name = "PyPyNumber_InPlaceSubtract")]
227    pub fn PyNumber_InPlaceSubtract(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
228    #[cfg_attr(PyPy, link_name = "PyPyNumber_InPlaceMultiply")]
229    pub fn PyNumber_InPlaceMultiply(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
230    #[cfg_attr(PyPy, link_name = "PyPyNumber_InPlaceMatrixMultiply")]
231    pub fn PyNumber_InPlaceMatrixMultiply(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
232    #[cfg_attr(PyPy, link_name = "PyPyNumber_InPlaceFloorDivide")]
233    pub fn PyNumber_InPlaceFloorDivide(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
234    #[cfg_attr(PyPy, link_name = "PyPyNumber_InPlaceTrueDivide")]
235    pub fn PyNumber_InPlaceTrueDivide(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
236    #[cfg_attr(PyPy, link_name = "PyPyNumber_InPlaceRemainder")]
237    pub fn PyNumber_InPlaceRemainder(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
238    #[cfg_attr(PyPy, link_name = "PyPyNumber_InPlacePower")]
239    pub fn PyNumber_InPlacePower(
240        o1: *mut PyObject,
241        o2: *mut PyObject,
242        o3: *mut PyObject,
243    ) -> *mut PyObject;
244    #[cfg_attr(PyPy, link_name = "PyPyNumber_InPlaceLshift")]
245    pub fn PyNumber_InPlaceLshift(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
246    #[cfg_attr(PyPy, link_name = "PyPyNumber_InPlaceRshift")]
247    pub fn PyNumber_InPlaceRshift(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
248    #[cfg_attr(PyPy, link_name = "PyPyNumber_InPlaceAnd")]
249    pub fn PyNumber_InPlaceAnd(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
250    #[cfg_attr(PyPy, link_name = "PyPyNumber_InPlaceXor")]
251    pub fn PyNumber_InPlaceXor(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
252    #[cfg_attr(PyPy, link_name = "PyPyNumber_InPlaceOr")]
253    pub fn PyNumber_InPlaceOr(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
254    pub fn PyNumber_ToBase(n: *mut PyObject, base: c_int) -> *mut PyObject;
255
256    #[cfg_attr(PyPy, link_name = "PyPySequence_Check")]
257    pub fn PySequence_Check(o: *mut PyObject) -> c_int;
258    #[cfg_attr(PyPy, link_name = "PyPySequence_Size")]
259    pub fn PySequence_Size(o: *mut PyObject) -> Py_ssize_t;
260
261    #[cfg(PyPy)]
262    #[link_name = "PyPySequence_Length"]
263    pub fn PySequence_Length(o: *mut PyObject) -> Py_ssize_t;
264}
265
266#[inline]
267#[cfg(not(PyPy))]
268pub unsafe fn PySequence_Length(o: *mut PyObject) -> Py_ssize_t {
269    PySequence_Size(o)
270}
271
272extern "C" {
273    #[cfg_attr(PyPy, link_name = "PyPySequence_Concat")]
274    pub fn PySequence_Concat(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
275    #[cfg_attr(PyPy, link_name = "PyPySequence_Repeat")]
276    pub fn PySequence_Repeat(o: *mut PyObject, count: Py_ssize_t) -> *mut PyObject;
277    #[cfg_attr(PyPy, link_name = "PyPySequence_GetItem")]
278    pub fn PySequence_GetItem(o: *mut PyObject, i: Py_ssize_t) -> *mut PyObject;
279    #[cfg_attr(PyPy, link_name = "PyPySequence_GetSlice")]
280    pub fn PySequence_GetSlice(o: *mut PyObject, i1: Py_ssize_t, i2: Py_ssize_t) -> *mut PyObject;
281    #[cfg_attr(PyPy, link_name = "PyPySequence_SetItem")]
282    pub fn PySequence_SetItem(o: *mut PyObject, i: Py_ssize_t, v: *mut PyObject) -> c_int;
283    #[cfg_attr(PyPy, link_name = "PyPySequence_DelItem")]
284    pub fn PySequence_DelItem(o: *mut PyObject, i: Py_ssize_t) -> c_int;
285    #[cfg_attr(PyPy, link_name = "PyPySequence_SetSlice")]
286    pub fn PySequence_SetSlice(
287        o: *mut PyObject,
288        i1: Py_ssize_t,
289        i2: Py_ssize_t,
290        v: *mut PyObject,
291    ) -> c_int;
292    #[cfg_attr(PyPy, link_name = "PyPySequence_DelSlice")]
293    pub fn PySequence_DelSlice(o: *mut PyObject, i1: Py_ssize_t, i2: Py_ssize_t) -> c_int;
294    #[cfg_attr(PyPy, link_name = "PyPySequence_Tuple")]
295    pub fn PySequence_Tuple(o: *mut PyObject) -> *mut PyObject;
296    #[cfg_attr(PyPy, link_name = "PyPySequence_List")]
297    pub fn PySequence_List(o: *mut PyObject) -> *mut PyObject;
298    #[cfg_attr(PyPy, link_name = "PyPySequence_Fast")]
299    pub fn PySequence_Fast(o: *mut PyObject, m: *const c_char) -> *mut PyObject;
300    // skipped PySequence_Fast_GET_SIZE
301    // skipped PySequence_Fast_GET_ITEM
302    // skipped PySequence_Fast_GET_ITEMS
303    pub fn PySequence_Count(o: *mut PyObject, value: *mut PyObject) -> Py_ssize_t;
304    #[cfg_attr(PyPy, link_name = "PyPySequence_Contains")]
305    pub fn PySequence_Contains(seq: *mut PyObject, ob: *mut PyObject) -> c_int;
306}
307
308#[inline]
309pub unsafe fn PySequence_In(o: *mut PyObject, value: *mut PyObject) -> c_int {
310    PySequence_Contains(o, value)
311}
312
313extern "C" {
314    #[cfg_attr(PyPy, link_name = "PyPySequence_Index")]
315    pub fn PySequence_Index(o: *mut PyObject, value: *mut PyObject) -> Py_ssize_t;
316    #[cfg_attr(PyPy, link_name = "PyPySequence_InPlaceConcat")]
317    pub fn PySequence_InPlaceConcat(o1: *mut PyObject, o2: *mut PyObject) -> *mut PyObject;
318    #[cfg_attr(PyPy, link_name = "PyPySequence_InPlaceRepeat")]
319    pub fn PySequence_InPlaceRepeat(o: *mut PyObject, count: Py_ssize_t) -> *mut PyObject;
320    #[cfg_attr(PyPy, link_name = "PyPyMapping_Check")]
321    pub fn PyMapping_Check(o: *mut PyObject) -> c_int;
322    #[cfg_attr(PyPy, link_name = "PyPyMapping_Size")]
323    pub fn PyMapping_Size(o: *mut PyObject) -> Py_ssize_t;
324
325    #[cfg(PyPy)]
326    #[link_name = "PyPyMapping_Length"]
327    pub fn PyMapping_Length(o: *mut PyObject) -> Py_ssize_t;
328}
329
330#[inline]
331#[cfg(not(PyPy))]
332pub unsafe fn PyMapping_Length(o: *mut PyObject) -> Py_ssize_t {
333    PyMapping_Size(o)
334}
335
336#[inline]
337pub unsafe fn PyMapping_DelItemString(o: *mut PyObject, key: *mut c_char) -> c_int {
338    PyObject_DelItemString(o, key)
339}
340
341#[inline]
342pub unsafe fn PyMapping_DelItem(o: *mut PyObject, key: *mut PyObject) -> c_int {
343    PyObject_DelItem(o, key)
344}
345
346extern "C" {
347    #[cfg_attr(PyPy, link_name = "PyPyMapping_HasKeyString")]
348    pub fn PyMapping_HasKeyString(o: *mut PyObject, key: *const c_char) -> c_int;
349    #[cfg_attr(PyPy, link_name = "PyPyMapping_HasKey")]
350    pub fn PyMapping_HasKey(o: *mut PyObject, key: *mut PyObject) -> c_int;
351    #[cfg_attr(PyPy, link_name = "PyPyMapping_Keys")]
352    pub fn PyMapping_Keys(o: *mut PyObject) -> *mut PyObject;
353    #[cfg_attr(PyPy, link_name = "PyPyMapping_Values")]
354    pub fn PyMapping_Values(o: *mut PyObject) -> *mut PyObject;
355    #[cfg_attr(PyPy, link_name = "PyPyMapping_Items")]
356    pub fn PyMapping_Items(o: *mut PyObject) -> *mut PyObject;
357    #[cfg_attr(PyPy, link_name = "PyPyMapping_GetItemString")]
358    pub fn PyMapping_GetItemString(o: *mut PyObject, key: *const c_char) -> *mut PyObject;
359    #[cfg_attr(PyPy, link_name = "PyPyMapping_SetItemString")]
360    pub fn PyMapping_SetItemString(
361        o: *mut PyObject,
362        key: *const c_char,
363        value: *mut PyObject,
364    ) -> c_int;
365    #[cfg_attr(PyPy, link_name = "PyPyObject_IsInstance")]
366    pub fn PyObject_IsInstance(object: *mut PyObject, typeorclass: *mut PyObject) -> c_int;
367    #[cfg_attr(PyPy, link_name = "PyPyObject_IsSubclass")]
368    pub fn PyObject_IsSubclass(object: *mut PyObject, typeorclass: *mut PyObject) -> c_int;
369}
pyo3_ffi/abstract_.rs

pyo3_ffi/
abstract_.rs
