Module pyboiler.hson

Wraps python.json methods to utilize the HSONEncoder to encode pyboiler objects and others

"""Wraps python.json methods to utilize the HSONEncoder to encode pyboiler objects and others"""

import json
from json import decoder, encoder


class HSONEncoder(json.encoder.JSONEncoder):
    """Encode objects that json doesn't normally encode"""

    def default(self, o):
        try:
            return super().default(o)
        except TypeError:
            try:
                return o.json()
            except AttributeError:
                return str(o)


def dump(*args, **kwargs):
    """Serialize obj to a json formatted stream"""
    return json.dump(*args, **kwargs)


def dumps(*args, **kwargs):
    """Serialize obj to a json formatted string"""
    kwargs["cls"] = HSONEncoder
    if not kwargs.get("pretty"):
        kwargs["indent"] = 4
    else:
        kwargs.pop("pretty")
    return json.dumps(*args, **kwargs)


def load(*args, **kwargs):
    """Deserialize a json formatted stream to python objects"""
    return json.load(*args, **kwargs)


def loads(*args, **kwargs):
    """Deserialize a json formatted string to python objects"""
    return json.loads(*args, **kwargs)

Functions

def dump(*args, **kwargs)

Serialize obj to a json formatted stream

Expand source code

def dump(*args, **kwargs):
    """Serialize obj to a json formatted stream"""
    return json.dump(*args, **kwargs)

def dumps(*args, **kwargs)

Serialize obj to a json formatted string

Expand source code

def dumps(*args, **kwargs):
    """Serialize obj to a json formatted string"""
    kwargs["cls"] = HSONEncoder
    if not kwargs.get("pretty"):
        kwargs["indent"] = 4
    else:
        kwargs.pop("pretty")
    return json.dumps(*args, **kwargs)

def load(*args, **kwargs)

Deserialize a json formatted stream to python objects

Expand source code

def load(*args, **kwargs):
    """Deserialize a json formatted stream to python objects"""
    return json.load(*args, **kwargs)

def loads(*args, **kwargs)

Deserialize a json formatted string to python objects

Expand source code

def loads(*args, **kwargs):
    """Deserialize a json formatted string to python objects"""
    return json.loads(*args, **kwargs)

Classes

class HSONEncoder (*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)

Encode objects that json doesn't normally encode

Constructor for JSONEncoder, with sensible defaults.

If skipkeys is false, then it is a TypeError to attempt encoding of keys that are not str, int, float or None. If skipkeys is True, such items are simply skipped.

If ensure_ascii is true, the output is guaranteed to be str objects with all incoming non-ASCII characters escaped. If ensure_ascii is false, the output can contain non-ASCII characters.

If check_circular is true, then lists, dicts, and custom encoded objects will be checked for circular references during encoding to prevent an infinite recursion (which would cause an RecursionError). Otherwise, no such check takes place.

If allow_nan is true, then NaN, Infinity, and -Infinity will be encoded as such. This behavior is not JSON specification compliant, but is consistent with most JavaScript based encoders and decoders. Otherwise, it will be a ValueError to encode such floats.

If sort_keys is true, then the output of dictionaries will be sorted by key; this is useful for regression tests to ensure that JSON serializations can be compared on a day-to-day basis.

If indent is a non-negative integer, then JSON array elements and object members will be pretty-printed with that indent level. An indent level of 0 will only insert newlines. None is the most compact representation.

If specified, separators should be an (item_separator, key_separator) tuple. The default is (', ', ': ') if indent is None and (',', ': ') otherwise. To get the most compact JSON representation, you should specify (',', ':') to eliminate whitespace.

If specified, default is a function that gets called for objects that can't otherwise be serialized. It should return a JSON encodable version of the object or raise a TypeError.

Expand source code

class HSONEncoder(json.encoder.JSONEncoder):
    """Encode objects that json doesn't normally encode"""

    def default(self, o):
        try:
            return super().default(o)
        except TypeError:
            try:
                return o.json()
            except AttributeError:
                return str(o)

Ancestors

• json.encoder.JSONEncoder

Methods

def default(self, o)

Implement this method in a subclass such that it returns a serializable object for o, or calls the base implementation (to raise a TypeError).

For example, to support arbitrary iterators, you could implement default like this::

def default(self, o):
    try:
        iterable = iter(o)
    except TypeError:
        pass
    else:
        return list(iterable)
    # Let the base class default method raise the TypeError
    return super().default(o)

Expand source code

def default(self, o):
    try:
        return super().default(o)
    except TypeError:
        try:
            return o.json()
        except AttributeError:
            return str(o)