Struct pyo3::types::PyModule

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

Represents a Python module object.

Methods

impl PyModule

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

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

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

Import the Python module with the specified name.

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

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 dict(&self) -> &PyDict

Return the dictionary object that implements module's namespace; this object is the same as the __dict__ attribute of the module object.

pub fn name(&self) -> PyResult<&str>

Gets the module name.

May fail if the module does not have a __name__ attribute.

pub fn filename(&self) -> PyResult<&str>

Gets the module filename.

May fail if the module does not have a __file__ attribute.

pub fn call(
    &self,
    name: &str,
    args: impl IntoPy<Py<PyTuple>>,
    kwargs: Option<&PyDict>
) -> PyResult<&PyObjectRef>

Calls a function in the module. This is equivalent to the Python expression: getattr(module, name)(*args, **kwargs)

pub fn call0(&self, name: &str) -> PyResult<&PyObjectRef>

Calls a function in the module. This is equivalent to the Python expression: getattr(module, name)()

pub fn call1<A>(&self, name: &str, args: A) -> PyResult<&PyObjectRef> where
    A: IntoPy<Py<PyTuple>>, 

Calls a function in the module. This is equivalent to the Python expression: getattr(module, name)(*args)

pub fn get(&self, name: &str) -> PyResult<&PyObjectRef>

Gets a member from the module. This is equivalent to the Python expression: getattr(module, name)

pub fn add<V>(&self, name: &str, value: V) -> PyResult<()> where
    V: ToPyObject, 

Adds a member to the module.

This is a convenience function which can be used from the module's initialization function.

pub fn add_class<T>(&self) -> PyResult<()> where
    T: PyTypeCreate, 

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_wrapped(&self, wrapper: &dyn Fn(Python) -> PyObject) -> PyResult<()>

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!.

m.add_wrapped(wrap_pyfunction!(double));
m.add_wrapped(wrap_pymodule!(utils));

You can also add a function with a custom name using add:

m.add("also_double", wrap_pyfunction!(double)(py));

Trait Implementations

impl ToPyObject for PyModule

fn to_object(&self, py: Python) -> PyObject

Converts self into a Python object.

impl PyObjectWithGIL for PyModule

fn py(&self) -> Python

impl ToPyPointer for PyModule

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl PyTypeInfo for PyModule

type Type = ()

Type of objects to store in PyObject struct

type BaseType = PyObjectRef

Base class

const NAME: &'static str

Class name

const SIZE: usize

Size of the rust PyObject structure (PyObject + rust structure)

const OFFSET: isize

Type instance offset inside PyObject structure

unsafe fn type_object() -> &'static mut PyTypeObject

PyTypeObject instance for this type, which might still need to be initialized

fn is_instance(ptr: &PyObjectRef) -> bool

Check if *mut ffi::PyObject is instance of this type

const DESCRIPTION: &'static str

Class doc string

const FLAGS: usize

Type flags (ie PY_TYPE_FLAG_GC, PY_TYPE_FLAG_WEAKREF)

fn is_exact_instance(object: &PyObjectRef) -> bool

Check if *mut ffi::PyObject is exact instance of this type

impl PyObjectAlloc for PyModule

unsafe fn alloc(_py: Python) -> *mut PyObject

unsafe fn dealloc(py: Python, obj: *mut PyObject)

Calls the rust destructor for the object and frees the memory (usually by calling ptr->ob_type->tp_free). This function is used as tp_dealloc implementation.

unsafe fn drop(py: Python, obj: *mut PyObject)

Calls the rust destructor for the object.

impl PyTypeObject for PyModule

fn init_type() -> NonNull<PyTypeObject>

This function must make sure that the corresponding type object gets initialized exactly once and return it.

fn type_object() -> Py<PyType>

Returns the safe abstraction over the type object from PyTypeObject::init_type

impl<'a> From<&'a PyModule> for &'a PyObjectRef

fn from(ob: &'a PyModule) -> Self

Performs the conversion.

impl PartialEq<PyModule> for PyModule

fn eq(&self, o: &PyModule) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl AsRef<PyObjectRef> for PyModule

fn as_ref(&self) -> &PyObjectRef

Performs the conversion.

impl Display for PyModule

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl Debug for PyModule

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.