-
Notifications
You must be signed in to change notification settings - Fork 1k
/
json.py
169 lines (134 loc) · 5.94 KB
/
json.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
# Copyright 2020 The Cirq Developers
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import inspect
import io
import pathlib
from dataclasses import dataclass
from typing import List, Type, Dict, Iterator, Tuple, Set
import numpy as np
import pandas as pd
import cirq
from cirq._import import ModuleType
# This is the testing framework for json serialization
# The actual tests live in cirq.protocols.json_serialization_test.py.
#
# When registering a new module, it has to come with the following setup:
# - test data: a new package to contain the test data, see for example
# cirq/google/json_test_data
# - test spec: the json_test_data package should export an object named
# TestSpec, which should be of type ModuleJsonTestSpec, see for example
# cirq/google/json_test_data/spec.py
# - resolver cache: a resolver cache for the exposed types - see for example
# cirq/json_resolver_cache.py or cirq/google/json_resolver_cache.py
from cirq.protocols.json_serialization import ObjectFactory
@dataclass
class ModuleJsonTestSpec:
# for test failures, a better representation
name: str
# the packages that have the public classes to be checked for serialization
packages: List[ModuleType]
# the path for the folder containing the test files
test_data_path: pathlib.Path
# these public class names are planned to be serializable but not yet
not_yet_serializable: List[str]
# these public class names do not need to be serialized ever
should_not_be_serialized: List[str]
# points to the resolver cache's dict for this module
resolver_cache: Dict[str, ObjectFactory]
# {DeprecatedClass: deprecation_deadline} pairs to avoid deprecation errors
# in serialization tests.
deprecated: Dict[str, str]
def __repr__(self):
return self.name
def _get_all_public_classes(self) -> Iterator[Tuple[str, Type]]:
for module in self.packages:
for name, obj in inspect.getmembers(module):
if inspect.isfunction(obj) or inspect.ismodule(obj):
continue
if name in self.should_not_be_serialized:
continue
if not inspect.isclass(obj):
# singletons, for instance
obj = obj.__class__
if name.startswith('_'):
continue
if inspect.isclass(obj) and inspect.isabstract(obj):
continue
yield name, obj
def find_classes_that_should_serialize(self) -> Set[Tuple[str, Type]]:
result: Set[Tuple[str, Type]] = set()
result.update({(name, obj) for name, obj in self._get_all_public_classes()})
result.update(self.get_resolver_cache_types())
return result
def get_resolver_cache_types(self):
result: Set[Tuple[str, Type]] = set()
for k, v in self.resolver_cache.items():
t = v if isinstance(v, type) else None
result.add((k, t))
return result
def get_all_names(self) -> Iterator[str]:
def not_module_or_function(x):
return not (inspect.ismodule(x) or inspect.isfunction(x))
for m in self.packages:
for name, _ in inspect.getmembers(m, not_module_or_function):
yield name
def all_test_data_keys(self) -> List[str]:
seen = set()
for file in self.test_data_path.iterdir():
name = str(file.absolute())
if name.endswith('.json') or name.endswith('.repr'):
seen.add(name[: -len('.json')])
elif name.endswith('.json_inward') or name.endswith('.repr_inward'):
seen.add(name[: -len('.json_inward')])
return sorted(seen)
def spec_for(module_name: str) -> ModuleJsonTestSpec:
import importlib.util
if importlib.util.find_spec(module_name) is None:
raise ModuleNotFoundError(f"{module_name} not found")
test_module_name = f"{module_name}.json_test_data"
if importlib.util.find_spec(test_module_name) is None:
raise ValueError(
f"{module_name} module is missing json_test_data package, please set it up."
)
test_module = importlib.import_module(test_module_name)
if not hasattr(test_module, "TestSpec"):
raise ValueError(f"{test_module_name} module is missing TestSpec, please set it up.")
return getattr(test_module, "TestSpec")
def assert_json_roundtrip_works(obj, text_should_be=None, resolvers=None):
"""Tests that the given object can serialized and de-serialized
Args:
obj: The object to test round-tripping for.
text_should_be: An optional argument to assert the JSON serialized
output.
resolvers: Any resolvers if testing those other than the default.
Raises:
AssertionError: The given object can not be round-tripped according to
the given arguments.
"""
buffer = io.StringIO()
cirq.protocols.to_json(obj, buffer)
if text_should_be is not None:
buffer.seek(0)
text = buffer.read()
assert text == text_should_be, text
buffer.seek(0)
restored_obj = cirq.protocols.read_json(buffer, resolvers=resolvers)
if isinstance(obj, np.ndarray):
np.testing.assert_equal(restored_obj, obj)
elif isinstance(obj, pd.DataFrame):
pd.testing.assert_frame_equal(restored_obj, obj)
elif isinstance(obj, pd.Index):
pd.testing.assert_index_equal(restored_obj, obj)
else:
assert restored_obj == obj