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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
|
"""Test both structuring and unstructuring."""
from typing import Optional, Union
import pytest
from attrs import define, fields, make_class
from hypothesis import HealthCheck, assume, given, settings
from hypothesis.strategies import just, one_of
from cattrs import BaseConverter, UnstructureStrategy
from cattrs.errors import StructureHandlerNotFoundError
from ._compat import is_py310_plus
from .typed import nested_typed_classes, simple_typed_attrs, simple_typed_classes
unstructure_strats = one_of(just(s) for s in UnstructureStrategy)
@given(simple_typed_classes(newtypes=False, allow_nan=False), unstructure_strats)
def test_simple_roundtrip(cls_and_vals, strat):
"""
Simple classes with metadata can be unstructured and restructured.
"""
converter = BaseConverter(unstruct_strat=strat)
cl, vals, kwargs = cls_and_vals
assume(strat is UnstructureStrategy.AS_DICT or not kwargs)
inst = cl(*vals, **kwargs)
assert inst == converter.structure(converter.unstructure(inst), cl)
@given(
simple_typed_attrs(defaults="always", newtypes=False, allow_nan=False),
unstructure_strats,
)
def test_simple_roundtrip_defaults(attr_and_strat, strat):
"""
Simple classes with metadata can be unstructured and restructured.
"""
a, _ = attr_and_strat
assume(strat is UnstructureStrategy.AS_DICT or not a.kw_only)
cl = make_class("HypClass", {"a": a})
converter = BaseConverter(unstruct_strat=strat)
inst = cl()
assert converter.unstructure(converter.structure({}, cl)) == converter.unstructure(
inst
)
assert inst == converter.structure(converter.unstructure(inst), cl)
@given(nested_typed_classes(newtypes=False, allow_nan=False))
def test_nested_roundtrip(cls_and_vals):
"""
Nested classes with metadata can be unstructured and restructured.
"""
converter = BaseConverter()
cl, vals, kwargs = cls_and_vals
# Vals are a tuple, convert into a dictionary.
inst = cl(*vals, **kwargs)
assert inst == converter.structure(converter.unstructure(inst), cl)
@given(nested_typed_classes(kw_only="never", newtypes=False, allow_nan=False))
def test_nested_roundtrip_tuple(cls_and_vals):
"""
Nested classes with metadata can be unstructured and restructured.
"""
converter = BaseConverter(unstruct_strat=UnstructureStrategy.AS_TUPLE)
cl, vals, kwargs = cls_and_vals
assert not kwargs
# Vals are a tuple, convert into a dictionary.
inst = cl(*vals)
assert inst == converter.structure(converter.unstructure(inst), cl)
@settings(suppress_health_check=[HealthCheck.too_slow])
@given(
simple_typed_classes(
defaults="never", newtypes=False, allow_nan=False, min_attrs=2
),
simple_typed_classes(
defaults="never", newtypes=False, allow_nan=False, min_attrs=1
),
)
def test_union_field_roundtrip_dict(cl_and_vals_a, cl_and_vals_b):
"""
Classes with union fields can be unstructured and structured.
"""
converter = BaseConverter()
cl_a, vals_a, kwargs_a = cl_and_vals_a
cl_b, _, _ = cl_and_vals_b
a_field_names = {a.name for a in fields(cl_a)}
b_field_names = {a.name for a in fields(cl_b)}
common_names = a_field_names & b_field_names
assume(len(a_field_names) > len(common_names))
@define
class C:
a: Union[cl_a, cl_b]
inst = C(a=cl_a(*vals_a, **kwargs_a))
unstructured = converter.unstructure(inst)
assert inst == converter.structure(converter.unstructure(unstructured), C)
@settings(suppress_health_check=[HealthCheck.too_slow])
@given(
simple_typed_classes(
defaults="never", newtypes=False, allow_nan=False, kw_only="never", min_attrs=2
),
simple_typed_classes(
defaults="never", newtypes=False, allow_nan=False, kw_only="never", min_attrs=1
),
)
def test_union_field_roundtrip_tuple(cl_and_vals_a, cl_and_vals_b):
"""
Classes with union fields can be unstructured and structured.
"""
converter = BaseConverter(unstruct_strat=UnstructureStrategy.AS_TUPLE)
cl_a, vals_a, _ = cl_and_vals_a
cl_b, _, _ = cl_and_vals_b
@define
class C:
a: Union[cl_a, cl_b]
inst = C(a=cl_a(*vals_a))
# Our disambiguation functions only support dictionaries for now.
raw = converter.unstructure(inst)
with pytest.raises(StructureHandlerNotFoundError):
converter.structure(raw, C)
def handler(obj, _):
return converter.structure(obj, cl_a)
converter.register_structure_hook(Union[cl_a, cl_b], handler)
unstructured = converter.unstructure(inst)
assert inst == converter.structure(unstructured, C)
@pytest.mark.skipif(not is_py310_plus, reason="3.10+ union syntax")
@given(
simple_typed_classes(
defaults="never", newtypes=False, allow_nan=False, min_attrs=1
),
simple_typed_classes(
defaults="never", newtypes=False, allow_nan=False, min_attrs=1
),
)
def test_310_union_field_roundtrip_dict(cl_and_vals_a, cl_and_vals_b):
"""
Classes with union fields can be unstructured and structured.
"""
converter = BaseConverter()
cl_a, vals_a, kwargs_a = cl_and_vals_a
cl_b, _, _ = cl_and_vals_b
a_field_names = {a.name for a in fields(cl_a)}
b_field_names = {a.name for a in fields(cl_b)}
common_names = a_field_names & b_field_names
assume(len(a_field_names) > len(common_names))
@define
class C:
a: cl_a | cl_b
inst = C(a=cl_a(*vals_a, **kwargs_a))
assert inst == converter.structure(converter.unstructure(inst), C)
@pytest.mark.skipif(not is_py310_plus, reason="3.10+ union syntax")
@given(
simple_typed_classes(
defaults="never", newtypes=False, allow_nan=False, min_attrs=2, kw_only="never"
),
simple_typed_classes(
defaults="never", newtypes=False, allow_nan=False, min_attrs=1
),
)
def test_310_union_field_roundtrip_tuple(cl_and_vals_a, cl_and_vals_b):
"""
Classes with union fields can be unstructured and structured.
"""
converter = BaseConverter(unstruct_strat=UnstructureStrategy.AS_TUPLE)
cl_a, vals_a, kwargs_a = cl_and_vals_a
cl_b, _, _ = cl_and_vals_b
assert not kwargs_a
a_field_names = {a.name for a in fields(cl_a)}
b_field_names = {a.name for a in fields(cl_b)}
common_names = a_field_names & b_field_names
assume(len(a_field_names) > len(common_names))
@define
class C:
a: cl_a | cl_b
inst = C(a=cl_a(*vals_a, **kwargs_a))
# Our disambiguation functions only support dictionaries for now.
with pytest.raises(StructureHandlerNotFoundError):
converter.structure(converter.unstructure(inst), C)
def handler(obj, _):
return converter.structure(obj, cl_a)
converter.register_structure_hook(cl_a | cl_b, handler)
assert inst == converter.structure(converter.unstructure(inst), C)
@given(simple_typed_classes(defaults="never", newtypes=False, allow_nan=False))
def test_optional_field_roundtrip(cl_and_vals):
"""
Classes with optional fields can be unstructured and structured.
"""
converter = BaseConverter()
cl, vals, kwargs = cl_and_vals
@define
class C:
a: Optional[cl]
inst = C(a=cl(*vals, **kwargs))
assert inst == converter.structure(converter.unstructure(inst), C)
inst = C(a=None)
unstructured = converter.unstructure(inst)
assert inst == converter.structure(unstructured, C)
@pytest.mark.skipif(not is_py310_plus, reason="3.10+ union syntax")
@given(simple_typed_classes(defaults="never", newtypes=False, allow_nan=False))
def test_310_optional_field_roundtrip(cl_and_vals):
"""
Classes with optional fields can be unstructured and structured.
"""
converter = BaseConverter()
cl, vals, kwargs = cl_and_vals
@define
class C:
a: cl | None
inst = C(a=cl(*vals, **kwargs))
assert inst == converter.structure(converter.unstructure(inst), C)
inst = C(a=None)
unstructured = converter.unstructure(inst)
assert inst == converter.structure(unstructured, C)
|
