pyo3/conversions/
serde.rs

1#![cfg(feature = "serde")]
2
3//! Enables (de)serialization of [`Py`]`<T>` objects via [serde](https://docs.rs/serde).
4//!
5//! # Setup
6//!
7//! To use this feature, add this to your **`Cargo.toml`**:
8//!
9//! ```toml
10//! [dependencies]
11#![doc = concat!("pyo3 = { version = \"", env!("CARGO_PKG_VERSION"),  "\", features = [\"serde\"] }")]
12//! serde = "1.0"
13//! ```
14
15use crate::{Py, PyAny, PyClass, Python};
16use serde::{de, ser, Deserialize, Deserializer, Serialize, Serializer};
17
18impl<T> Serialize for Py<T>
19where
20    T: Serialize + PyClass,
21{
22    fn serialize<S>(&self, serializer: S) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
23    where
24        S: Serializer,
25    {
26        Python::with_gil(|py| {
27            self.try_borrow(py)
28                .map_err(|e| ser::Error::custom(e.to_string()))?
29                .serialize(serializer)
30        })
31    }
32}
33
34impl<'de, T> Deserialize<'de> for Py<T>
35where
36    T: PyClass<BaseType = PyAny> + Deserialize<'de>,
37{
38    fn deserialize<D>(deserializer: D) -> Result<Py<T>, D::Error>
39    where
40        D: Deserializer<'de>,
41    {
42        let deserialized = T::deserialize(deserializer)?;
43
44        Python::with_gil(|py| {
45            Py::new(py, deserialized).map_err(|e| de::Error::custom(e.to_string()))
46        })
47    }
48}
⚠️ Internal Docs ⚠️ Not Public API 👉 Official Docs Here