A simple way to turn objects into strings and vice-versa
Project description
Easy-Serialize
Turn custom python objects into strings and vice-versa.
Strengths
- no extra code to write in most cases
- supports json
- supports nested objects
- no dependencies outside of python's library (only pytest for developing)
- ability to add methods to control serializing and deserializing
- type hints and works with mypy
Drawbacks
- objects like tuples are automatically turned into lists
- only supports json right now
- can't handle circular references
- if an object has references in many places, it will be present in the json repeatedly and after deserializing will be separate objects
- Because of this, it cannot handle linked lists or similar interconnected data structures well
- stores
__dict__
of the object, so classes using__slots__
will likely require overriding theserialize
method anddeserialize
classmethod.
How to use
Extend Serializable
class A(Serializable):
...
or use the make_serializable
decorator
@make_serializable
class A:
...
serialize using
serialize(object_to_serialize)
and deserialize using
deserialize(stringified_object)
Custom serializing
In the case that the standard method doesn't cut it, it is possible to add custom serializing and deserializing methods to a class
@make_serializable
class A:
def __init__(self, x):
self.x = x
def serialize(self) -> dict:
return {'x': self.x}
@classmethod
def deserialize(cls, data: dict) -> 'A':
return A(data['x'])
Notes
__init__
is by default not called for deserialized objects- Because it needs to create the object and then copy over all the values of
__dict__
, it doesn't know the arguments used in__init__
. Thus if the class requires arguments in__init__
, the object will be created with__new__
which avoids calling__init__
. However, if__init__
can take zero arguments, it will be called. A warning will be emitted if__init__
is not called.
- Because it needs to create the object and then copy over all the values of
Future
Things to possibly add:
- other data formats like xml or the like
- support for objects with circular references
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
easy-serialize-0.0.4a0.tar.gz
(4.3 kB
view hashes)
Built Distribution
Close
Hashes for easy_serialize-0.0.4a0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1e82a3594c509608c66c2468994370d19a0906d67d64c5d6d1e680b89bb6063f |
|
MD5 | 4428fc8ebb49a606f13c87063e905233 |
|
BLAKE2b-256 | 1af3a493189985beb2637094cb8ec67d19ad2432d3b338e0a9b38b3f7e0dc015 |