pythonize 0.28.0

Serde Serializer & Deserializer from Rust <--> Python, backed by PyO3.
Documentation
use std::collections::HashMap;

use pyo3::{
    exceptions::{PyIndexError, PyKeyError},
    prelude::*,
    types::{PyDict, PyMapping, PySequence, PyTuple},
    IntoPyObjectExt,
};
use pythonize::{
    depythonize, pythonize_custom, PythonizeListType, PythonizeMappingType,
    PythonizeNamedMappingType, PythonizeTypes, PythonizeUnnamedMappingAdapter, Pythonizer,
};
use serde::Serialize;
use serde_json::{json, Value};

#[pyclass(sequence)]
struct CustomList {
    items: Vec<Py<PyAny>>,
}

#[pymethods]
impl CustomList {
    fn __len__(&self) -> usize {
        self.items.len()
    }

    fn __getitem__(&self, idx: isize) -> PyResult<Py<PyAny>> {
        self.items
            .get(idx as usize)
            .cloned()
            .ok_or_else(|| PyIndexError::new_err(idx))
    }
}

impl PythonizeListType for CustomList {
    fn create_sequence<'py, T, U>(
        py: Python<'py>,
        elements: impl IntoIterator<Item = T, IntoIter = U>,
    ) -> PyResult<Bound<'py, PySequence>>
    where
        T: IntoPyObject<'py>,
        U: ExactSizeIterator<Item = T>,
    {
        let sequence = Bound::new(
            py,
            CustomList {
                items: elements
                    .into_iter()
                    .map(|item| item.into_py_any(py))
                    .collect::<PyResult<_>>()?,
            },
        )?;

        Ok(unsafe { sequence.cast_into_unchecked() })
    }
}

struct PythonizeCustomList;
impl<'py> PythonizeTypes for PythonizeCustomList {
    type Map = PyDict;
    type NamedMap = PythonizeUnnamedMappingAdapter<PyDict>;
    type List = CustomList;
}

#[test]
fn test_custom_list() {
    Python::attach(|py| {
        PySequence::register::<CustomList>(py).unwrap();
        let serialized = pythonize_custom::<PythonizeCustomList, _>(py, &json!([1, 2, 3])).unwrap();
        assert!(serialized.is_instance_of::<CustomList>());

        let deserialized: Value = depythonize(&serialized).unwrap();
        assert_eq!(deserialized, json!([1, 2, 3]));
    })
}

#[pyclass(mapping)]
struct CustomDict {
    items: HashMap<String, Py<PyAny>>,
}

#[pymethods]
impl CustomDict {
    fn __len__(&self) -> usize {
        self.items.len()
    }

    fn __getitem__(&self, key: String) -> PyResult<Py<PyAny>> {
        self.items
            .get(&key)
            .cloned()
            .ok_or_else(|| PyKeyError::new_err(key))
    }

    fn __setitem__(&mut self, key: String, value: Py<PyAny>) {
        self.items.insert(key, value);
    }

    fn keys(&self) -> Vec<&String> {
        self.items.keys().collect()
    }

    fn values(&self) -> Vec<Py<PyAny>> {
        self.items.values().cloned().collect()
    }
}

impl PythonizeMappingType for CustomDict {
    type Builder<'py> = Bound<'py, CustomDict>;

    fn builder<'py>(py: Python<'py>, len: Option<usize>) -> PyResult<Self::Builder<'py>> {
        Bound::new(
            py,
            CustomDict {
                items: HashMap::with_capacity(len.unwrap_or(0)),
            },
        )
    }

    fn push_item<'py>(
        builder: &mut Self::Builder<'py>,
        key: Bound<'py, PyAny>,
        value: Bound<'py, PyAny>,
    ) -> PyResult<()> {
        unsafe { builder.cast_unchecked::<PyMapping>() }.set_item(key, value)
    }

    fn finish<'py>(builder: Self::Builder<'py>) -> PyResult<Bound<'py, PyMapping>> {
        Ok(unsafe { builder.cast_into_unchecked() })
    }
}

struct PythonizeCustomDict;
impl<'py> PythonizeTypes for PythonizeCustomDict {
    type Map = CustomDict;
    type NamedMap = PythonizeUnnamedMappingAdapter<CustomDict>;
    type List = PyTuple;
}

#[test]
fn test_custom_dict() {
    Python::attach(|py| {
        PyMapping::register::<CustomDict>(py).unwrap();
        let serialized =
            pythonize_custom::<PythonizeCustomDict, _>(py, &json!({ "hello": 1, "world": 2 }))
                .unwrap();
        assert!(serialized.is_instance_of::<CustomDict>());

        let deserialized: Value = depythonize(&serialized).unwrap();
        assert_eq!(deserialized, json!({ "hello": 1, "world": 2 }));
    })
}

#[test]
fn test_tuple() {
    Python::attach(|py| {
        PyMapping::register::<CustomDict>(py).unwrap();
        let serialized =
            pythonize_custom::<PythonizeCustomDict, _>(py, &json!([1, 2, 3, 4])).unwrap();
        assert!(serialized.is_instance_of::<PyTuple>());

        let deserialized: Value = depythonize(&serialized).unwrap();
        assert_eq!(deserialized, json!([1, 2, 3, 4]));
    })
}

#[test]
fn test_pythonizer_can_be_created() {
    // https://github.com/davidhewitt/pythonize/pull/56
    Python::attach(|py| {
        let sample = json!({ "hello": 1, "world": 2 });
        assert!(sample
            .serialize(Pythonizer::new(py))
            .unwrap()
            .is_instance_of::<PyDict>());

        assert!(sample
            .serialize(Pythonizer::custom::<PythonizeCustomDict>(py))
            .unwrap()
            .is_instance_of::<CustomDict>());
    })
}

#[pyclass(mapping)]
struct NamedCustomDict {
    name: String,
    items: HashMap<String, Py<PyAny>>,
}

#[pymethods]
impl NamedCustomDict {
    fn __len__(&self) -> usize {
        self.items.len()
    }

    fn __getitem__(&self, key: String) -> PyResult<Py<PyAny>> {
        self.items
            .get(&key)
            .cloned()
            .ok_or_else(|| PyKeyError::new_err(key))
    }

    fn __setitem__(&mut self, key: String, value: Py<PyAny>) {
        self.items.insert(key, value);
    }

    fn keys(&self) -> Vec<&String> {
        self.items.keys().collect()
    }

    fn values(&self) -> Vec<Py<PyAny>> {
        self.items.values().cloned().collect()
    }
}

impl PythonizeNamedMappingType for NamedCustomDict {
    type Builder<'py> = Bound<'py, NamedCustomDict>;

    fn builder<'py>(
        py: Python<'py>,
        len: usize,
        name: &'static str,
    ) -> PyResult<Self::Builder<'py>> {
        Bound::new(
            py,
            NamedCustomDict {
                name: String::from(name),
                items: HashMap::with_capacity(len),
            },
        )
    }

    fn push_field<'py>(
        builder: &mut Self::Builder<'py>,
        name: Bound<'py, pyo3::types::PyString>,
        value: Bound<'py, PyAny>,
    ) -> PyResult<()> {
        unsafe { builder.cast_unchecked::<PyMapping>() }.set_item(name, value)
    }

    fn finish<'py>(builder: Self::Builder<'py>) -> PyResult<Bound<'py, PyMapping>> {
        Ok(unsafe { builder.cast_into_unchecked() })
    }
}

struct PythonizeNamedCustomDict;
impl<'py> PythonizeTypes for PythonizeNamedCustomDict {
    type Map = CustomDict;
    type NamedMap = NamedCustomDict;
    type List = PyTuple;
}

#[derive(Serialize)]
struct Struct {
    hello: u8,
    world: i8,
}

#[test]
fn test_custom_unnamed_dict() {
    Python::attach(|py| {
        PyMapping::register::<CustomDict>(py).unwrap();
        let serialized =
            pythonize_custom::<PythonizeCustomDict, _>(py, &Struct { hello: 1, world: 2 }).unwrap();
        assert!(serialized.is_instance_of::<CustomDict>());

        let deserialized: Value = depythonize(&serialized).unwrap();
        assert_eq!(deserialized, json!({ "hello": 1, "world": 2 }));
    })
}

#[test]
fn test_custom_named_dict() {
    Python::attach(|py| {
        PyMapping::register::<NamedCustomDict>(py).unwrap();
        let serialized =
            pythonize_custom::<PythonizeNamedCustomDict, _>(py, &Struct { hello: 1, world: 2 })
                .unwrap();
        let named: Bound<NamedCustomDict> = serialized.extract().unwrap();
        assert_eq!(named.borrow().name, "Struct");

        let deserialized: Value = depythonize(&serialized).unwrap();
        assert_eq!(deserialized, json!({ "hello": 1, "world": 2 }));
    })
}