Struct PyModule

pub struct PyModule(/* private fields */);

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

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()?, "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(())

impl PyModule

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

👎Deprecated since 0.21.0: PyModule::new will be replaced by PyModule::new_bound in a future PyO3 version

Available on crate feature gil-refs only.

Deprecated form of PyModule::new_bound.

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

where N: IntoPy<Py<PyString>>,

👎Deprecated since 0.21.0: PyModule::import will be replaced by PyModule::import_bound in a future PyO3 version

Available on crate feature gil-refs only.

Deprecated form of PyModule::import_bound.

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

👎Deprecated since 0.21.0: PyModule::from_code will be replaced by PyModule::from_code_bound in a future PyO3 version

Available on crate feature gil-refs only.

Deprecated form of PyModule::from_code_bound.

pub fn dict(&self) -> &PyDict

Available on crate feature gil-refs only.

Returns the module’s __dict__ attribute, which contains the module’s symbol table.

pub fn index(&self) -> PyResult<&PyList>

Available on crate feature gil-refs only.

Returns the index (the __all__ attribute) of the module, creating one if needed.

__all__ declares the items that will be imported with from my_module import *.

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

Available on crate feature gil-refs only.

Returns the name (the __name__ attribute) of the module.

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

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

Available on crate feature gil-refs only.

Returns the filename (the __file__ attribute) of the module.

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

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

where V: IntoPy<PyObject>,

Available on crate feature gil-refs only.

Adds an attribute to the module.

For adding classes, functions or modules, prefer to use PyModule::add_class, PyModule::add_function or PyModule::add_submodule instead, respectively.

Examples

use pyo3::prelude::*;

#[pymodule]
fn my_module(module: &Bound<'_, PyModule>) -> PyResult<()> {
    module.add("c", 299_792_458)?;
    Ok(())
}

Python code can then do the following:

from my_module import c

print("c is", c)

This will result in the following output:

c is 299792458

pub fn add_class<T>(&self) -> PyResult<()>

where T: PyClass,

Available on crate feature gil-refs only.

Adds a new class to the module.

Notice that this method does not take an argument. Instead, this method is generic, and requires us to use the “turbofish” syntax to specify the class we want to add.

Examples

use pyo3::prelude::*;

#[pyclass]
struct Foo { /* fields omitted */ }

#[pymodule]
fn my_module(module: &Bound<'_, PyModule>) -> PyResult<()> {
    module.add_class::<Foo>()?;
    Ok(())
}

Python code can see this class as such:

from my_module import Foo

print("Foo is", Foo)

This will result in the following output:

Foo is <class 'builtins.Foo'>

Note that as we haven’t defined a constructor, Python code can’t actually make an instance of Foo (or get one for that matter, as we haven’t exported anything that can return instances of Foo).

pub fn add_wrapped<'a, T>( &'a self, wrapper: &impl Fn(Python<'a>) -> T, ) -> PyResult<()>

where T: IntoPyCallbackOutput<PyObject>,

Available on crate feature gil-refs only.

Adds a function or a (sub)module to a module, using the functions name as name.

Prefer to use PyModule::add_function and/or PyModule::add_submodule instead.

pub fn add_submodule(&self, module: &PyModule) -> PyResult<()>

Available on crate feature gil-refs only.

Adds a submodule to a module.

This is especially useful for creating module hierarchies.

Note that this doesn’t define a package, so this won’t allow Python code to directly import submodules by using from my_module import submodule. For more information, see #759 and #1517.

Examples

use pyo3::prelude::*;

#[pymodule]
fn my_module(py: Python<'_>, module: &Bound<'_, PyModule>) -> PyResult<()> {
    let submodule = PyModule::new_bound(py, "submodule")?;
    submodule.add("super_useful_constant", "important")?;

    module.add_submodule(&submodule)?;
    Ok(())
}

Python code can then do the following:

import my_module

print("super_useful_constant is", my_module.submodule.super_useful_constant)

This will result in the following output:

super_useful_constant is important

pub fn add_function<'a>(&'a self, fun: &'a PyCFunction) -> PyResult<()>

Available on crate feature gil-refs only.

Add a function to a module.

Note that this also requires the wrap_pyfunction! macro to wrap a function annotated with #[pyfunction].

use pyo3::prelude::*;

#[pyfunction]
fn say_hello() {
    println!("Hello world!")
}
#[pymodule]
fn my_module(module: &Bound<'_, PyModule>) -> PyResult<()> {
    module.add_function(wrap_pyfunction!(say_hello, module)?)
}

Python code can then do the following:

from my_module import say_hello

say_hello()

This will result in the following output:

Hello world!

Methods from Deref<Target = PyAny>

pub fn is<T: AsPyPointer>(&self, other: &T) -> bool

Available on crate feature gil-refs only.

Returns whether self and other point to the same object. To compare the equality of two objects (the == operator), use eq.

This is equivalent to the Python expression self is other.

pub fn hasattr<N>(&self, attr_name: N) -> PyResult<bool>

where N: IntoPy<Py<PyString>>,

Available on crate feature gil-refs only.

Determines whether this object has the given attribute.

This is equivalent to the Python expression hasattr(self, attr_name).

To avoid repeated temporary allocations of Python strings, the intern! macro can be used to intern attr_name.

Example: intern!ing the attribute name

#[pyfunction]
fn has_version(sys: &Bound<'_, PyModule>) -> PyResult<bool> {
    sys.hasattr(intern!(sys.py(), "version"))
}

pub fn getattr<N>(&self, attr_name: N) -> PyResult<&PyAny>

where N: IntoPy<Py<PyString>>,

Available on crate feature gil-refs only.

Retrieves an attribute value.

This is equivalent to the Python expression self.attr_name.

To avoid repeated temporary allocations of Python strings, the intern! macro can be used to intern attr_name.

Example: intern!ing the attribute name

#[pyfunction]
fn version<'py>(sys: &Bound<'py, PyModule>) -> PyResult<Bound<'py, PyAny>> {
    sys.getattr(intern!(sys.py(), "version"))
}

pub fn setattr<N, V>(&self, attr_name: N, value: V) -> PyResult<()>

where N: IntoPy<Py<PyString>>, V: ToPyObject,

Available on crate feature gil-refs only.

Sets an attribute value.

This is equivalent to the Python expression self.attr_name = value.

To avoid repeated temporary allocations of Python strings, the intern! macro can be used to intern name.

Example: intern!ing the attribute name

#[pyfunction]
fn set_answer(ob: &Bound<'_, PyAny>) -> PyResult<()> {
    ob.setattr(intern!(ob.py(), "answer"), 42)
}

pub fn delattr<N>(&self, attr_name: N) -> PyResult<()>

where N: IntoPy<Py<PyString>>,

Available on crate feature gil-refs only.

Deletes an attribute.

This is equivalent to the Python statement del self.attr_name.

To avoid repeated temporary allocations of Python strings, the intern! macro can be used to intern attr_name.

pub fn compare<O>(&self, other: O) -> PyResult<Ordering>

where O: ToPyObject,

Available on crate feature gil-refs only.

Returns an Ordering between self and other.

This is equivalent to the following Python code:

if self == other:
    return Equal
elif a < b:
    return Less
elif a > b:
    return Greater
else:
    raise TypeError("PyAny::compare(): All comparisons returned false")

Examples

use pyo3::prelude::*;
use pyo3::types::PyFloat;
use std::cmp::Ordering;

Python::with_gil(|py| -> PyResult<()> {
    let a = PyFloat::new_bound(py, 0_f64);
    let b = PyFloat::new_bound(py, 42_f64);
    assert_eq!(a.compare(b)?, Ordering::Less);
    Ok(())
})?;

It will return PyErr for values that cannot be compared:

use pyo3::prelude::*;
use pyo3::types::{PyFloat, PyString};

Python::with_gil(|py| -> PyResult<()> {
    let a = PyFloat::new_bound(py, 0_f64);
    let b = PyString::new_bound(py, "zero");
    assert!(a.compare(b).is_err());
    Ok(())
})?;

pub fn rich_compare<O>( &self, other: O, compare_op: CompareOp, ) -> PyResult<&PyAny>

where O: ToPyObject,

Available on crate feature gil-refs only.

Tests whether two Python objects obey a given CompareOp.

lt, le, eq, ne, gt and ge are the specialized versions of this function.

Depending on the value of compare_op, this is equivalent to one of the following Python expressions:

compare_op	Python expression
CompareOp::Eq	self == other
CompareOp::Ne	self != other
CompareOp::Lt	self < other
CompareOp::Le	self <= other
CompareOp::Gt	self > other
CompareOp::Ge	self >= other

Examples

use pyo3::class::basic::CompareOp;
use pyo3::prelude::*;
use pyo3::types::PyInt;

Python::with_gil(|py| -> PyResult<()> {
    let a: Bound<'_, PyInt> = 0_u8.into_py(py).into_bound(py).downcast_into()?;
    let b: Bound<'_, PyInt> = 42_u8.into_py(py).into_bound(py).downcast_into()?;
    assert!(a.rich_compare(b, CompareOp::Le)?.is_truthy()?);
    Ok(())
})?;

pub fn lt<O>(&self, other: O) -> PyResult<bool>

where O: ToPyObject,

Available on crate feature gil-refs only.

Tests whether this object is less than another.

This is equivalent to the Python expression self < other.

pub fn le<O>(&self, other: O) -> PyResult<bool>

where O: ToPyObject,

Available on crate feature gil-refs only.

Tests whether this object is less than or equal to another.

This is equivalent to the Python expression self <= other.

pub fn eq<O>(&self, other: O) -> PyResult<bool>

where O: ToPyObject,

Available on crate feature gil-refs only.

Tests whether this object is equal to another.

This is equivalent to the Python expression self == other.

pub fn ne<O>(&self, other: O) -> PyResult<bool>

where O: ToPyObject,

Available on crate feature gil-refs only.

Tests whether this object is not equal to another.

This is equivalent to the Python expression self != other.

pub fn gt<O>(&self, other: O) -> PyResult<bool>

where O: ToPyObject,

Available on crate feature gil-refs only.

Tests whether this object is greater than another.

This is equivalent to the Python expression self > other.

pub fn ge<O>(&self, other: O) -> PyResult<bool>

where O: ToPyObject,

Available on crate feature gil-refs only.

Tests whether this object is greater than or equal to another.

This is equivalent to the Python expression self >= other.

pub fn is_callable(&self) -> bool

Available on crate feature gil-refs only.

Determines whether this object appears callable.

This is equivalent to Python’s callable() function.

Examples

use pyo3::prelude::*;

Python::with_gil(|py| -> PyResult<()> {
    let builtins = PyModule::import_bound(py, "builtins")?;
    let print = builtins.getattr("print")?;
    assert!(print.is_callable());
    Ok(())
})?;

This is equivalent to the Python statement assert callable(print).

Note that unless an API needs to distinguish between callable and non-callable objects, there is no point in checking for callability. Instead, it is better to just do the call and handle potential exceptions.

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

Available on crate feature gil-refs only.

Calls the object.

This is equivalent to the Python expression self(*args, **kwargs).

Examples

use pyo3::prelude::*;
use pyo3::types::PyDict;

const CODE: &str = r#"
def function(*args, **kwargs):
    assert args == ("hello",)
    assert kwargs == {"cruel": "world"}
    return "called with args and kwargs"
"#;

Python::with_gil(|py| {
    let module = PyModule::from_code_bound(py, CODE, "", "")?;
    let fun = module.getattr("function")?;
    let args = ("hello",);
    let kwargs = PyDict::new_bound(py);
    kwargs.set_item("cruel", "world")?;
    let result = fun.call(args, Some(&kwargs))?;
    assert_eq!(result.extract::<String>()?, "called with args and kwargs");
    Ok(())
})

pub fn call0(&self) -> PyResult<&PyAny>

Available on crate feature gil-refs only.

Calls the object without arguments.

This is equivalent to the Python expression self().

Examples

use pyo3::prelude::*;

Python::with_gil(|py| -> PyResult<()> {
    let module = PyModule::import_bound(py, "builtins")?;
    let help = module.getattr("help")?;
    help.call0()?;
    Ok(())
})?;

This is equivalent to the Python expression help().

pub fn call1(&self, args: impl IntoPy<Py<PyTuple>>) -> PyResult<&PyAny>

Available on crate feature gil-refs only.

Calls the object with only positional arguments.

This is equivalent to the Python expression self(*args).

Examples

use pyo3::prelude::*;

const CODE: &str = r#"
def function(*args, **kwargs):
    assert args == ("hello",)
    assert kwargs == {}
    return "called with args"
"#;

Python::with_gil(|py| {
    let module = PyModule::from_code_bound(py, CODE, "", "")?;
    let fun = module.getattr("function")?;
    let args = ("hello",);
    let result = fun.call1(args)?;
    assert_eq!(result.extract::<String>()?, "called with args");
    Ok(())
})

pub fn call_method<N, A>( &self, name: N, args: A, kwargs: Option<&PyDict>, ) -> PyResult<&PyAny>

where N: IntoPy<Py<PyString>>, A: IntoPy<Py<PyTuple>>,

Available on crate feature gil-refs only.

Calls a method on the object.

This is equivalent to the Python expression self.name(*args, **kwargs).

To avoid repeated temporary allocations of Python strings, the intern! macro can be used to intern name.

Examples

use pyo3::prelude::*;
use pyo3::types::PyDict;

const CODE: &str = r#"
class A:
    def method(self, *args, **kwargs):
        assert args == ("hello",)
        assert kwargs == {"cruel": "world"}
        return "called with args and kwargs"
a = A()
"#;

Python::with_gil(|py| {
    let module = PyModule::from_code_bound(py, CODE, "", "")?;
    let instance = module.getattr("a")?;
    let args = ("hello",);
    let kwargs = PyDict::new_bound(py);
    kwargs.set_item("cruel", "world")?;
    let result = instance.call_method("method", args, Some(&kwargs))?;
    assert_eq!(result.extract::<String>()?, "called with args and kwargs");
    Ok(())
})

pub fn call_method0<N>(&self, name: N) -> PyResult<&PyAny>

where N: IntoPy<Py<PyString>>,

Available on crate feature gil-refs only.

Calls a method on the object without arguments.

This is equivalent to the Python expression self.name().

To avoid repeated temporary allocations of Python strings, the intern! macro can be used to intern name.

Examples

use pyo3::prelude::*;

const CODE: &str = r#"
class A:
    def method(self, *args, **kwargs):
        assert args == ()
        assert kwargs == {}
        return "called with no arguments"
a = A()
"#;

Python::with_gil(|py| {
    let module = PyModule::from_code_bound(py, CODE, "", "")?;
    let instance = module.getattr("a")?;
    let result = instance.call_method0("method")?;
    assert_eq!(result.extract::<String>()?, "called with no arguments");
    Ok(())
})

pub fn call_method1<N, A>(&self, name: N, args: A) -> PyResult<&PyAny>

where N: IntoPy<Py<PyString>>, A: IntoPy<Py<PyTuple>>,

Available on crate feature gil-refs only.

Calls a method on the object with only positional arguments.

This is equivalent to the Python expression self.name(*args).

To avoid repeated temporary allocations of Python strings, the intern! macro can be used to intern name.

Examples

use pyo3::prelude::*;

const CODE: &str = r#"
class A:
    def method(self, *args, **kwargs):
        assert args == ("hello",)
        assert kwargs == {}
        return "called with args"
a = A()
"#;

Python::with_gil(|py| {
    let module = PyModule::from_code_bound(py, CODE, "", "")?;
    let instance = module.getattr("a")?;
    let args = ("hello",);
    let result = instance.call_method1("method", args)?;
    assert_eq!(result.extract::<String>()?, "called with args");
    Ok(())
})

pub fn is_true(&self) -> PyResult<bool>

👎Deprecated since 0.21.0: use .is_truthy() instead

Available on crate feature gil-refs only.

Returns whether the object is considered to be true.

This is equivalent to the Python expression bool(self).

pub fn is_truthy(&self) -> PyResult<bool>

Available on crate feature gil-refs only.

Returns whether the object is considered to be true.

This applies truth value testing equivalent to the Python expression bool(self).

pub fn is_none(&self) -> bool

Available on crate feature gil-refs only.

Returns whether the object is considered to be None.

This is equivalent to the Python expression self is None.

pub fn is_ellipsis(&self) -> bool

👎Deprecated since 0.20.0: use .is(py.Ellipsis()) instead

Available on crate feature gil-refs only.

Returns whether the object is Ellipsis, e.g. ....

This is equivalent to the Python expression self is ....

pub fn is_empty(&self) -> PyResult<bool>

Available on crate feature gil-refs only.

Returns true if the sequence or mapping has a length of 0.

This is equivalent to the Python expression len(self) == 0.

pub fn get_item<K>(&self, key: K) -> PyResult<&PyAny>

where K: ToPyObject,

Available on crate feature gil-refs only.

Gets an item from the collection.

This is equivalent to the Python expression self[key].

pub fn set_item<K, V>(&self, key: K, value: V) -> PyResult<()>

where K: ToPyObject, V: ToPyObject,

Available on crate feature gil-refs only.

Sets a collection item value.

This is equivalent to the Python expression self[key] = value.

pub fn del_item<K>(&self, key: K) -> PyResult<()>

where K: ToPyObject,

Available on crate feature gil-refs only.

Deletes an item from the collection.

This is equivalent to the Python expression del self[key].

pub fn iter(&self) -> PyResult<&PyIterator>

Available on crate feature gil-refs only.

Takes an object and returns an iterator for it.

This is typically a new iterator but if the argument is an iterator, this returns itself.

pub fn get_type(&self) -> &PyType

Available on crate feature gil-refs only.

Returns the Python type object for this object’s type.

pub fn get_type_ptr(&self) -> *mut PyTypeObject

Available on crate feature gil-refs only.

Returns the Python type pointer for this object.

pub fn downcast<T>(&self) -> Result<&T, PyDowncastError<'_>>

where T: PyTypeCheck<AsRefTarget = T>,

Available on crate feature gil-refs only.

Downcast this PyAny to a concrete Python type or pyclass.

Note that you can often avoid downcasting yourself by just specifying the desired type in function or method signatures. However, manual downcasting is sometimes necessary.

For extracting a Rust-only type, see PyAny::extract.

Example: Downcasting to a specific Python object

use pyo3::prelude::*;
use pyo3::types::{PyDict, PyList};

Python::with_gil(|py| {
    let dict = PyDict::new_bound(py);
    assert!(dict.is_instance_of::<PyAny>());
    let any = dict.as_any();

    assert!(any.downcast::<PyDict>().is_ok());
    assert!(any.downcast::<PyList>().is_err());
});

Example: Getting a reference to a pyclass

This is useful if you want to mutate a PyObject that might actually be a pyclass.

use pyo3::prelude::*;

#[pyclass]
struct Class {
    i: i32,
}

Python::with_gil(|py| {
    let class = Py::new(py, Class { i: 0 }).unwrap().into_bound(py).into_any();

    let class_bound: &Bound<'_, Class> = class.downcast()?;

    class_bound.borrow_mut().i += 1;

    // Alternatively you can get a `PyRefMut` directly
    let class_ref: PyRefMut<'_, Class> = class.extract()?;
    assert_eq!(class_ref.i, 1);
    Ok(())
})

pub fn downcast_exact<T>(&self) -> Result<&T, PyDowncastError<'_>>

where T: PyTypeInfo<AsRefTarget = T>,

Available on crate feature gil-refs only.

Downcast this PyAny to a concrete Python type or pyclass (but not a subclass of it).

It is almost always better to use PyAny::downcast because it accounts for Python subtyping. Use this method only when you do not want to allow subtypes.

The advantage of this method over PyAny::downcast is that it is faster. The implementation of downcast_exact uses the equivalent of the Python expression type(self) is T, whereas downcast uses isinstance(self, T).

For extracting a Rust-only type, see PyAny::extract.

Example: Downcasting to a specific Python object but not a subtype

use pyo3::prelude::*;
use pyo3::types::{PyBool, PyLong};

Python::with_gil(|py| {
    let b = PyBool::new_bound(py, true);
    assert!(b.is_instance_of::<PyBool>());
    let any: &Bound<'_, PyAny> = b.as_any();

    // `bool` is a subtype of `int`, so `downcast` will accept a `bool` as an `int`
    // but `downcast_exact` will not.
    assert!(any.downcast::<PyLong>().is_ok());
    assert!(any.downcast_exact::<PyLong>().is_err());

    assert!(any.downcast_exact::<PyBool>().is_ok());
});

pub unsafe fn downcast_unchecked<T>(&self) -> &T

where T: HasPyGilRef<AsRefTarget = T>,

Available on crate feature gil-refs only.

Converts this PyAny to a concrete Python type without checking validity.

Safety

Callers must ensure that the type is valid or risk type confusion.

pub fn extract<'py, D>(&'py self) -> PyResult<D>

where D: FromPyObjectBound<'py, 'py>,

Available on crate feature gil-refs only.

Extracts some type from the Python object.

This is a wrapper function around FromPyObject::extract().

pub fn get_refcnt(&self) -> isize

Available on crate feature gil-refs only.

Returns the reference count for the Python object.

pub fn repr(&self) -> PyResult<&PyString>

Available on crate feature gil-refs only.

Computes the “repr” representation of self.

This is equivalent to the Python expression repr(self).

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

Available on crate feature gil-refs only.

Computes the “str” representation of self.

This is equivalent to the Python expression str(self).

pub fn hash(&self) -> PyResult<isize>

Available on crate feature gil-refs only.

Retrieves the hash code of self.

This is equivalent to the Python expression hash(self).

pub fn len(&self) -> PyResult<usize>

Available on crate feature gil-refs only.

Returns the length of the sequence or mapping.

This is equivalent to the Python expression len(self).

pub fn dir(&self) -> PyResult<&PyList>

Available on crate feature gil-refs only.

Returns the list of attributes of this object.

This is equivalent to the Python expression dir(self).

pub fn is_instance(&self, ty: &PyAny) -> PyResult<bool>

Available on crate feature gil-refs only.

Checks whether this object is an instance of type ty.

This is equivalent to the Python expression isinstance(self, ty).

pub fn is_exact_instance(&self, ty: &PyAny) -> bool

Available on crate feature gil-refs only.

Checks whether this object is an instance of exactly type ty (not a subclass).

This is equivalent to the Python expression type(self) is ty.

pub fn is_instance_of<T: PyTypeInfo>(&self) -> bool

Available on crate feature gil-refs only.

Checks whether this object is an instance of type T.

This is equivalent to the Python expression isinstance(self, T), if the type T is known at compile time.

pub fn is_exact_instance_of<T: PyTypeInfo>(&self) -> bool

Available on crate feature gil-refs only.

Checks whether this object is an instance of exactly type T.

This is equivalent to the Python expression type(self) is T, if the type T is known at compile time.

pub fn contains<V>(&self, value: V) -> PyResult<bool>

where V: ToPyObject,

Available on crate feature gil-refs only.

Determines if self contains value.

This is equivalent to the Python expression value in self.

pub fn py(&self) -> Python<'_>

Available on crate feature gil-refs only.

Returns a GIL marker constrained to the lifetime of this type.

pub fn as_ptr(&self) -> *mut PyObject

Available on crate feature gil-refs only.

Returns the raw FFI pointer represented by self.

Safety

Callers are responsible for ensuring that the pointer does not outlive self.

The reference is borrowed; callers should not decrease the reference count when they are finished with the pointer.

pub fn into_ptr(&self) -> *mut PyObject

Available on crate feature gil-refs only.

Returns an owned raw FFI pointer represented by self.

Safety

The reference is owned; when finished the caller should either transfer ownership of the pointer or decrease the reference count (e.g. with pyo3::ffi::Py_DecRef).

pub fn py_super(&self) -> PyResult<&PySuper>

Available on crate feature gil-refs and neither PyPy nor GraalPy only.

Return a proxy object that delegates method calls to a parent or sibling class of type.

This is equivalent to the Python expression super()

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 Debug for PyModule

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

Formats the value using the given formatter.

impl Deref for PyModule

type Target = PyAny

The resulting type after dereferencing.

fn deref(&self) -> &PyAny

Dereferences the value.

impl Display for PyModule

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

impl From<&PyModule> for Py<PyModule>

fn from(other: &PyModule) -> Self

Converts to this type from the input type.

impl<'py> FromPyObject<'py> for &'py PyModule

fn extract_bound(obj: &Bound<'py, PyAny>) -> PyResult<Self>

Extracts Self from the bound smart pointer obj.

fn extract(ob: &'py PyAny) -> PyResult<Self>

Available on crate feature gil-refs only.

Extracts Self from the source GIL Ref obj.

fn type_input() -> TypeInfo

Available on crate feature experimental-inspect only.

Extracts the type hint information for this type when it appears as an argument.

impl IntoPy<Py<PyModule>> for &PyModule

fn into_py(self, py: Python<'_>) -> Py<PyModule>

Performs the conversion.

fn type_output() -> TypeInfo

Available on crate feature experimental-inspect only.

Extracts the type hint information for this type when it appears as a return value.

impl PyNativeType for PyModule

type AsRefSource = PyModule

Available on crate feature gil-refs only.

The form of this which is stored inside a Py<T> smart pointer.

fn as_borrowed(&self) -> Borrowed<'_, '_, Self::AsRefSource>

Available on crate feature gil-refs only.

Cast &self to a Borrowed smart pointer.

fn py(&self) -> Python<'_>

Available on crate feature gil-refs only.

Returns a GIL marker constrained to the lifetime of this type.

unsafe fn unchecked_downcast(obj: &PyAny) -> &Self

Available on crate feature gil-refs only.

Cast &PyAny to &Self without no type checking.

impl PyTypeInfo for PyModule

const NAME: &'static str = "PyModule"

Available on crate feature gil-refs only.

Class name.

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

Available on crate feature gil-refs only.

Module name, if any.

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

Available on crate feature gil-refs only.

Returns the PyTypeObject instance for this type.

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

Available on crate feature gil-refs only.

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

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

👎Deprecated since 0.21.0: PyTypeInfo::type_object will be replaced by PyTypeInfo::type_object_bound in a future PyO3 version

Available on crate feature gil-refs only.

Returns the safe abstraction over the type object.

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

Available on crate feature gil-refs only.

Returns the safe abstraction over the type object.

fn is_type_of(object: &PyAny) -> bool

👎Deprecated since 0.21.0: PyTypeInfo::is_type_of will be replaced by PyTypeInfo::is_type_of_bound in a future PyO3 version

Available on crate feature gil-refs only.

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

fn is_exact_type_of(object: &PyAny) -> bool

👎Deprecated since 0.21.0: PyTypeInfo::is_exact_type_of will be replaced by PyTypeInfo::is_exact_type_of_bound in a future PyO3 version

Available on crate feature gil-refs only.

Checks if object is an instance of this type.

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

Available on crate feature gil-refs only.

Checks if object is an instance of this type.

impl ToPyObject for PyModule

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

Converts self into a Python object.

impl DerefToPyAny for PyModule