pyo3_ffi/
moduleobject.rs

1use crate::methodobject::PyMethodDef;
2use crate::object::*;
3use crate::pyport::Py_ssize_t;
4use std::ffi::{c_char, c_int, c_void};
5
6extern_libpython! {
7    #[cfg_attr(PyPy, link_name = "PyPyModule_Type")]
8    pub static mut PyModule_Type: PyTypeObject;
9}
10
11#[inline]
12pub unsafe fn PyModule_Check(op: *mut PyObject) -> c_int {
13    PyObject_TypeCheck(op, &raw mut PyModule_Type)
14}
15
16#[inline]
17pub unsafe fn PyModule_CheckExact(op: *mut PyObject) -> c_int {
18    (Py_TYPE(op) == &raw mut PyModule_Type) as c_int
19}
20
21extern_libpython! {
22    #[cfg_attr(PyPy, link_name = "PyPyModule_NewObject")]
23    pub fn PyModule_NewObject(name: *mut PyObject) -> *mut PyObject;
24    #[cfg_attr(PyPy, link_name = "PyPyModule_New")]
25    pub fn PyModule_New(name: *const c_char) -> *mut PyObject;
26    #[cfg_attr(PyPy, link_name = "PyPyModule_GetDict")]
27    pub fn PyModule_GetDict(arg1: *mut PyObject) -> *mut PyObject;
28    #[cfg(not(PyPy))]
29    pub fn PyModule_GetNameObject(arg1: *mut PyObject) -> *mut PyObject;
30    #[cfg_attr(PyPy, link_name = "PyPyModule_GetName")]
31    pub fn PyModule_GetName(arg1: *mut PyObject) -> *const c_char;
32    #[cfg(not(all(windows, PyPy)))]
33    #[deprecated(note = "Python 3.2")]
34    pub fn PyModule_GetFilename(arg1: *mut PyObject) -> *const c_char;
35    #[cfg(not(PyPy))]
36    pub fn PyModule_GetFilenameObject(arg1: *mut PyObject) -> *mut PyObject;
37    // skipped non-limited _PyModule_Clear
38    // skipped non-limited _PyModule_ClearDict
39    // skipped non-limited _PyModuleSpec_IsInitializing
40    #[cfg_attr(PyPy, link_name = "PyPyModule_GetDef")]
41    pub fn PyModule_GetDef(arg1: *mut PyObject) -> *mut PyModuleDef;
42    #[cfg_attr(PyPy, link_name = "PyPyModule_GetState")]
43    pub fn PyModule_GetState(arg1: *mut PyObject) -> *mut c_void;
44    #[cfg_attr(PyPy, link_name = "PyPyModuleDef_Init")]
45    pub fn PyModuleDef_Init(arg1: *mut PyModuleDef) -> *mut PyObject;
46}
47
48extern_libpython! {
49    pub static mut PyModuleDef_Type: PyTypeObject;
50}
51
52#[repr(C)]
53pub struct PyModuleDef_Base {
54    pub ob_base: PyObject,
55    // Rust function pointers are non-null so an Option is needed here.
56    pub m_init: Option<extern "C" fn() -> *mut PyObject>,
57    pub m_index: Py_ssize_t,
58    pub m_copy: *mut PyObject,
59}
60
61#[allow(
62    clippy::declare_interior_mutable_const,
63    reason = "contains atomic refcount on free-threaded builds"
64)]
65pub const PyModuleDef_HEAD_INIT: PyModuleDef_Base = PyModuleDef_Base {
66    ob_base: PyObject_HEAD_INIT,
67    m_init: None,
68    m_index: 0,
69    m_copy: std::ptr::null_mut(),
70};
71
72#[repr(C)]
73#[derive(Copy, Clone, Eq, PartialEq)]
74pub struct PyModuleDef_Slot {
75    pub slot: c_int,
76    pub value: *mut c_void,
77}
78
79impl Default for PyModuleDef_Slot {
80    fn default() -> PyModuleDef_Slot {
81        PyModuleDef_Slot {
82            slot: 0,
83            value: std::ptr::null_mut(),
84        }
85    }
86}
87
88pub const Py_mod_create: c_int = 1;
89pub const Py_mod_exec: c_int = 2;
90#[cfg(Py_3_12)]
91pub const Py_mod_multiple_interpreters: c_int = 3;
92#[cfg(Py_3_13)]
93pub const Py_mod_gil: c_int = 4;
94#[cfg(Py_3_15)]
95pub const Py_mod_abi: c_int = 5;
96#[cfg(Py_3_15)]
97pub const Py_mod_name: c_int = 6;
98#[cfg(Py_3_15)]
99pub const Py_mod_doc: c_int = 7;
100#[cfg(Py_3_15)]
101pub const Py_mod_state_size: c_int = 8;
102#[cfg(Py_3_15)]
103pub const Py_mod_methods: c_int = 9;
104#[cfg(Py_3_15)]
105pub const Py_mod_state_traverse: c_int = 10;
106#[cfg(Py_3_15)]
107pub const Py_mod_state_clear: c_int = 11;
108#[cfg(Py_3_15)]
109pub const Py_mod_state_free: c_int = 12;
110#[cfg(Py_3_15)]
111pub const Py_mod_token: c_int = 13;
112
113// skipped private _Py_mod_LAST_SLOT
114
115#[cfg(Py_3_12)]
116#[allow(
117    clippy::zero_ptr,
118    reason = "matches the way that the rest of these constants are defined"
119)]
120pub const Py_MOD_MULTIPLE_INTERPRETERS_NOT_SUPPORTED: *mut c_void = 0 as *mut c_void;
121#[cfg(Py_3_12)]
122pub const Py_MOD_MULTIPLE_INTERPRETERS_SUPPORTED: *mut c_void = 1 as *mut c_void;
123#[cfg(Py_3_12)]
124pub const Py_MOD_PER_INTERPRETER_GIL_SUPPORTED: *mut c_void = 2 as *mut c_void;
125
126#[cfg(Py_3_13)]
127#[allow(
128    clippy::zero_ptr,
129    reason = "matches the way that the rest of these constants are defined"
130)]
131pub const Py_MOD_GIL_USED: *mut c_void = 0 as *mut c_void;
132#[cfg(Py_3_13)]
133pub const Py_MOD_GIL_NOT_USED: *mut c_void = 1 as *mut c_void;
134
135#[cfg(all(not(Py_LIMITED_API), Py_GIL_DISABLED))]
136extern_libpython! {
137    pub fn PyUnstable_Module_SetGIL(module: *mut PyObject, gil: *mut c_void) -> c_int;
138}
139
140#[cfg(Py_3_15)]
141extern_libpython! {
142    pub fn PyModule_FromSlotsAndSpec(
143        slots: *const PyModuleDef_Slot,
144        spec: *mut PyObject,
145    ) -> *mut PyObject;
146    pub fn PyModule_Exec(_mod: *mut PyObject) -> c_int;
147    pub fn PyModule_GetStateSize(_mod: *mut PyObject, result: *mut Py_ssize_t) -> c_int;
148    pub fn PyModule_GetToken(module: *mut PyObject, result: *mut *mut c_void) -> c_int;
149}
150
151#[repr(C)]
152pub struct PyModuleDef {
153    pub m_base: PyModuleDef_Base,
154    pub m_name: *const c_char,
155    pub m_doc: *const c_char,
156    pub m_size: Py_ssize_t,
157    pub m_methods: *mut PyMethodDef,
158    pub m_slots: *mut PyModuleDef_Slot,
159    // Rust function pointers are non-null so an Option is needed here.
160    pub m_traverse: Option<traverseproc>,
161    pub m_clear: Option<inquiry>,
162    pub m_free: Option<freefunc>,
163}
pyo3_ffi/moduleobject.rs

pyo3_ffi/
moduleobject.rs
