# module.rs - source
Source of the Rust file `/home/runner/.cargo/registry/src/github.com-1ecc6299db9ec823/pyo3-0.13.2/src/types/module.rs`.
Keywords: rust, rustlang, rust-lang

      1
      2
      3
      4
      5
      6
      7
      8
      9
     10
     11
     12
     13
     14
     15
     16
     17
     18
     19
     20
     21
     22
     23
     24
     25
     26
     27
     28
     29
     30
     31
     32
     33
     34
     35
     36
     37
     38
     39
     40
     41
     42
     43
     44
     45
     46
     47
     48
     49
     50
     51
     52
     53
     54
     55
     56
     57
     58
     59
     60
     61
     62
     63
     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282

    // Copyright (c) 2017-present PyO3 Project and Contributors
    //
    // based on Daniel Grunwald's https://github.com/dgrunwald/rust-cpython

    use crate::callback::IntoPyCallbackOutput;
    use crate::err::{PyErr, PyResult};
    use crate::exceptions;
    use crate::ffi;
    use crate::instance::PyNativeType;
    use crate::pyclass::PyClass;
    use crate::type_object::PyTypeObject;
    use crate::types::{PyAny, PyDict, PyList};
    use crate::types::{PyCFunction, PyTuple};
    use crate::{AsPyPointer, IntoPy, Py, PyObject, Python};
    use std::ffi::{CStr, CString};
    use std::os::raw::c_char;
    use std::str;

    /// Represents a Python `module` object.
    #[repr(transparent)]
    pub struct PyModule(PyAny);

    pyobject_native_var_type!(PyModule, ffi::PyModule_Type, ffi::PyModule_Check);

    impl PyModule {
        /// Creates a new module object with the `__name__` attribute set to name.
        pub fn new<'p>(py: Python<'p>, name: &str) -> PyResult<&'p PyModule> {
            // Could use PyModule_NewObject, but it doesn't exist on PyPy.
            let name = CString::new(name)?;
            unsafe { py.from_owned_ptr_or_err(ffi::PyModule_New(name.as_ptr())) }
        }

        /// Imports the Python module with the specified name.
        pub fn import<'p>(py: Python<'p>, name: &str) -> PyResult<&'p PyModule> {
            crate::types::with_tmp_string(py, name, |name| unsafe {
                py.from_owned_ptr_or_err(ffi::PyImport_Import(name))
            })
        }

        /// Loads the Python code specified into a new module.
        ///
        /// `code` is the raw Python you want to load into the module.
        /// `file_name` is the file name to associate with the module
        /// (this is used when Python reports errors, for example).
        /// `module_name` is the name to give the module.
        pub fn from_code<'p>(
            py: Python<'p>,
            code: &str,
            file_name: &str,
            module_name: &str,
        ) -> PyResult<&'p PyModule> {
            let data = CString::new(code)?;
            let filename = CString::new(file_name)?;
            let module = CString::new(module_name)?;

            unsafe {
                let cptr = ffi::Py_CompileString(data.as_ptr(), filename.as_ptr(), ffi::Py_file_input);
                if cptr.is_null() {
                    return Err(PyErr::fetch(py));
                }

                let mptr = ffi::PyImport_ExecCodeModuleEx(module.as_ptr(), cptr, filename.as_ptr());
                if mptr.is_null() {
                    return Err(PyErr::fetch(py));
                }

                <&PyModule as crate::FromPyObject>::extract(py.from_owned_ptr_or_err(mptr)?)
            }
        }

        /// Return the dictionary object that implements module's namespace;
        /// this object is the same as the `__dict__` attribute of the module object.
        pub fn dict(&self) -> &PyDict {
            unsafe {
                // PyModule_GetDict returns borrowed ptr; must make owned for safety (see #890).
                let ptr = ffi::PyModule_GetDict(self.as_ptr());
                ffi::Py_INCREF(ptr);
                self.py().from_owned_ptr(ptr)
            }
        }

        /// Return the index (`__all__`) of the module, creating one if needed.
        pub fn index(&self) -> PyResult<&PyList> {
            match self.getattr("__all__") {
                Ok(idx) => idx.downcast().map_err(PyErr::from),
                Err(err) => {
                    if err.is_instance::<exceptions::PyAttributeError>(self.py()) {
                        let l = PyList::empty(self.py());
                        self.setattr("__all__", l).map_err(PyErr::from)?;
                        Ok(l)
                    } else {
                        Err(err)
                    }
                }
            }
        }

        unsafe fn str_from_ptr(&self, ptr: *const c_char) -> PyResult<&str> {
            if ptr.is_null() {
                Err(PyErr::fetch(self.py()))
            } else {
                let slice = CStr::from_ptr(ptr).to_bytes();
                match str::from_utf8(slice) {
                    Ok(s) => Ok(s),
                    Err(e) => Err(PyErr::from_instance(
                        exceptions::PyUnicodeDecodeError::new_utf8(self.py(), slice, e)?,
                    )),
                }
            }
        }

        /// Returns the module's name.
        ///
        /// May fail if the module does not have a `__name__` attribute.
        pub fn name(&self) -> PyResult<&str> {
            unsafe { self.str_from_ptr(ffi::PyModule_GetName(self.as_ptr())) }
        }

        /// Returns the module's filename.
        ///
        /// May fail if the module does not have a `__file__` attribute.
        #[cfg(not(all(windows, PyPy)))]
        pub fn filename(&self) -> PyResult<&str> {
            unsafe { self.str_from_ptr(ffi::PyModule_GetFilename(self.as_ptr())) }
        }

        /// Calls a function in the module.
        ///
        /// This is equivalent to the Python expression `module.name(*args, **kwargs)`.
        pub fn call(
            &self,
            name: &str,
            args: impl IntoPy<Py<PyTuple>>,
            kwargs: Option<&PyDict>,
        ) -> PyResult<&PyAny> {
            self.getattr(name)?.call(args, kwargs)
        }

        /// Calls a function in the module with only positional arguments.
        ///
        /// This is equivalent to the Python expression `module.name(*args)`.
        pub fn call1(&self, name: &str, args: impl IntoPy<Py<PyTuple>>) -> PyResult<&PyAny> {
            self.getattr(name)?.call1(args)
        }

        /// Calls a function in the module without arguments.
        ///
        /// This is equivalent to the Python expression `module.name()`.
        pub fn call0(&self, name: &str) -> PyResult<&PyAny> {
            self.getattr(name)?.call0()
        }

        /// Gets a member from the module.
        ///
        /// This is equivalent to the Python expression `module.name`.
        pub fn get(&self, name: &str) -> PyResult<&PyAny> {
            self.getattr(name)
        }

        /// Adds a member to the module.
        ///
        /// This is a convenience function which can be used from the module's initialization function.
        pub fn add<V>(&self, name: &str, value: V) -> PyResult<()>
        where
            V: IntoPy<PyObject>,
        {
            self.index()?
                .append(name)
                .expect("could not append __name__ to __all__");
            self.setattr(name, value.into_py(self.py()))
        }

        /// Adds a new extension type to the module.
        ///
        /// This is a convenience function that initializes the `class`,
        /// sets `new_type.__module__` to this module's name,
        /// and adds the type to this module.
        pub fn add_class<T>(&self) -> PyResult<()>
        where
            T: PyClass,
        {
            self.add(T::NAME, <T as PyTypeObject>::type_object(self.py()))
        }

        /// Adds a function or a (sub)module to a module, using the functions __name__ as name.
        ///
        /// Use this together with the`#[pyfunction]` and [wrap_pyfunction!] or `#[pymodule]` and
        /// [wrap_pymodule!].
        ///
        /// ```rust
        /// use pyo3::prelude::*;
        /// #[pymodule]
        /// fn utils(_py: Python, _module: &PyModule) -> PyResult<()> {
        ///     Ok(())
        /// }
        ///
        /// #[pyfunction]
        /// fn double(x: usize) -> usize {
        ///     x * 2
        /// }
        /// #[pymodule]
        /// fn top_level(_py: Python, module: &PyModule) -> PyResult<()> {
        ///     module.add_wrapped(pyo3::wrap_pymodule!(utils))?;
        ///     module.add_wrapped(pyo3::wrap_pyfunction!(double))
        /// }
        /// ```
        ///
        /// You can also add a function with a custom name using [add](PyModule::add):
        ///
        /// ```rust,ignore
        /// m.add("also_double", wrap_pyfunction!(double)(m)?)?;
        /// ```
        ///
        /// **This function will be deprecated in the next release. Please use the specific
        /// [PyModule::add_function] and [PyModule::add_submodule] functions instead.**
        pub fn add_wrapped<'a, T>(&'a self, wrapper: &impl Fn(Python<'a>) -> T) -> PyResult<()>
        where
            T: IntoPyCallbackOutput<PyObject>,
        {
            let py = self.py();
            let function = wrapper(py).convert(py)?;
            let name = function.getattr(py, "__name__")?;
            let name = name.extract(py)?;
            self.add(name, function)
        }

        /// Add a submodule to a module.
        ///
        /// Use this together with `#[pymodule]` and [wrap_pymodule!].
        ///
        /// ```rust
        /// use pyo3::prelude::*;
        ///
        /// fn init_utils(module: &PyModule) -> PyResult<()> {
        ///     module.add("super_useful_constant", "important")
        /// }
        /// #[pymodule]
        /// fn top_level(py: Python, module: &PyModule) -> PyResult<()> {
        ///     let utils = PyModule::new(py, "utils")?;
        ///     init_utils(utils)?;
        ///     module.add_submodule(utils)
        /// }
        /// ```
        pub fn add_submodule(&self, module: &PyModule) -> PyResult<()> {
            let name = module.name()?;
            self.add(name, module)
        }

        /// Add a function to a module.
        ///
        /// Use this together with the`#[pyfunction]` and [wrap_pyfunction!].
        ///
        /// ```rust
        /// use pyo3::prelude::*;
        /// #[pyfunction]
        /// fn double(x: usize) -> usize {
        ///     x * 2
        /// }
        /// #[pymodule]
        /// fn double_mod(_py: Python, module: &PyModule) -> PyResult<()> {
        ///     module.add_function(pyo3::wrap_pyfunction!(double, module)?)
        /// }
        /// ```
        ///
        /// You can also add a function with a custom name using [add](PyModule::add):
        ///
        /// ```rust
        /// use pyo3::prelude::*;
        /// #[pyfunction]
        /// fn double(x: usize) -> usize {
        ///     x * 2
        /// }
        /// #[pymodule]
        /// fn double_mod(_py: Python, module: &PyModule) -> PyResult<()> {
        ///     module.add("also_double", pyo3::wrap_pyfunction!(double, module)?)
        /// }
        /// ```
        pub fn add_function<'a>(&'a self, fun: &'a PyCFunction) -> PyResult<()> {
            let name = fun.getattr("__name__")?.extract()?;
            self.add(name, fun)
        }
    }