Struct pyo3::types::module::PyModule

#[repr(transparent)]
pub struct PyModule(PyAny);

Represents a Python module object.

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.

Tuple Fields

0: PyAny

Implementations

impl PyModule

#[doc(hidden)] pub const _PYO3_DEF: AddTypeToModule<Self> = _

impl PyModule

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()?.to_cow()?, "my_module");
    Ok(())
})?;

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

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(())

Methods from Deref<Target = PyAny>

#[doc(hidden)] pub const _PYO3_DEF: AddTypeToModule<Self> = _

Trait Implementations

impl AsPyPointer for PyModule

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl AsRef<PyAny> for PyModule

fn as_ref(&self) -> &PyAny

Converts this type into a shared reference of the (usually inferred) input type.

impl Deref for PyModule

type Target = PyAny

The resulting type after dereferencing.

fn deref(&self) -> &PyAny

Dereferences the value.

impl PyTypeInfo for PyModule

const NAME: &'static str = "PyModule"

Available on non-crate feature gil-refs only.

Class name.

const MODULE: Option<&'static str> = _

Available on non-crate feature gil-refs only.

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Available on non-crate feature gil-refs only.

Returns the PyTypeObject instance for this type.

fn is_type_of_bound(obj: &Bound<'_, PyAny>) -> bool

Available on non-crate feature gil-refs only.

Checks if object is an instance of this type or a subclass of this type.

fn type_object_bound(py: Python<'_>) -> Bound<'_, PyType>

Available on non-crate feature gil-refs only.

Returns the safe abstraction over the type object.

fn is_exact_type_of_bound(object: &Bound<'_, PyAny>) -> bool

Available on non-crate feature gil-refs only.

Checks if object is an instance of this type.

impl DerefToPyAny for PyModule