Module prelude 

Available on crate feature tls 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::*;

Macros

wrap_pyfunction

Wraps a Rust function annotated with #[pyfunction].

Structs

Borrowed

A borrowed equivalent to Bound.

Bound

A Python thread-attached equivalent to Py<T>.

Py

A 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.

FromPyObjectOwned

A data structure that can be extracted without borrowing any data from the input.

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.

Type Aliases

PyResult

Represents the result of a Python call.

Attribute Macros

pyclass

pyfunction

A proc macro used to expose Rust functions to Python.

pymethods

A proc macro used to expose methods to Python.

pymodule

A proc macro used to implement Python modules.

Derive Macros

FromPyObject

IntoPyObject

IntoPyObjectRef