add support for pickle (#5)

README.md

@@ -29,7 +29,7 @@ isinstance(bp, bytes)
 ## Features
 
 - Fluent interface, based on a `bytes` subclass
-- Provides a convenient interface over `hashlib`, `base64`, `zlib`, `urllib.parse`, `json` and more
+- Provides a convenient interface over `hashlib`, `base64`, `zlib`, `urllib.parse`, `json`, `pickle` and more
 - Easy to extend with new formats
 
 ## TODO

binapy/parsing/__init__.py

@@ -1,2 +1,3 @@
 """This module contains helpers for parsing or serializing data in various formats."""
 from .json import *
+from .pickle import *

binapy/parsing/pickle.py

@@ -0,0 +1,33 @@
+"""This module implements helpers for (de)serializing to/from Python `pickle` objects."""
+
+import pickle
+from typing import Any, Optional
+
+from binapy import binapy_parser, binapy_serializer
+
+
+@binapy_serializer("pickle")
+def to_pickle(
+ o: object,
+ protocol: Optional[int] = None,
+ fix_imports: bool = True,
+ buffer_callback: Any = None,
+) -> bytes:
+ """Serialize an object using `pickle.dumps()`."""
+ return pickle.dumps(
+ o, protocol=protocol, fix_imports=fix_imports, buffer_callback=buffer_callback
+ )
+
+
+@binapy_parser("pickle")
+def from_pickle(
+ bp: bytes,
+ fix_imports: bool = True,
+ encoding: str = "ASCII",
+ errors: str = "strict",
+ buffers: Any = None,
+) -> object:
+ """Deserialize an object using `pickle.loads()`."""
+ return pickle.loads(
+ bp, fix_imports=fix_imports, encoding=encoding, errors=errors, buffers=buffers
+ )

tests/test_pickle.py

@@ -0,0 +1,20 @@
+from __future__ import annotations
+
+import secrets
+
+from binapy import BinaPy
+
+
+class PickleTester:
+ def __init__(self) -> None:
+ self.random = secrets.token_hex()
+
+ def __eq__(self, other: object) -> bool:
+ return isinstance(other, PickleTester) and other.random == self.random
+
+
+o = PickleTester()
+
+
+def test_pickle() -> None:
+ assert BinaPy.serialize_to("pickle", o).parse_from("pickle") == o