Skip to content

Commit ba8b733

Browse files
authored
Merge pull request RustPython#1044 from RustPython/coolreader18/ser_de-own-module
Move PyObject de/serialization to its own module
2 parents 86b8c07 + 0ac42ac commit ba8b733

File tree

8 files changed

+278
-243
lines changed

8 files changed

+278
-243
lines changed

Cargo.lock

Lines changed: 20 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

vm/src/lib.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ mod frozen;
5353
pub mod function;
5454
pub mod import;
5555
pub mod obj;
56+
pub mod py_serde;
5657
mod pyhash;
5758
pub mod pyobject;
5859
pub mod stdlib;

vm/src/py_serde.rs

Lines changed: 222 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,222 @@
1+
use std::fmt;
2+
3+
use serde;
4+
use serde::de::{DeserializeSeed, Visitor};
5+
use serde::ser::{Serialize, SerializeMap, SerializeSeq};
6+
7+
use crate::obj::{
8+
objbool,
9+
objdict::PyDictRef,
10+
objfloat, objint, objsequence,
11+
objstr::{self, PyString},
12+
objtype,
13+
};
14+
use crate::pyobject::{IdProtocol, ItemProtocol, PyObjectRef, TypeProtocol};
15+
use crate::VirtualMachine;
16+
use num_traits::cast::ToPrimitive;
17+
18+
#[inline]
19+
pub fn serialize<S>(
20+
vm: &VirtualMachine,
21+
pyobject: &PyObjectRef,
22+
serializer: S,
23+
) -> Result<S::Ok, S::Error>
24+
where
25+
S: serde::Serializer,
26+
{
27+
PyObjectSerializer { vm, pyobject }.serialize(serializer)
28+
}
29+
30+
#[inline]
31+
pub fn deserialize<'de, D>(
32+
vm: &'de VirtualMachine,
33+
deserializer: D,
34+
) -> Result<<PyObjectDeserializer as DeserializeSeed>::Value, D::Error>
35+
where
36+
D: serde::Deserializer<'de>,
37+
{
38+
PyObjectDeserializer { vm }.deserialize(deserializer)
39+
}
40+
41+
// We need to have a VM available to serialise a PyObject based on its subclass, so we implement
42+
// PyObject serialisation via a proxy object which holds a reference to a VM
43+
pub struct PyObjectSerializer<'s> {
44+
pyobject: &'s PyObjectRef,
45+
vm: &'s VirtualMachine,
46+
}
47+
48+
impl<'s> PyObjectSerializer<'s> {
49+
pub fn new(vm: &'s VirtualMachine, pyobject: &'s PyObjectRef) -> Self {
50+
PyObjectSerializer { vm, pyobject }
51+
}
52+
53+
fn clone_with_object(&self, pyobject: &'s PyObjectRef) -> PyObjectSerializer {
54+
PyObjectSerializer {
55+
pyobject,
56+
vm: self.vm,
57+
}
58+
}
59+
}
60+
61+
impl<'s> serde::Serialize for PyObjectSerializer<'s> {
62+
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
63+
where
64+
S: serde::Serializer,
65+
{
66+
let serialize_seq_elements =
67+
|serializer: S, elements: &Vec<PyObjectRef>| -> Result<S::Ok, S::Error> {
68+
let mut seq = serializer.serialize_seq(Some(elements.len()))?;
69+
for e in elements.iter() {
70+
seq.serialize_element(&self.clone_with_object(e))?;
71+
}
72+
seq.end()
73+
};
74+
if objtype::isinstance(self.pyobject, &self.vm.ctx.str_type()) {
75+
serializer.serialize_str(&objstr::get_value(&self.pyobject))
76+
} else if objtype::isinstance(self.pyobject, &self.vm.ctx.float_type()) {
77+
serializer.serialize_f64(objfloat::get_value(self.pyobject))
78+
} else if objtype::isinstance(self.pyobject, &self.vm.ctx.bool_type()) {
79+
serializer.serialize_bool(objbool::get_value(self.pyobject))
80+
} else if objtype::isinstance(self.pyobject, &self.vm.ctx.int_type()) {
81+
let v = objint::get_value(self.pyobject);
82+
serializer.serialize_i64(v.to_i64().unwrap())
83+
// Although this may seem nice, it does not give the right result:
84+
// v.serialize(serializer)
85+
} else if objtype::isinstance(self.pyobject, &self.vm.ctx.list_type()) {
86+
let elements = objsequence::get_elements_list(self.pyobject);
87+
serialize_seq_elements(serializer, &elements)
88+
} else if objtype::isinstance(self.pyobject, &self.vm.ctx.tuple_type()) {
89+
let elements = objsequence::get_elements_tuple(self.pyobject);
90+
serialize_seq_elements(serializer, &elements)
91+
} else if objtype::isinstance(self.pyobject, &self.vm.ctx.dict_type()) {
92+
let dict: PyDictRef = self.pyobject.clone().downcast().unwrap();
93+
let pairs: Vec<_> = dict.into_iter().collect();
94+
let mut map = serializer.serialize_map(Some(pairs.len()))?;
95+
for (key, e) in pairs.iter() {
96+
map.serialize_entry(&self.clone_with_object(key), &self.clone_with_object(&e))?;
97+
}
98+
map.end()
99+
} else if self.pyobject.is(&self.vm.get_none()) {
100+
serializer.serialize_none()
101+
} else {
102+
Err(serde::ser::Error::custom(format!(
103+
"Object of type '{:?}' is not serializable",
104+
self.pyobject.class()
105+
)))
106+
}
107+
}
108+
}
109+
110+
// This object is used as the seed for deserialization so we have access to the PyContext for type
111+
// creation
112+
#[derive(Clone)]
113+
pub struct PyObjectDeserializer<'c> {
114+
vm: &'c VirtualMachine,
115+
}
116+
117+
impl<'c> PyObjectDeserializer<'c> {
118+
pub fn new(vm: &'c VirtualMachine) -> Self {
119+
PyObjectDeserializer { vm }
120+
}
121+
}
122+
123+
impl<'de> DeserializeSeed<'de> for PyObjectDeserializer<'de> {
124+
type Value = PyObjectRef;
125+
126+
fn deserialize<D>(self, deserializer: D) -> Result<Self::Value, D::Error>
127+
where
128+
D: serde::Deserializer<'de>,
129+
{
130+
deserializer.deserialize_any(self.clone())
131+
}
132+
}
133+
134+
impl<'de> Visitor<'de> for PyObjectDeserializer<'de> {
135+
type Value = PyObjectRef;
136+
137+
fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
138+
formatter.write_str("a type that can deserialise in Python")
139+
}
140+
141+
fn visit_str<E>(self, value: &str) -> Result<Self::Value, E>
142+
where
143+
E: serde::de::Error,
144+
{
145+
Ok(self.vm.ctx.new_str(value.to_string()))
146+
}
147+
148+
fn visit_string<E>(self, value: String) -> Result<Self::Value, E>
149+
where
150+
E: serde::de::Error,
151+
{
152+
Ok(self.vm.ctx.new_str(value))
153+
}
154+
155+
fn visit_i64<E>(self, value: i64) -> Result<Self::Value, E>
156+
where
157+
E: serde::de::Error,
158+
{
159+
// The JSON deserializer always uses the i64/u64 deserializers, so we only need to
160+
// implement those for now
161+
Ok(self.vm.ctx.new_int(value))
162+
}
163+
164+
fn visit_u64<E>(self, value: u64) -> Result<Self::Value, E>
165+
where
166+
E: serde::de::Error,
167+
{
168+
// The JSON deserializer always uses the i64/u64 deserializers, so we only need to
169+
// implement those for now
170+
Ok(self.vm.ctx.new_int(value))
171+
}
172+
173+
fn visit_f64<E>(self, value: f64) -> Result<Self::Value, E>
174+
where
175+
E: serde::de::Error,
176+
{
177+
Ok(self.vm.ctx.new_float(value))
178+
}
179+
180+
fn visit_bool<E>(self, value: bool) -> Result<Self::Value, E>
181+
where
182+
E: serde::de::Error,
183+
{
184+
Ok(self.vm.ctx.new_bool(value))
185+
}
186+
187+
fn visit_seq<A>(self, mut access: A) -> Result<Self::Value, A::Error>
188+
where
189+
A: serde::de::SeqAccess<'de>,
190+
{
191+
let mut seq = Vec::with_capacity(access.size_hint().unwrap_or(0));
192+
while let Some(value) = access.next_element_seed(self.clone())? {
193+
seq.push(value);
194+
}
195+
Ok(self.vm.ctx.new_list(seq))
196+
}
197+
198+
fn visit_map<M>(self, mut access: M) -> Result<Self::Value, M::Error>
199+
where
200+
M: serde::de::MapAccess<'de>,
201+
{
202+
let dict = self.vm.ctx.new_dict();
203+
// TODO: Given keys must be strings, we can probably do something more efficient
204+
// than wrapping the given object up and then unwrapping it to determine whether or
205+
// not it is a string
206+
while let Some((key_obj, value)) = access.next_entry_seed(self.clone(), self.clone())? {
207+
let key: String = match key_obj.payload::<PyString>() {
208+
Some(PyString { ref value }) => value.clone(),
209+
_ => unimplemented!("map keys must be strings"),
210+
};
211+
dict.set_item(&key, value, self.vm).unwrap();
212+
}
213+
Ok(dict.into_object())
214+
}
215+
216+
fn visit_unit<E>(self) -> Result<Self::Value, E>
217+
where
218+
E: serde::de::Error,
219+
{
220+
Ok(self.vm.get_none())
221+
}
222+
}

0 commit comments

Comments
 (0)