rPickle 0.2.0

A safe and efficient Python serialization library

rPickle

A safe and efficient Python serialization library.

Features

• 🔒 Safe - No arbitrary code execution, unlike pickle
• ⚡ Fast - Optimized binary format
• 📦 Compact - Small serialized size
• 🔄 Circular references - Handles self-referential structures
• 🎨 Extensible - Custom type support via extensions

Requirements

• Python 3.15+ (preview)
• Python 3.10+ (full)

Installation

pip install rPickle

Quick Start

import rPickle

# Serialize
data = {'name': 'Alice', 'scores': [95, 87, 92]}
packed = rPickle.dumps(data)

# Deserialize
restored = rPickle.loads(packed)
print(restored)  # {'name': 'Alice', 'scores': [95, 87, 92]}

API

Core Function

Function	Description
dumps(obj)	Serialize object to bytes
loads(data)	Deserialize from bytes
dump(obj, file)	Serialize to file
load(file)	Deserialize from file

Extensions

from datetime import datetime

data = {'created': datetime.now()}
packed = rPickle.dumps(data, extensions=rPickle.datetime_ex)
restored = rPickle.loads(packed, extensions=rPickle.datetime_ex)

Custom Extensions

Add support for your own types using the extensions parameter.

from datetime import datetime

# 1. Define dump function (type → bytes)
def dump_datetime(dt: datetime) -> bytes:
    return dt.timestamp().to_bytes(8, 'little')

# 2. Define load function (bytes → type)
def load_datetime(data: bytes) -> datetime:
    timestamp = int.from_bytes(data, 'little')
    return datetime.fromtimestamp(timestamp)

# 3. Register your extension
my_extensions = {
    datetime: (load_datetime, dump_datetime)  # (load, dump), don't forget the order
}

# 4. Use it
data = {'created': datetime.now()}
packed = rPickle.dumps(data, extensions=my_extensions)
restored = rPickle.loads(packed, extensions=my_extensions)

Built-in Extensions

rPickle includes some ready-to-use extensions

Supported Types

• None, bool, int, float, complex, str
• bytes, bytearray
• list, tuple, set, frozenset
• dict, frozendict (Python 3.15+)
• range, slice
• Ellipsis, NotImplemented
• Custom types

License

MIT