pyo3-ffi 0.29.1

Python-API bindings for the PyO3 ecosystem
Documentation
compat_function!(
    originally_defined_for(Py_3_13);

    #[inline]
    pub unsafe fn PyDict_GetItemRef(
        dp: *mut crate::PyObject,
        key: *mut crate::PyObject,
        result: *mut *mut crate::PyObject,
    ) -> core::ffi::c_int {
        use crate::{compat::Py_NewRef, PyDict_GetItemWithError, PyErr_Occurred};

        let item = PyDict_GetItemWithError(dp, key);
        if !item.is_null() {
            *result = Py_NewRef(item);
            return 1; // found
        }
        *result = core::ptr::null_mut();
        if PyErr_Occurred().is_null() {
            return 0; // not found
        }
        -1
    }
);

compat_function!(
    originally_defined_for(Py_3_13);

    #[inline]
    pub unsafe fn PyList_GetItemRef(
        arg1: *mut crate::PyObject,
        arg2: crate::Py_ssize_t,
    ) -> *mut crate::PyObject {
        use crate::{PyList_GetItem, Py_XINCREF};

        let item = PyList_GetItem(arg1, arg2);
        Py_XINCREF(item);
        item
    }
);

compat_function!(
    originally_defined_for(Py_3_13);

    #[inline]
    pub unsafe fn PyImport_AddModuleRef(
        name: *const core::ffi::c_char,
    ) -> *mut crate::PyObject {
        use crate::{compat::Py_XNewRef, PyImport_AddModule};

        Py_XNewRef(PyImport_AddModule(name))
    }
);

compat_function!(
    originally_defined_for(Py_3_13);

    #[inline]
    pub unsafe fn PyWeakref_GetRef(
        reference: *mut crate::PyObject,
        pobj: *mut *mut crate::PyObject,
    ) -> core::ffi::c_int {
        use crate::{
            compat::Py_NewRef, PyErr_SetString, PyExc_TypeError, PyWeakref_Check,
            PyWeakref_GetObject, Py_None,
        };

        if !reference.is_null() && PyWeakref_Check(reference) == 0 {
            *pobj = core::ptr::null_mut();
            PyErr_SetString(PyExc_TypeError, c"expected a weakref".as_ptr());
            return -1;
        }
        let obj = PyWeakref_GetObject(reference);
        if obj.is_null() {
            // SystemError if reference is NULL
            *pobj = core::ptr::null_mut();
            return -1;
        }
        if obj == Py_None() {
            *pobj = core::ptr::null_mut();
            return 0;
        }
        *pobj = Py_NewRef(obj);
        1
    }
);

compat_function!(
    originally_defined_for(Py_3_13);

    #[inline]
    pub unsafe fn PyList_Extend(
        list: *mut crate::PyObject,
        iterable: *mut crate::PyObject,
    ) -> core::ffi::c_int {
        crate::PyList_SetSlice(list, crate::PY_SSIZE_T_MAX, crate::PY_SSIZE_T_MAX, iterable)
    }
);

compat_function!(
    originally_defined_for(Py_3_13);

    #[inline]
    pub unsafe fn PyList_Clear(list: *mut crate::PyObject) -> core::ffi::c_int {
        crate::PyList_SetSlice(list, 0, crate::PY_SSIZE_T_MAX, core::ptr::null_mut())
    }
);

compat_function!(
    originally_defined_for(Py_3_13);

    #[inline]
    pub unsafe fn PyModule_Add(
        module: *mut crate::PyObject,
        name: *const core::ffi::c_char,
        value: *mut crate::PyObject,
    ) -> core::ffi::c_int {
        let result = crate::compat::PyModule_AddObjectRef(module, name, value);
        crate::Py_XDECREF(value);
        result
    }
);

#[cfg(not(Py_LIMITED_API))]
compat_function!(
    originally_defined_for(Py_3_13);

    #[inline]
    pub unsafe fn PyThreadState_GetUnchecked(
    ) -> *mut crate::PyThreadState {
        crate::_PyThreadState_UncheckedGet()
    }
);

compat_function!(
    originally_defined_for(all(Py_3_13, any(not(Py_LIMITED_API), Py_3_15)));

    #[inline]
    pub unsafe fn PyDict_SetDefaultRef(
        mp: *mut crate::PyObject,
        key: *mut crate::PyObject,
        default_value: *mut crate::PyObject,
        result: *mut *mut crate::PyObject,
    ) -> core::ffi::c_int {
        use crate::{
            compat::{PyDict_GetItemRef, Py_NewRef},
            PyDict_SetItem, PyObject, Py_DECREF,
        };
        let mut value: *mut PyObject = core::ptr::null_mut();
        if PyDict_GetItemRef(mp, key, &mut value) < 0 {
            // get error
            if !result.is_null() {
                *result = core::ptr::null_mut();
            }
            return -1;
        }
        if !value.is_null() {
            // present
            if !result.is_null() {
                *result = value;
            } else {
                Py_DECREF(value);
            }
            return 1;
        }

        // missing, set the item
        if PyDict_SetItem(mp, key, default_value) < 0 {
            // set error
            if !result.is_null() {
                *result = core::ptr::null_mut();
            }
            return -1;
        }
        if !result.is_null() {
            *result = Py_NewRef(default_value);
        }
        0
    }
);

compat_function!(
    originally_defined_for(Py_3_13);

    #[inline]
    pub unsafe fn PyObject_GetOptionalAttr(
        obj: *mut crate::PyObject,
        name: *mut crate::PyObject,
        result: *mut *mut crate::PyObject,
    ) -> core::ffi::c_int {
        use crate::{PyErr_Clear, PyErr_ExceptionMatches, PyExc_AttributeError, PyObject_GetAttr};

        let attr = PyObject_GetAttr(obj, name);
        if !attr.is_null() {
            *result = attr;
            return 1; // found
        }
        *result = core::ptr::null_mut();
        if PyErr_ExceptionMatches(PyExc_AttributeError) != 0 {
            PyErr_Clear();
            return 0; // not found
        }
        -1 // other error
    }
);

compat_function!(
    originally_defined_for(Py_3_13);

    #[inline]
    pub unsafe fn PyObject_HasAttrWithError(obj: *mut crate::PyObject, attr_name: *mut crate::PyObject) -> core::ffi::c_int {
        let mut res: *mut crate::PyObject = core::ptr::null_mut();
        let rc = crate::compat::PyObject_GetOptionalAttr(obj, attr_name, &mut res);
        crate::Py_XDECREF(res);
        rc
    }
);