Coverage for python/lsst/daf/butler/formatters/json.py: 77%
Shortcuts 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
Shortcuts 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
1# This file is part of daf_butler.
2#
3# Developed for the LSST Data Management System.
4# This product includes software developed by the LSST Project
5# (http://www.lsst.org).
6# See the COPYRIGHT file at the top-level directory of this distribution
7# for details of code ownership.
8#
9# This program is free software: you can redistribute it and/or modify
10# it under the terms of the GNU General Public License as published by
11# the Free Software Foundation, either version 3 of the License, or
12# (at your option) any later version.
13#
14# This program is distributed in the hope that it will be useful,
15# but WITHOUT ANY WARRANTY; without even the implied warranty of
16# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17# GNU General Public License for more details.
18#
19# You should have received a copy of the GNU General Public License
20# along with this program. If not, see <http://www.gnu.org/licenses/>.
22from __future__ import annotations
24__all__ = ("JsonFormatter", )
26import builtins
27import json
29from typing import (
30 TYPE_CHECKING,
31 Any,
32 Optional,
33 Type,
34)
36from .file import FileFormatter
38if TYPE_CHECKING: 38 ↛ 39line 38 didn't jump to line 39, because the condition on line 38 was never true
39 from lsst.daf.butler import StorageClass
42class JsonFormatter(FileFormatter):
43 """Interface for reading and writing Python objects to and from JSON files.
44 """
45 extension = ".json"
47 unsupportedParameters = None
48 """This formatter does not support any parameters (`frozenset`)"""
50 def _readFile(self, path: str, pytype: Optional[Type[Any]] = None) -> Any:
51 """Read a file from the path in JSON format.
53 Parameters
54 ----------
55 path : `str`
56 Path to use to open JSON format file.
57 pytype : `class`, optional
58 Not used by this implementation.
60 Returns
61 -------
62 data : `object`
63 Data as Python object read from JSON file.
64 """
65 with open(path, "rb") as fd:
66 data = self._fromBytes(fd.read(), pytype)
68 return data
70 def _writeFile(self, inMemoryDataset: Any) -> None:
71 """Write the in memory dataset to file on disk.
73 Will look for `_asdict()` method to aid JSON serialization, following
74 the approach of the simplejson module.
76 Parameters
77 ----------
78 inMemoryDataset : `object`
79 Object to serialize.
81 Raises
82 ------
83 Exception
84 The file could not be written.
85 """
86 self.fileDescriptor.location.uri.write(self._toBytes(inMemoryDataset))
88 def _fromBytes(self, serializedDataset: bytes, pytype: Optional[Type[Any]] = None) -> Any:
89 """Read the bytes object as a python object.
91 Parameters
92 ----------
93 serializedDataset : `bytes`
94 Bytes object to unserialize.
95 pytype : `class`, optional
96 Not used by this implementation.
98 Returns
99 -------
100 inMemoryDataset : `object`
101 The requested data as a Python object or None if the string could
102 not be read.
103 """
104 try:
105 data = json.loads(serializedDataset)
106 except json.JSONDecodeError:
107 data = None
109 return data
111 def _toBytes(self, inMemoryDataset: Any) -> bytes:
112 """Write the in memory dataset to a bytestring.
114 Parameters
115 ----------
116 inMemoryDataset : `object`
117 Object to serialize
119 Returns
120 -------
121 serializedDataset : `bytes`
122 bytes representing the serialized dataset.
124 Raises
125 ------
126 Exception
127 The object could not be serialized.
128 """
129 # For example, Pydantic models have a .json method so use it.
130 try:
131 return inMemoryDataset.json().encode()
132 except AttributeError:
133 pass
135 if hasattr(inMemoryDataset, "_asdict"):
136 inMemoryDataset = inMemoryDataset._asdict()
137 return json.dumps(inMemoryDataset, ensure_ascii=False).encode()
139 def _coerceType(self, inMemoryDataset: Any, storageClass: StorageClass,
140 pytype: Optional[Type[Any]] = None) -> Any:
141 """Coerce the supplied inMemoryDataset to type `pytype`.
143 Parameters
144 ----------
145 inMemoryDataset : `object`
146 Object to coerce to expected type.
147 storageClass : `StorageClass`
148 StorageClass associated with `inMemoryDataset`.
149 pytype : `type`, optional
150 Override type to use for conversion.
152 Returns
153 -------
154 inMemoryDataset : `object`
155 Object of expected type `pytype`.
156 """
157 if inMemoryDataset is not None and pytype is not None and not hasattr(builtins, pytype.__name__):
158 if storageClass.isComposite():
159 inMemoryDataset = storageClass.delegate().assemble(inMemoryDataset, pytype=pytype)
160 elif not isinstance(inMemoryDataset, pytype): 160 ↛ 162line 160 didn't jump to line 162, because the condition on line 160 was never true
161 # Pydantic models have their own scheme.
162 try:
163 inMemoryDataset = pytype.parse_obj(inMemoryDataset)
164 except AttributeError:
165 # Hope that we can pass the arguments in directly
166 inMemoryDataset = pytype(inMemoryDataset)
167 return inMemoryDataset