Struct PyModule

Source

pub struct PyModule(/* private fields */);

Expand description

Represents a Python module object.

Values of this type are accessed via PyO3’s smart pointers, e.g. as Py<PyModule> or Bound<'py, PyModule>.

For APIs available on module objects, see the PyModuleMethods trait which is implemented for Bound<'py, PyModule>.

As with all other Python objects, modules are first class citizens. This means they can be passed to or returned from functions, created dynamically, assigned to variables and so forth.

Implementations§

Source §

impl PyModule

Source

pub fn new_bound<'py>( py: Python<'py>, name: &str, ) -> PyResult<Bound<'py, PyModule>>

Creates a new module object with the __name__ attribute set to name.

§Examples

use pyo3::prelude::*;

Python::with_gil(|py| -> PyResult<()> {
    let module = PyModule::new_bound(py, "my_module")?;

    assert_eq!(module.name()?, "my_module");
    Ok(())
})?;

Source

pub fn import_bound<N>(py: Python<'_>, name: N) -> PyResult<Bound<'_, PyModule>>
where N: IntoPy<Py<PyString>>,

Imports the Python module with the specified name.

§Examples

use pyo3::prelude::*;

Python::with_gil(|py| {
    let module = PyModule::import_bound(py, "antigravity").expect("No flying for you.");
});

This is equivalent to the following Python expression:

import antigravity

Source

pub fn from_code_bound<'py>( py: Python<'py>, code: &str, file_name: &str, module_name: &str, ) -> PyResult<Bound<'py, PyModule>>

Creates and loads a module named module_name, containing the Python code passed to code and pretending to live at file_name.

Warning: This will compile and execute code. Never pass untrusted code to this function!

§Errors

Returns PyErr if:

code is not syntactically correct Python.
Any Python exceptions are raised while initializing the module.
Any of the arguments cannot be converted to CStrings.

§Example: bundle in a file at compile time with `include_str!`:

use pyo3::prelude::*;

// This path is resolved relative to this file.
let code = include_str!("../../assets/script.py");

Python::with_gil(|py| -> PyResult<()> {
    PyModule::from_code_bound(py, code, "example.py", "example")?;
    Ok(())
})?;

§Example: Load a file at runtime with `std::fs::read_to_string`.

use pyo3::prelude::*;

// This path is resolved by however the platform resolves paths,
// which also makes this less portable. Consider using `include_str`
// if you just want to bundle a script with your module.
let code = std::fs::read_to_string("assets/script.py")?;

Python::with_gil(|py| -> PyResult<()> {
    PyModule::from_code_bound(py, &code, "example.py", "example")?;
    Ok(())
})?;
Ok(())