Source code for obspy.io.json.default

# -*- coding: utf-8 -*-
"""
JSON Encoder default function

This module provides:
---------------------
Default : a class to create a "default" function accepted by the
python :py:mod:`json` module Encoder classes, valid for
:class:`~obspy.core.event.event.Event` objects.

Example
-------
>>> import json
>>> from obspy import read_events
>>> from obspy.io.json.default import Default
>>> c = read_events()
>>> d = Default(omit_nulls=False)
>>> s = json.dumps(c, default=d)

"""
from obspy import UTCDateTime
from obspy.core.event import Catalog, ResourceIdentifier
from obspy.core.util import AttribDict


[docs]class Default(object): """ Class to create a "default" function for the :py:func:`json.dump`/:py:func:`json.dumps` functions which is passed to the JSONEncoder. """ _catalog_attrib = ('events', 'comments', 'description', 'creation_info', 'resource_id') OMIT_NULLS = None TIME_FORMAT = None
[docs] def __init__(self, omit_nulls=True, time_format=None): """ Create a "default" function for JSONEncoder for ObsPy objects :param bool omit_nulls: Leave out any null or empty values (True) :param str time_format: Format string passed to strftime (None) """ # Allows customization of the function self.OMIT_NULLS = omit_nulls self.TIME_FORMAT = time_format
[docs] def __call__(self, obj): """ Deal with :class:`~obspy.core.event.event.Event` objects in JSON Encoder This function can be passed to the json module's `default` keyword parameter """ # Most event objects have dict methods, construct a dict # and deal with special cases that don't if isinstance(obj, AttribDict): # Map to a serializable dict # Leave out nulls, empty strings, list, dicts, except for numbers if self.OMIT_NULLS: return {k: v for k, v in obj.items() if v or v == 0} else: return {k: v for k, v in obj.items()} elif isinstance(obj, Catalog): # Catalog isn't a dict return {k: getattr(obj, k) for k in self._catalog_attrib if getattr(obj, k)} elif isinstance(obj, UTCDateTime): if self.TIME_FORMAT is None: return str(obj) else: return obj.strftime(self.TIME_FORMAT) elif isinstance(obj, ResourceIdentifier): # Always want ID as a string return str(obj) else: return None