Struct cpython::PyType

pub struct PyType(_);

Represents a reference to a Python type object.

Implementations

impl PyType

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

Retrieves the underlying FFI pointer associated with this Python object.

pub unsafe fn from_type_ptr(py: Python<'_>, p: *mut PyTypeObject) -> PyType

Retrieves the PyType instance for the given FFI pointer. This increments the reference count on the type object. Undefined behavior if the pointer is NULL or invalid.

pub fn name<'a>(&'a self, _py: Python<'a>) -> Cow<'a, str>

Gets the name of the PyType.

pub fn is_subtype_of(&self, _: Python<'_>, b: &PyType) -> bool

Return true if self is a subtype of b.

pub fn is_instance(&self, _: Python<'_>, obj: &PyObject) -> bool

Return true if obj is an instance of self.

pub fn call<A>(
    &self,
    py: Python<'_>,
    args: A,
    kwargs: Option<&PyDict>
) -> PyResult<PyObject>where
    A: ToPyObject<ObjectType = PyTuple>,

Calls the type object, thus creating a new instance. This is equivalent to the Python expression: self(*args, **kwargs)

Trait Implementations

impl<'s> FromPyObject<'s> for &'s PyType

fn extract(py: Python<'_>, obj: &'s PyObject) -> PyResult<&'s PyType>

Extracts Self from the source PyObject.

impl<'s> FromPyObject<'s> for PyType

fn extract(py: Python<'_>, obj: &'s PyObject) -> PyResult<PyType>

Extracts Self from the source PyObject.

impl PartialEq<PyType> for PyType

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PythonObject for PyType

unsafe fn unchecked_downcast_from(obj: PyObject) -> Self

Unchecked downcast from PyObject to Self. Undefined behavior if the input object does not have the expected type.

unsafe fn unchecked_downcast_borrow_from<'a>(obj: &'a PyObject) -> &'a Self

Unchecked downcast from PyObject to Self. Undefined behavior if the input object does not have the expected type.

fn as_object(&self) -> &PyObject

Casts the Python object to PyObject.

fn into_object(self) -> PyObject

Casts the Python object to PyObject.

impl PythonObjectWithCheckedDowncast for PyType

fn downcast_from<'p>(
    py: Python<'p>,
    obj: PyObject
) -> Result<PyType, PythonObjectDowncastError<'p>>

Cast from PyObject to a concrete Python object type.

fn downcast_borrow_from<'a, 'p>(
    py: Python<'p>,
    obj: &'a PyObject
) -> Result<&'a PyType, PythonObjectDowncastError<'p>>

Cast from PyObject to a concrete Python object type.

impl PythonObjectWithTypeObject for PyType

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

Retrieves the type object for this Python object type.

impl ToPyObject for PyType

Identity conversion: allows using existing PyObject instances where T: ToPyObject is expected.

type ObjectType = PyType

fn to_py_object(&self, py: Python<'_>) -> PyType

Converts self into a Python object.

fn into_py_object(self, _py: Python<'_>) -> PyType

Converts self into a Python object.

fn with_borrowed_ptr<F, R>(&self, _py: Python<'_>, f: F) -> Rwhere
    F: FnOnce(*mut PyObject) -> R,

Converts self into a Python object and calls the specified closure on the native FFI pointer underlying the Python object.

impl Eq for PyType