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
impl PyModule
sourcepub fn new<'py>(py: Python<'py>, name: &str) -> PyResult<Bound<'py, 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(())
})?;
sourcepub fn new_bound<'py>(
py: Python<'py>,
name: &str,
) -> PyResult<Bound<'py, PyModule>>
👎Deprecated since 0.23.0: renamed to PyModule::new
pub fn new_bound<'py>( py: Python<'py>, name: &str, ) -> PyResult<Bound<'py, PyModule>>
PyModule::new
Deprecated name for PyModule::new
.
sourcepub fn import<'py, N>(
py: Python<'py>,
name: N,
) -> PyResult<Bound<'py, PyModule>>where
N: IntoPyObject<'py, Target = PyString>,
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
.
sourcepub fn import_bound<N>(py: Python<'_>, name: N) -> PyResult<Bound<'_, PyModule>>
👎Deprecated since 0.23.0: renamed to PyModule::import
pub fn import_bound<N>(py: Python<'_>, name: N) -> PyResult<Bound<'_, PyModule>>
PyModule::import
Deprecated name for PyModule::import
.
sourcepub fn from_code<'py>(
py: Python<'py>,
code: &CStr,
file_name: &CStr,
module_name: &CStr,
) -> PyResult<Bound<'py, PyModule>>
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
CString
s.
§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(())
sourcepub 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
pub fn from_code_bound<'py>( py: Python<'py>, code: &str, file_name: &str, module_name: &str, ) -> PyResult<Bound<'py, PyModule>>
PyModule::from_code
Deprecated name for PyModule::from_code
.
Trait Implementations§
source§impl PyTypeInfo for PyModule
impl PyTypeInfo for PyModule
source§fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
source§fn is_type_of_bound(obj: &Bound<'_, PyAny>) -> bool
fn is_type_of_bound(obj: &Bound<'_, PyAny>) -> bool
PyTypeInfo::is_type_of
PyTypeInfo::is_type_of
.source§fn type_object(py: Python<'_>) -> Bound<'_, PyType>
fn type_object(py: Python<'_>) -> Bound<'_, PyType>
source§fn type_object_bound(py: Python<'_>) -> Bound<'_, PyType>
fn type_object_bound(py: Python<'_>) -> Bound<'_, PyType>
PyTypeInfo::type_object
PyTypeInfo::type_object
.source§fn is_type_of(object: &Bound<'_, PyAny>) -> bool
fn is_type_of(object: &Bound<'_, PyAny>) -> bool
object
is an instance of this type or a subclass of this type.source§fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool
fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool
object
is an instance of this type.source§fn is_exact_type_of_bound(object: &Bound<'_, PyAny>) -> bool
fn is_exact_type_of_bound(object: &Bound<'_, PyAny>) -> bool
PyTypeInfo::is_exact_type_of
PyTypeInfo::is_exact_type_of
.impl DerefToPyAny for PyModule
Auto Trait Implementations§
impl !Freeze for PyModule
impl !RefUnwindSafe for PyModule
impl !Send for PyModule
impl !Sync for PyModule
impl Unpin for PyModule
impl UnwindSafe for PyModule
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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