pyo3_ffi/
dictobject.rs

1use crate::object::*;
2use crate::pyport::Py_ssize_t;
3use std::ffi::{c_char, c_int};
4
5extern_libpython! {
6    #[cfg_attr(PyPy, link_name = "PyPyDict_Type")]
7    pub static mut PyDict_Type: PyTypeObject;
8}
9
10#[inline]
11pub unsafe fn PyDict_Check(op: *mut PyObject) -> c_int {
12    PyType_FastSubclass(Py_TYPE(op), Py_TPFLAGS_DICT_SUBCLASS)
13}
14
15#[inline]
16pub unsafe fn PyDict_CheckExact(op: *mut PyObject) -> c_int {
17    (Py_TYPE(op) == &raw mut PyDict_Type) as c_int
18}
19
20extern_libpython! {
21    #[cfg_attr(PyPy, link_name = "PyPyDict_New")]
22    pub fn PyDict_New() -> *mut PyObject;
23    #[cfg_attr(PyPy, link_name = "PyPyDict_GetItem")]
24    pub fn PyDict_GetItem(mp: *mut PyObject, key: *mut PyObject) -> *mut PyObject;
25    #[cfg_attr(PyPy, link_name = "PyPyDict_GetItemWithError")]
26    pub fn PyDict_GetItemWithError(mp: *mut PyObject, key: *mut PyObject) -> *mut PyObject;
27    #[cfg_attr(PyPy, link_name = "PyPyDict_SetItem")]
28    pub fn PyDict_SetItem(mp: *mut PyObject, key: *mut PyObject, item: *mut PyObject) -> c_int;
29    #[cfg_attr(PyPy, link_name = "PyPyDict_DelItem")]
30    pub fn PyDict_DelItem(mp: *mut PyObject, key: *mut PyObject) -> c_int;
31    #[cfg_attr(PyPy, link_name = "PyPyDict_Clear")]
32    pub fn PyDict_Clear(mp: *mut PyObject);
33    #[cfg_attr(PyPy, link_name = "PyPyDict_Next")]
34    pub fn PyDict_Next(
35        mp: *mut PyObject,
36        pos: *mut Py_ssize_t,
37        key: *mut *mut PyObject,
38        value: *mut *mut PyObject,
39    ) -> c_int;
40    #[cfg_attr(PyPy, link_name = "PyPyDict_Keys")]
41    pub fn PyDict_Keys(mp: *mut PyObject) -> *mut PyObject;
42    #[cfg_attr(PyPy, link_name = "PyPyDict_Values")]
43    pub fn PyDict_Values(mp: *mut PyObject) -> *mut PyObject;
44    #[cfg_attr(PyPy, link_name = "PyPyDict_Items")]
45    pub fn PyDict_Items(mp: *mut PyObject) -> *mut PyObject;
46    #[cfg_attr(PyPy, link_name = "PyPyDict_Size")]
47    pub fn PyDict_Size(mp: *mut PyObject) -> Py_ssize_t;
48    #[cfg_attr(PyPy, link_name = "PyPyDict_Copy")]
49    pub fn PyDict_Copy(mp: *mut PyObject) -> *mut PyObject;
50    #[cfg_attr(PyPy, link_name = "PyPyDict_Contains")]
51    pub fn PyDict_Contains(mp: *mut PyObject, key: *mut PyObject) -> c_int;
52    #[cfg_attr(PyPy, link_name = "PyPyDict_Update")]
53    pub fn PyDict_Update(mp: *mut PyObject, other: *mut PyObject) -> c_int;
54    #[cfg_attr(PyPy, link_name = "PyPyDict_Merge")]
55    pub fn PyDict_Merge(mp: *mut PyObject, other: *mut PyObject, _override: c_int) -> c_int;
56    pub fn PyDict_MergeFromSeq2(d: *mut PyObject, seq2: *mut PyObject, _override: c_int) -> c_int;
57    #[cfg_attr(PyPy, link_name = "PyPyDict_GetItemString")]
58    pub fn PyDict_GetItemString(dp: *mut PyObject, key: *const c_char) -> *mut PyObject;
59    #[cfg_attr(PyPy, link_name = "PyPyDict_SetItemString")]
60    pub fn PyDict_SetItemString(
61        dp: *mut PyObject,
62        key: *const c_char,
63        item: *mut PyObject,
64    ) -> c_int;
65    #[cfg_attr(PyPy, link_name = "PyPyDict_DelItemString")]
66    pub fn PyDict_DelItemString(dp: *mut PyObject, key: *const c_char) -> c_int;
67    #[cfg(Py_3_13)]
68    #[cfg_attr(PyPy, link_name = "PyPyDict_GetItemRef")]
69    pub fn PyDict_GetItemRef(
70        dp: *mut PyObject,
71        key: *mut PyObject,
72        result: *mut *mut PyObject,
73    ) -> c_int;
74    #[cfg(Py_3_13)]
75    #[cfg_attr(PyPy, link_name = "PyPyDict_GetItemStringRef")]
76    pub fn PyDict_GetItemStringRef(
77        dp: *mut PyObject,
78        key: *const c_char,
79        result: *mut *mut PyObject,
80    ) -> c_int;
81    // skipped 3.10 / ex-non-limited PyObject_GenericGetDict
82}
83
84extern_libpython! {
85    pub static mut PyDictKeys_Type: PyTypeObject;
86    pub static mut PyDictValues_Type: PyTypeObject;
87    pub static mut PyDictItems_Type: PyTypeObject;
88}
89
90#[inline]
91pub unsafe fn PyDictKeys_Check(op: *mut PyObject) -> c_int {
92    PyObject_TypeCheck(op, &raw mut PyDictKeys_Type)
93}
94
95#[inline]
96pub unsafe fn PyDictValues_Check(op: *mut PyObject) -> c_int {
97    PyObject_TypeCheck(op, &raw mut PyDictValues_Type)
98}
99
100#[inline]
101pub unsafe fn PyDictItems_Check(op: *mut PyObject) -> c_int {
102    PyObject_TypeCheck(op, &raw mut PyDictItems_Type)
103}
104
105#[inline]
106pub unsafe fn PyDictViewSet_Check(op: *mut PyObject) -> c_int {
107    (PyDictKeys_Check(op) != 0 || PyDictItems_Check(op) != 0) as c_int
108}
109
110extern_libpython! {
111    pub static mut PyDictIterKey_Type: PyTypeObject;
112    pub static mut PyDictIterValue_Type: PyTypeObject;
113    pub static mut PyDictIterItem_Type: PyTypeObject;
114    pub static mut PyDictRevIterKey_Type: PyTypeObject;
115    pub static mut PyDictRevIterValue_Type: PyTypeObject;
116    pub static mut PyDictRevIterItem_Type: PyTypeObject;
117}
118
119#[cfg(any(GraalPy, Py_LIMITED_API))]
120// TODO: remove (see https://github.com/PyO3/pyo3/pull/1341#issuecomment-751515985)
121opaque_struct!(pub PyDictObject);
pyo3_ffi/dictobject.rs

pyo3_ffi/
dictobject.rs
