pyo3_ffi/
modsupport.rs

1use crate::methodobject::PyMethodDef;
2use crate::moduleobject::PyModuleDef;
3use crate::object::PyObject;
4use crate::pyport::Py_ssize_t;
5use std::os::raw::{c_char, c_int, c_long};
6
7extern "C" {
8    #[cfg_attr(PyPy, link_name = "PyPyArg_Parse")]
9    pub fn PyArg_Parse(arg1: *mut PyObject, arg2: *const c_char, ...) -> c_int;
10    #[cfg_attr(PyPy, link_name = "PyPyArg_ParseTuple")]
11    pub fn PyArg_ParseTuple(arg1: *mut PyObject, arg2: *const c_char, ...) -> c_int;
12    #[cfg_attr(PyPy, link_name = "PyPyArg_ParseTupleAndKeywords")]
13    pub fn PyArg_ParseTupleAndKeywords(
14        arg1: *mut PyObject,
15        arg2: *mut PyObject,
16        arg3: *const c_char,
17        #[cfg(not(Py_3_13))] arg4: *mut *mut c_char,
18        #[cfg(Py_3_13)] arg4: *const *const c_char,
19        ...
20    ) -> c_int;
21
22    // skipped PyArg_VaParse
23    // skipped PyArg_VaParseTupleAndKeywords
24
25    pub fn PyArg_ValidateKeywordArguments(arg1: *mut PyObject) -> c_int;
26    #[cfg_attr(PyPy, link_name = "PyPyArg_UnpackTuple")]
27    pub fn PyArg_UnpackTuple(
28        arg1: *mut PyObject,
29        arg2: *const c_char,
30        arg3: Py_ssize_t,
31        arg4: Py_ssize_t,
32        ...
33    ) -> c_int;
34
35    #[cfg_attr(PyPy, link_name = "PyPy_BuildValue")]
36    pub fn Py_BuildValue(arg1: *const c_char, ...) -> *mut PyObject;
37    // skipped Py_VaBuildValue
38
39    #[cfg(Py_3_13)]
40    pub fn PyModule_Add(module: *mut PyObject, name: *const c_char, value: *mut PyObject) -> c_int;
41    #[cfg(Py_3_10)]
42    #[cfg_attr(PyPy, link_name = "PyPyModule_AddObjectRef")]
43    pub fn PyModule_AddObjectRef(
44        module: *mut PyObject,
45        name: *const c_char,
46        value: *mut PyObject,
47    ) -> c_int;
48    #[cfg_attr(PyPy, link_name = "PyPyModule_AddObject")]
49    pub fn PyModule_AddObject(
50        module: *mut PyObject,
51        name: *const c_char,
52        value: *mut PyObject,
53    ) -> c_int;
54    #[cfg_attr(PyPy, link_name = "PyPyModule_AddIntConstant")]
55    pub fn PyModule_AddIntConstant(
56        module: *mut PyObject,
57        name: *const c_char,
58        value: c_long,
59    ) -> c_int;
60    #[cfg_attr(PyPy, link_name = "PyPyModule_AddStringConstant")]
61    pub fn PyModule_AddStringConstant(
62        module: *mut PyObject,
63        name: *const c_char,
64        value: *const c_char,
65    ) -> c_int;
66    #[cfg(any(Py_3_10, all(Py_3_9, not(Py_LIMITED_API))))]
67    #[cfg_attr(PyPy, link_name = "PyPyModule_AddType")]
68    pub fn PyModule_AddType(
69        module: *mut PyObject,
70        type_: *mut crate::object::PyTypeObject,
71    ) -> c_int;
72    // skipped PyModule_AddIntMacro
73    // skipped PyModule_AddStringMacro
74    pub fn PyModule_SetDocString(arg1: *mut PyObject, arg2: *const c_char) -> c_int;
75    pub fn PyModule_AddFunctions(arg1: *mut PyObject, arg2: *mut PyMethodDef) -> c_int;
76    pub fn PyModule_ExecDef(module: *mut PyObject, def: *mut PyModuleDef) -> c_int;
77}
78
79pub const Py_CLEANUP_SUPPORTED: i32 = 0x2_0000;
80
81pub const PYTHON_API_VERSION: i32 = 1013;
82pub const PYTHON_ABI_VERSION: i32 = 3;
83
84extern "C" {
85    #[cfg(not(py_sys_config = "Py_TRACE_REFS"))]
86    #[cfg_attr(PyPy, link_name = "PyPyModule_Create2")]
87    pub fn PyModule_Create2(module: *mut PyModuleDef, apiver: c_int) -> *mut PyObject;
88
89    #[cfg(py_sys_config = "Py_TRACE_REFS")]
90    fn PyModule_Create2TraceRefs(module: *mut PyModuleDef, apiver: c_int) -> *mut PyObject;
91
92    #[cfg(not(py_sys_config = "Py_TRACE_REFS"))]
93    pub fn PyModule_FromDefAndSpec2(
94        def: *mut PyModuleDef,
95        spec: *mut PyObject,
96        module_api_version: c_int,
97    ) -> *mut PyObject;
98
99    #[cfg(py_sys_config = "Py_TRACE_REFS")]
100    fn PyModule_FromDefAndSpec2TraceRefs(
101        def: *mut PyModuleDef,
102        spec: *mut PyObject,
103        module_api_version: c_int,
104    ) -> *mut PyObject;
105}
106
107#[cfg(py_sys_config = "Py_TRACE_REFS")]
108#[inline]
109pub unsafe fn PyModule_Create2(module: *mut PyModuleDef, apiver: c_int) -> *mut PyObject {
110    PyModule_Create2TraceRefs(module, apiver)
111}
112
113#[cfg(py_sys_config = "Py_TRACE_REFS")]
114#[inline]
115pub unsafe fn PyModule_FromDefAndSpec2(
116    def: *mut PyModuleDef,
117    spec: *mut PyObject,
118    module_api_version: c_int,
119) -> *mut PyObject {
120    PyModule_FromDefAndSpec2TraceRefs(def, spec, module_api_version)
121}
122
123#[inline]
124pub unsafe fn PyModule_Create(module: *mut PyModuleDef) -> *mut PyObject {
125    PyModule_Create2(
126        module,
127        if cfg!(Py_LIMITED_API) {
128            PYTHON_ABI_VERSION
129        } else {
130            PYTHON_API_VERSION
131        },
132    )
133}
134
135#[inline]
136pub unsafe fn PyModule_FromDefAndSpec(def: *mut PyModuleDef, spec: *mut PyObject) -> *mut PyObject {
137    PyModule_FromDefAndSpec2(
138        def,
139        spec,
140        if cfg!(Py_LIMITED_API) {
141            PYTHON_ABI_VERSION
142        } else {
143            PYTHON_API_VERSION
144        },
145    )
146}
⚠️ Internal Docs ⚠️ Not Public API 👉 Official Docs Here