Module prelude

Available on crate features dep_pyo3 and std only.

PyO3’s prelude.

The purpose of this module is to alleviate imports of many commonly used items of the PyO3 crate by adding a glob import to the top of pyo3 heavy modules:

use pyo3::prelude::*;

Structs

• Borrowed
  A borrowed equivalent to Bound.
• Bound
  A GIL-attached equivalent to Py<T>.
• Py
  A GIL-independent reference to an object allocated on the Python heap.
• PyAny
  Represents any Python object.
• PyClassInitializer
  Initializer for our #[pyclass] system.
• PyErr
  Represents a Python exception.
• PyModule
  Represents a Python module object.
• PyRef
  A wrapper type for an immutably borrowed value from a [Bound<'py, T>].
• PyRefMut
  A wrapper type for a mutably borrowed value from a [Bound<'py, T>].
• Python
  A marker token that represents holding the GIL.

Traits

• FromPyObject
  Extract a type from a Python object.
• IntoPyDeprecated
  Defines a conversion from a Rust type to a Python object.
• IntoPyObject
  Defines a conversion from a Rust type to a Python object, which may fail.
• PyAnyMethods
  This trait represents the Python APIs which are usable on all Python objects.
• PyBoolMethods
  Implementation of functionality for PyBool.
• PyByteArrayMethods
  Implementation of functionality for PyByteArray.
• PyBytesMethods
  Implementation of functionality for PyBytes.
• PyCapsuleMethods
  Implementation of functionality for PyCapsule.
• PyComplexMethods
  Implementation of functionality for PyComplex.
• PyDictMethods
  Implementation of functionality for PyDict.
• PyFloatMethods
  Implementation of functionality for PyFloat.
• PyFrozenSetMethods
  Implementation of functionality for PyFrozenSet.
• PyListMethods
  Implementation of functionality for PyList.
• PyMappingMethods
  Implementation of functionality for PyMapping.
• PyMappingProxyMethods
  Implementation of functionality for PyMappingProxy.
• PyModuleMethods
  Implementation of functionality for PyModule.
• PySequenceMethods
  Implementation of functionality for PySequence.
• PySetMethods
  Implementation of functionality for PySet.
• PySliceMethods
  Implementation of functionality for PySlice.
• PyStringMethods
  Implementation of functionality for PyString.
• PyTracebackMethods
  Implementation of functionality for PyTraceback.
• PyTupleMethods
  Implementation of functionality for PyTuple.
• PyTypeMethods
  Implementation of functionality for PyType.
• PyWeakrefMethods
  Implementation of functionality for PyWeakref.
• ToPyObjectDeprecated
  Conversion trait that allows various objects to be converted into PyObject.

Type Aliases

• PyObject
  A commonly-used alias for Py<PyAny>.
• PyResult
  Represents the result of a Python call.