Struct pyo3::types::PyModule

source ·
pub struct PyModule(/* private fields */);
Expand description

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.

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

Trait Implementations§

source§

impl AsPyPointer for PyModule

source§

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

source§

impl AsRef<PyAny> for PyModule

source§

fn as_ref(&self) -> &PyAny

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

impl Deref for PyModule

§

type Target = PyAny

The resulting type after dereferencing.
source§

fn deref(&self) -> &PyAny

Dereferences the value.
source§

impl PyTypeInfo for PyModule

source§

const NAME: &'static str = "PyModule"

Class name.
source§

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

Module name, if any.
source§

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

Returns the PyTypeObject instance for this type.
source§

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

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

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

Returns the safe abstraction over the type object.
source§

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

Checks if object is an instance of this type.
source§

impl DerefToPyAny for PyModule

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> PyTypeCheck for T
where T: PyTypeInfo,

source§

const NAME: &'static str = const NAME: &'static str = <T as PyTypeInfo>::NAME;

Name of self. This is used in error messages, for example.
source§

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

Checks if object is an instance of Self, which may include a subtype. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.