Struct PyModule

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

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.

Tuple Fields

0: PyAny

Implementations

impl PyModule

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

impl PyModule

pub fn new<'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(py, "my_module")?;

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

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

👎Deprecated since 0.23.0: renamed to PyModule::new

Deprecated name for PyModule::new.

pub fn import<'py, N>( py: Python<'py>, name: N, ) -> PyResult<Bound<'py, PyModule>>

where N: IntoPyObject<'py, Target = PyString>,

Imports the Python module with the specified name.

Examples

use pyo3::prelude::*;

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

This is equivalent to the following Python expression:

import antigravity

If you want to import a class, you can store a reference to it with GILOnceCell::import.

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

where N: IntoPy<Py<PyString>>,

👎Deprecated since 0.23.0: renamed to PyModule::import

Deprecated name for PyModule::import.

pub fn from_code<'py>( py: Python<'py>, code: &CStr, file_name: &CStr, module_name: &CStr, ) -> 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::*;
use pyo3::ffi::c_str;

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

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

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

use pyo3::prelude::*;
use pyo3::ffi::c_str;
use std::ffi::CString;

// 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(py, CString::new(code)?.as_c_str(), c_str!("example.py"), c_str!("example"))?;
    Ok(())
})?;
Ok(())

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

👎Deprecated since 0.23.0: renamed to PyModule::from_code

Deprecated name for PyModule::from_code.

Methods from Deref<Target = PyAny>

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

Trait Implementations

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"

Class name.

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

Module name, if any.

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

Returns the PyTypeObject instance for this type.

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

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_type_of

Deprecated name for PyTypeInfo::is_type_of.

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

Returns the safe abstraction over the type object.

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

👎Deprecated since 0.23.0: renamed to PyTypeInfo::type_object

Deprecated name for PyTypeInfo::type_object.

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

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

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

Checks if object is an instance of this type.

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

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_exact_type_of

Deprecated name for PyTypeInfo::is_exact_type_of.

impl DerefToPyAny for PyModule