Skip to main content

Base class with serialization helpers for user-defined Python objects

Project description

Base class with serialization methods for user-defined Python objects


Classes which inherit from Serializable are given default implementations of to_json, from_json, __reduce__ (for pickling), and other serialization helpers.

Your derived class must:

  • provide a user-defined to_dict() method which returns a dictionary whose keys are strings and whose values are all primitive serializable types (list, dict, int, str, &c).
  • The keys of the dictionary returned by to_dict() must match the arguments to the __init__ of your class.


  • Nested objects must also inherit from Serializable and must be manually converted to serializable types in to_dict() and then reconstructed by overriding the class method _reconstruct_nested_objects.
  • Functions defined at the top level of a module can be converted to primtive types with function_to_serializable_representation, but this helper will fail for methods.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for serializable, version 0.0.2
Filename, size File type Python version Upload date Hashes
Filename, size serializable-0.0.2.tar.gz (5.0 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page