Skip to main content

PyTypeInfo

pyo3::type_object

Trait PyTypeInfo

pub unsafe trait PyTypeInfo: Sized {
    const TYPE_HINT: PyStaticExpr = _;

    // Required method
    fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject;

    // Provided methods
    fn type_object(py: Python<'_>) -> Bound<'_, PyType> { ... }
    fn is_type_of(object: &Bound<'_, PyAny>) -> bool { ... }
    fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool { ... }
}

Expand description

Python type information. All Python native types (e.g., PyDict) and #[pyclass] structs implement this trait.

This trait is marked unsafe because:

specifying the incorrect layout can lead to memory errors
the return value of type_object must always point to the same PyTypeObject instance

It is safely implemented by the pyclass macro.

§Safety

Implementations must provide an implementation for type_object_raw which infallibly produces a non-null pointer to the corresponding Python type object.

is_type_of must only return true for objects which can safely be treated as instances of Self.

is_exact_type_of must only return true for objects whose type is exactly Self.

Provided Associated Constants§

const TYPE_HINT: PyStaticExpr = _

Available on crate feature experimental-inspect only.

Provides the full python type as a type hint.

Required Methods§

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

Returns the PyTypeObject instance for this type.

Provided Methods§

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

Returns the safe abstraction over the type object.

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

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

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

Checks if object is an instance of this type.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors§

impl PyTypeInfo for CancelledError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for Coroutine

Available on crate feature experimental-async only.

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for IncompleteReadError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for InvalidStateError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for LimitOverrunError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PanicException

Available on wip_feature_std only.

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyAny

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyArithmeticError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyAssertionError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyAttributeError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyBaseException

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyBaseExceptionGroup

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyBlockingIOError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyBool

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyBrokenPipeError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyBufferError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyByteArray

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyBytes

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyBytesWarning

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyCFunction

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyCapsule

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyChildProcessError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyCode

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyComplex

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyConnectionAbortedError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyConnectionError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyConnectionRefusedError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyConnectionResetError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyContext

Available on neither GraalPy nor Py_LIMITED_API nor PyPy nor RustPython.

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyDate

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyDateTime

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyDelta

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyDeprecationWarning

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyDict

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyDictItems

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyDictKeys

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyDictValues

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyEOFError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyEllipsis

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyEncodingWarning

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyException

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyFileExistsError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyFileNotFoundError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyFloat

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyFloatingPointError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyFrame

Available on non-GraalPy and non-Py_LIMITED_API and non-PyPy only.

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyFrozenSet

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyFunction

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyFutureWarning

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyGeneratorExit

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyGenericAlias

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyImportError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyImportWarning

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyIndexError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyInt

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyInterruptedError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyIsADirectoryError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyIterator

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyKeyError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyKeyboardInterrupt

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyList

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyLookupError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyMapping

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyMappingProxy

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyMemoryError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyMemoryView

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyModule

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyModuleNotFoundError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyNameError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyNone

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyNotADirectoryError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyNotImplemented

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyNotImplementedError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyOSError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyOverflowError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyPendingDeprecationWarning

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyPermissionError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyProcessLookupError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyRange

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyRecursionError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyReferenceError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyResourceWarning

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyRuntimeError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyRuntimeWarning

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PySequence

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PySet

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PySlice

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyStopAsyncIteration

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyStopIteration

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyString

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PySuper

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PySyntaxError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PySyntaxWarning

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PySystemError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PySystemExit

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyTime

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyTimeoutError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyTraceback

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyTuple

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyType

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyTypeError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyTzInfo

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyUnboundLocalError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyUnicodeDecodeError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyUnicodeEncodeError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyUnicodeError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyUnicodeTranslateError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyUnicodeWarning

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyUserWarning

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyValueError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyWarning

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyWeakrefReference

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for PyZeroDivisionError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for QueueEmpty

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for QueueFull

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for TimeoutError

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for gaierror

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for herror

const TYPE_HINT: PyStaticExpr

impl PyTypeInfo for timeout

const TYPE_HINT: PyStaticExpr