Coverage for python/lsst/verify/jsonmixin.py : 24%

Hot-keys on this page
r m x p toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
# This file is part of verify. # # Developed for the LSST Data Management System. # This product includes software developed by the LSST Project # (https://www.lsst.org). # See the COPYRIGHT file at the top-level directory of this distribution # for details of code ownership. # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see <https://www.gnu.org/licenses/>.
"""Mixin that provides JSON serialization support to subclasses.
Subclasses must implement the `json` method. The method returns a `dict` that can be serialized to JSON. Use the `jsonify_dict` method to handle the conversion of iterables, numbers, strings, booleans and `JsonSerializationMixin`-compatible objects into a JSON-serialiable object. """
def json(self): """`dict` that can be serialized as semantic JSON, compatible with the SQUASH metric service. """ pass
def jsonify_dict(d): """Recursively build JSON-renderable objects on all values in a dict.
Parameters ---------- d : `dict` Dictionary to convert into a JSON-serializable object. Values are recursively JSON-ified.
Returns ------- json_dict : `dict` Dictionary that can be serialized to JSON.
Examples -------- Subclasses can use this method to prepare output in their `json`-method implementation. For example::
def json(self): return JsonSerializationMixin.jsonify_dict({ 'value': self.value, }) """ json_dict = {} for k, v in d.items(): json_dict[k] = JsonSerializationMixin._jsonify_value(v) return json_dict
def _jsonify_list(lst): """Recursively convert items of a list into JSON-serializable objects. """ json_array = [] for v in lst: json_array.append(JsonSerializationMixin._jsonify_value(v)) return json_array
def _jsonify_value(v): """Convert an object into a JSON-serizable object, recursively processes dicts and iterables. """ if isinstance(v, JsonSerializationMixin): return v.json elif isinstance(v, dict): return JsonSerializationMixin.jsonify_dict(v) elif isinstance(v, (list, tuple, set)): return JsonSerializationMixin._jsonify_list(v) else: return v
"""Write JSON to a file.
Parameters ---------- filepath : `str` Destination file name for JSON output. """ with open(filepath, 'w') as outfile: json.dump(self.json, outfile, sort_keys=True, indent=2) |