Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Python 3 library for easily JSON encoding/decoding complex class-based Python models, using an arbitrarily complex (but easy to write!) mapping schema.

Project Description
[![Build Status](https://travis-ci.org/wtsi-hgi/python-json.svg)](https://travis-ci.org/wtsi-hgi/python-json)
[![codecov.io](https://codecov.io/gh/wtsi-hgi/python-json/graph/badge.svg)](https://codecov.io/gh/wtsi-hgi/python-json/)
[![Documentation Status](https://readthedocs.org/projects/hgi-json/badge/?version=latest)](http://hgi-json.readthedocs.io/en/latest/?badge=latest)


# HGI JSON
A Python 3 library for easily JSON encoding/decoding complex class-based Python models, using an arbitrarily complex
(but easy to write!) mapping schema.


## Features
* Ability to create serializers and deserializers for complex class-based models using a mapping schema defined in
Python.
* Works seamlessly with Python's in-built `json.dumps` and `json.loads` serialization methods - does not require the use
of exotic `convert_to_json`/`convert_from_json` methods.
* Python models are not be coupled to the serialization process - models do not have to inherit from a particular
superclass or implement an interface with a `to_json` (or similar) method.
* JSON representations produced are not coupled to the Python model - an arbitrary mapping between the JSON and the
model can be defined.
* Simple to define serialization of subclasses, based on how superclasses are serialized.
* Pure Python 3 - no DSL, XML or similar required to describe mappings, not using outdated Python 2.
* [Well tested](https://codecov.io/gh/wtsi-hgi/python-json/).


## Overview
### Basic Steps
1. Define schema for mapping an object to and/or from JSON representation using a list of `JsonPropertyMapping`
definitions.
2. Use `MappingJSONEncoderClassBuilder` with the mappings to build a subclass of `JSONEncode` for serializing instances
of a specific type. Similar with decode.
3. Use created encoder class with Python's in-built `json.dumps` via the `cls` parameter. Similar with decoder.


### Defining Encoders/Decoders
Encoders and decoders are generated based on a defined JSON <-> Model mapping. A mapping can be written that allows
complex classes, such as that below, to be mapped to and from any JSON representation:
```python
class CustomClass(SupportFor, MultipleInheritance):
self __init__(self, support_for_constructor_parameters):
self.support_for_all_types_of_properties = ""
self.including_sets = set()
self.and_lists = list()
self.and_dictionaries = dict()
self.and_complex_properties = ComplexClass()
self.and_nested_objects_of_the_same_type = CustomClass()
self.and_properties_not_in_json_if_none = None

self support_for_setters(self, value):
"""..."""

self support_for_getters(self):
"""..."""

CustomClassJSONEncoder = MappingJSONEncoderClassBuilder(...).build() # type: JSONEncoder
CustomClassJSONDecoder = MappingJSONDecoderClassBuilder(...).build() # type: JSONDecoder

custom_class_as_json = json.dumps(custom_class, cls=CustomClassJSONEncoder) # type: str
custom_class = json.loads("<custom_class_as_json>", cls=CustomClassJSONDecoder) # type: CustomClass
```

## Documentation
For more details, including information on how to setup and use the library, please [view the documentation on
ReadTheDocs](http://hgi-json.readthedocs.io/en/latest/) or read it from `/docs`.
Release History

Release History

This version
History Node

1.5.0

History Node

1.4.3

History Node

1.4.2

History Node

1.4.1

History Node

1.4.0

History Node

1.3.1

History Node

1.3.0

History Node

1.2.2

Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
hgijson-1.5.0.tar.gz (20.4 kB) Copy SHA256 Checksum SHA256 Source Nov 16, 2017

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting