Skip to main content
Help us improve Python packaging – donate today!

Simplify JSON Encoders and Object Hooks

Project Description

Build Status Coverage Status

json-object-factory

Simplifies building custom encoders and object-hooks for Python’s default JSON implementation.

Installation

$ pip install json-object-factory

Usage

Add encoders and decoders to the registry:

import jsonfactory

class MyJsonHandler(object):
    def encode(self, o):
        if isinstance(o, MyCustomClass):
            return o.serialize()
        return None

    def decode(self, d):
        if 'some_custom_key' in d:
            return MyCustomClass(**d)
        return d

jsonfactory.Registry.register(MyJsonHandler)

Or use the included decorators:

@jsonfactory.register
class MyOtherJsonHandler(object):
    ...

@jsonfactory.encoder
def an_encoder_function(o):
    ...

@jsonfactory.decoder
def a_decoder_function(d):
    ...

Then use the module’s dumps and loads functions:

json_str = jsonfactory.dumps(obj_dict, indent=2)

new_obj_dict = jsonfactory.loads(json_str)

Notes

  • The calling signature for encoder functions follows that of the built-in JSONEncoder with one exception:
    • If no modifications are needed and the object should be passed to the base encoder’s handler, None should be returned. This differs from the normal method of calling super(MyEncoder, self).default(o) (that would most likely be an error since subclassing JSONEncoder isn’t necessary).
  • The signature for decoder functions follows the object_hook signature in the built-in implementation

Release history Release notifications

This version
History Node

0.0.2

History Node

0.0.1

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
json_object_factory-0.0.2-py2.py3-none-any.whl (5.5 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Jun 1, 2016
json-object-factory-0.0.2.tar.gz (2.9 kB) Copy SHA256 hash SHA256 Source None Jun 1, 2016

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page