ossindex.serializer

Module Contents

Classes

OssIndexJsonEncoder

Extensible JSON <http://json.org> encoder for Python data structures.

Functions

pythonify_key_names(→ Dict[Any, Any])
json_decoder(→ object)

Attributes

_HYPHENATED_ATTRIBUTES
_PYTHON_TO_JSON_NAME

ossindex.serializer.pythonify_key_names(d: Dict[str, Any]) → Dict[Any, Any]

ossindex.serializer.json_decoder(o: object) → object

ossindex.serializer._HYPHENATED_ATTRIBUTES = ['bom_ref', 'mime_type', 'x_trust_boundary']

ossindex.serializer._PYTHON_TO_JSON_NAME

class ossindex.serializer.OssIndexJsonEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)

Bases: json.JSONEncoder

Extensible JSON <http://json.org> encoder for Python data structures.

Supports the following objects and types by default:

Python	JSON
dict	object
list, tuple	array
str	string
int, float	number
True	true
False	false
None	null

To extend this to recognize other objects, subclass and implement a .default() method with another method that returns a serializable object for o if possible, otherwise it should call the superclass implementation (to raise TypeError).

default(o: Any) → Any

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 JSONEncoder.default(self, o)