pyo3/
prelude.rs

1//! PyO3's prelude.
2//!
3//! The purpose of this module is to alleviate imports of many commonly used items of the PyO3 crate
4//! by adding a glob import to the top of pyo3 heavy modules:
5//!
6//! ```
7//! # #![allow(unused_imports)]
8//! use pyo3::prelude::*;
9//! ```
10
11pub use crate::conversion::{FromPyObject, IntoPyObject};
12#[allow(deprecated)]
13pub use crate::conversion::{IntoPy, ToPyObject};
14pub use crate::err::{PyErr, PyResult};
15pub use crate::instance::{Borrowed, Bound, Py, PyObject};
16pub use crate::marker::Python;
17pub use crate::pycell::{PyRef, PyRefMut};
18pub use crate::pyclass_init::PyClassInitializer;
19pub use crate::types::{PyAny, PyModule};
20
21#[cfg(feature = "macros")]
22pub use pyo3_macros::{
23    pyclass, pyfunction, pymethods, pymodule, FromPyObject, IntoPyObject, IntoPyObjectRef,
24};
25
26#[cfg(feature = "macros")]
27pub use crate::wrap_pyfunction;
28#[cfg(feature = "macros")]
29#[allow(deprecated)]
30pub use crate::wrap_pyfunction_bound;
31
32pub use crate::types::any::PyAnyMethods;
33pub use crate::types::boolobject::PyBoolMethods;
34pub use crate::types::bytearray::PyByteArrayMethods;
35pub use crate::types::bytes::PyBytesMethods;
36pub use crate::types::capsule::PyCapsuleMethods;
37pub use crate::types::complex::PyComplexMethods;
38pub use crate::types::dict::PyDictMethods;
39pub use crate::types::float::PyFloatMethods;
40pub use crate::types::frozenset::PyFrozenSetMethods;
41pub use crate::types::list::PyListMethods;
42pub use crate::types::mapping::PyMappingMethods;
43pub use crate::types::mappingproxy::PyMappingProxyMethods;
44pub use crate::types::module::PyModuleMethods;
45pub use crate::types::sequence::PySequenceMethods;
46pub use crate::types::set::PySetMethods;
47pub use crate::types::slice::PySliceMethods;
48pub use crate::types::string::PyStringMethods;
49pub use crate::types::traceback::PyTracebackMethods;
50pub use crate::types::tuple::PyTupleMethods;
51pub use crate::types::typeobject::PyTypeMethods;
52pub use crate::types::weakref::PyWeakrefMethods;
⚠️ Internal Docs ⚠️ Not Public API 👉 Official Docs Here