1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
#![cfg(not(Py_LIMITED_API))]
//! Support for the Python `marshal` format.
use crate::ffi_ptr_ext::FfiPtrExt;
use crate::py_result_ext::PyResultExt;
use crate::types::{PyAny, PyBytes};
use crate::{ffi, Bound};
use crate::{PyResult, Python};
use std::ffi::c_int;
/// The current version of the marshal binary format.
pub const VERSION: i32 = 4;
/// Serialize an object to bytes using the Python built-in marshal module.
///
/// The built-in marshalling only supports a limited range of objects.
/// The exact types supported depend on the version argument.
/// The [`VERSION`] constant holds the highest version currently supported.
///
/// See the [Python documentation](https://docs.python.org/3/library/marshal.html) for more details.
///
/// # Examples
/// ```
/// # use pyo3::{marshal, types::PyDict, prelude::PyDictMethods};
/// # pyo3::Python::attach(|py| {
/// let dict = PyDict::new(py);
/// dict.set_item("aap", "noot").unwrap();
/// dict.set_item("mies", "wim").unwrap();
/// dict.set_item("zus", "jet").unwrap();
///
/// let bytes = marshal::dumps(&dict, marshal::VERSION);
/// # });
/// ```
pub fn dumps<'py>(object: &Bound<'py, PyAny>, version: i32) -> PyResult<Bound<'py, PyBytes>> {
unsafe {
ffi::PyMarshal_WriteObjectToString(object.as_ptr(), version as c_int)
.assume_owned_or_err(object.py())
.cast_into_unchecked()
}
}
/// Deserialize an object from bytes using the Python built-in marshal module.
pub fn loads<'py, B>(py: Python<'py>, data: &B) -> PyResult<Bound<'py, PyAny>>
where
B: AsRef<[u8]> + ?Sized,
{
let data = data.as_ref();
unsafe {
ffi::PyMarshal_ReadObjectFromString(data.as_ptr().cast(), data.len() as isize)
.assume_owned_or_err(py)
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::types::{bytes::PyBytesMethods, dict::PyDictMethods, PyAnyMethods, PyDict};
#[test]
fn marshal_roundtrip() {
Python::attach(|py| {
let dict = PyDict::new(py);
dict.set_item("aap", "noot").unwrap();
dict.set_item("mies", "wim").unwrap();
dict.set_item("zus", "jet").unwrap();
let pybytes = dumps(&dict, VERSION).expect("marshalling failed");
let deserialized = loads(py, pybytes.as_bytes()).expect("unmarshalling failed");
assert!(dict.eq(&deserialized).unwrap());
});
}
}