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 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511
|
import functools
import typing
from copy import deepcopy
from dataclasses import dataclass
from functools import partial
from typing import Any
import pytest
from attrs import define
from cattrs import Converter, override
from cattrs.errors import ClassValidationError, StructureHandlerNotFoundError
from cattrs.strategies import configure_tagged_union, include_subclasses
from .._compat import is_py311_plus
T = typing.TypeVar("T")
@define
class Parent:
p: int
@define
class Child1(Parent):
c1: int
@define
class GrandChild(Child1):
g: int
@define
class Child2(Parent):
c2: int
@define
class UnionCompose:
a: typing.Union[Parent, Child1, Child2, GrandChild]
@define
class NonUnionCompose:
a: Parent
@define
class UnionContainer:
a: typing.List[typing.Union[Parent, Child1, Child2, GrandChild]]
@define
class NonUnionContainer:
a: typing.List[Parent]
@define
class CircularA:
a: int
other: "typing.List[CircularA]"
@define
class CircularB(CircularA):
b: int
def _remove_type_name(unstructured: typing.Union[typing.Dict, typing.List]):
if isinstance(unstructured, list):
iterator = unstructured
elif isinstance(unstructured, dict):
if "type_name" in unstructured:
unstructured.pop("type_name")
iterator = unstructured.values()
for item in iterator:
if isinstance(item, (list, dict)):
_remove_type_name(item)
return unstructured
IDS_TO_STRUCT_UNSTRUCT = {
"parent-only": (Parent(1), {"p": 1, "type_name": "Parent"}),
"child1-only": (Child1(1, 2), {"p": 1, "c1": 2, "type_name": "Child1"}),
"child2-only": (Child2(1, 2), {"p": 1, "c2": 2, "type_name": "Child2"}),
"grandchild-only": (
GrandChild(1, 2, 3),
{"p": 1, "c1": 2, "g": 3, "type_name": "GrandChild"},
),
"union-compose-parent": (
UnionCompose(Parent(1)),
{"a": {"p": 1, "type_name": "Parent"}},
),
"union-compose-child": (
UnionCompose(Child1(1, 2)),
{"a": {"p": 1, "c1": 2, "type_name": "Child1"}},
),
"union-compose-grandchild": (
UnionCompose(GrandChild(1, 2, 3)),
{"a": ({"p": 1, "c1": 2, "g": 3, "type_name": "GrandChild"})},
),
"non-union-compose-parent": (
NonUnionCompose(Parent(1)),
{"a": {"p": 1, "type_name": "Parent"}},
),
"non-union-compose-child": (
NonUnionCompose(Child1(1, 2)),
{"a": {"p": 1, "c1": 2, "type_name": "Child1"}},
),
"non-union-compose-grandchild": (
NonUnionCompose(GrandChild(1, 2, 3)),
{"a": ({"p": 1, "c1": 2, "g": 3, "type_name": "GrandChild"})},
),
"union-container": (
UnionContainer([Parent(1), GrandChild(1, 2, 3)]),
{
"a": [
{"p": 1, "type_name": "Parent"},
{"p": 1, "c1": 2, "g": 3, "type_name": "GrandChild"},
]
},
),
"non-union-container": (
NonUnionContainer([Parent(1), GrandChild(1, 2, 3)]),
{
"a": [
{"p": 1, "type_name": "Parent"},
{"p": 1, "c1": 2, "g": 3, "type_name": "GrandChild"},
]
},
),
}
@pytest.fixture(
params=["with-subclasses", "with-subclasses-and-tagged-union", "wo-subclasses"]
)
def conv_w_subclasses(request):
c = Converter()
if request.param == "with-subclasses":
include_subclasses(Parent, c)
include_subclasses(CircularA, c)
elif request.param == "with-subclasses-and-tagged-union":
union_strategy = partial(configure_tagged_union, tag_name="type_name")
include_subclasses(Parent, c, union_strategy=union_strategy)
include_subclasses(CircularA, c, union_strategy=union_strategy)
return c, request.param
@pytest.mark.parametrize(
"struct_unstruct", IDS_TO_STRUCT_UNSTRUCT.values(), ids=IDS_TO_STRUCT_UNSTRUCT
)
def test_structuring_with_inheritance(
conv_w_subclasses: tuple[Converter, bool], struct_unstruct
) -> None:
structured, unstructured = struct_unstruct
converter, included_subclasses_param = conv_w_subclasses
if included_subclasses_param != "with-subclasses-and-tagged-union":
unstructured = _remove_type_name(deepcopy(unstructured))
if "wo-subclasses" in included_subclasses_param and isinstance(
structured, (NonUnionContainer, NonUnionCompose)
):
pytest.xfail(
"Cannot structure subclasses if include_subclasses strategy is not used"
)
assert converter.structure(unstructured, structured.__class__) == structured
if structured.__class__ in {Child1, Child2, GrandChild}:
if "wo-subclasses" in included_subclasses_param:
pytest.xfail(
"Cannot structure subclasses if include_subclasses strategy is not used"
)
assert converter.structure(unstructured, Parent) == structured
if structured.__class__ == GrandChild:
assert converter.structure(unstructured, Child1) == structured
if structured.__class__ in {Parent, Child1, Child2}:
with pytest.raises(ClassValidationError):
_ = converter.structure(unstructured, GrandChild)
def test_structure_as_union():
converter = Converter()
include_subclasses(Parent, converter)
the_list = [{"p": 1, "c1": 2}]
res = converter.structure(the_list, typing.List[typing.Union[Parent, Child1]])
assert res == [Child1(1, 2)]
def test_circular_reference(conv_w_subclasses):
c, included_subclasses_param = conv_w_subclasses
struct = CircularB(a=1, other=[CircularB(a=2, other=[], b=3)], b=4)
unstruct = {
"a": 1,
"other": [{"a": 2, "other": [], "b": 3, "type_name": "CircularB"}],
"b": 4,
"type_name": "CircularB",
}
if included_subclasses_param != "with-subclasses-and-tagged-union":
unstruct = _remove_type_name(unstruct)
if "wo-subclasses" in included_subclasses_param:
pytest.xfail("Cannot succeed if include_subclasses strategy is not used")
res = c.unstructure(struct)
assert res == unstruct
res = c.unstructure(struct, CircularA)
assert res == unstruct
res = c.structure(unstruct, CircularA)
assert res == struct
@pytest.mark.parametrize(
"struct_unstruct", IDS_TO_STRUCT_UNSTRUCT.values(), ids=IDS_TO_STRUCT_UNSTRUCT
)
def test_unstructuring_with_inheritance(
conv_w_subclasses: tuple[Converter, bool], struct_unstruct
):
structured, unstructured = struct_unstruct
converter, included_subclasses_param = conv_w_subclasses
if "wo-subclasses" in included_subclasses_param and isinstance(
structured, (NonUnionContainer, NonUnionCompose)
):
pytest.xfail("Cannot succeed if include_subclasses strategy is not used")
if included_subclasses_param != "with-subclasses-and-tagged-union":
unstructured = _remove_type_name(deepcopy(unstructured))
assert converter.unstructure(structured) == unstructured
if structured.__class__ in {Child1, Child2, GrandChild}:
if "wo-subclasses" in included_subclasses_param:
pytest.xfail("Cannot succeed if include_subclasses strategy is not used")
assert converter.unstructure(structured, unstructure_as=Parent) == unstructured
if structured.__class__ == GrandChild:
assert converter.unstructure(structured, unstructure_as=Child1) == unstructured
def test_structuring_unstructuring_unknown_subclass():
@define
class A:
a: int
@define
class A1(A):
a1: int
converter = Converter()
include_subclasses(A, converter)
# We define A2 after having created the custom un/structuring functions for A and A1
@define
class A2(A1):
a2: int
# Even if A2 did not exist, unstructuring_as A works:
assert converter.unstructure(A2(1, 2, 3), unstructure_as=A) == {
"a": 1,
"a1": 2,
"a2": 3,
}
# As well as when unstructuring as A1, in other words, unstructuring works for
# unknown classes.
assert converter.unstructure(A2(1, 2, 3), unstructure_as=A1) == {
"a": 1,
"a1": 2,
"a2": 3,
}
# But as expected, structuring unknown classes as their parent fails to give the
# correct answer. This is a documented drawback, we just confirm it.
assert converter.structure({"a": 1, "a1": 2, "a2": 3}, A) == A1(1, 2)
def test_structuring_with_subclasses_argument():
c = Converter()
include_subclasses(Parent, c, subclasses=(Child1,))
structured_child, unstructured_child = IDS_TO_STRUCT_UNSTRUCT[
"non-union-compose-child"
]
unstructured_child = _remove_type_name(deepcopy(unstructured_child))
assert c.structure(unstructured_child, NonUnionCompose) == structured_child
assert c.unstructure(structured_child) == unstructured_child
structured_gchild, unstructured_gchild = IDS_TO_STRUCT_UNSTRUCT[
"non-union-compose-grandchild"
]
unstructured_gchild = _remove_type_name(deepcopy(unstructured_gchild))
assert c.structure(unstructured_gchild, NonUnionCompose) == structured_child
assert c.unstructure(structured_gchild) == unstructured_gchild
@pytest.mark.parametrize(
"struct_unstruct", ["parent-only", "child1-only", "child2-only", "grandchild-only"]
)
@pytest.mark.parametrize(
"with_union_strategy",
[True, False],
ids=["with-union-strategy", "wo-union-strategy"],
)
def test_overrides(with_union_strategy: bool, struct_unstruct: str):
c = Converter()
union_strategy = (
partial(configure_tagged_union, tag_name="type_name")
if with_union_strategy
else None
)
include_subclasses(
Parent, c, overrides={"p": override(rename="u")}, union_strategy=union_strategy
)
structured, unstructured = IDS_TO_STRUCT_UNSTRUCT[struct_unstruct]
unstructured = unstructured.copy()
val = unstructured.pop("p")
unstructured["u"] = val
if not with_union_strategy:
unstructured.pop("type_name")
assert c.unstructure(structured) == unstructured
assert c.structure(unstructured, Parent) == structured
assert c.structure(unstructured, structured.__class__) == structured
def test_no_parent_classes(genconverter: Converter):
"""Test an edge condition when a union strategy is used.
The class being registered has no subclasses.
"""
@define
class A:
a: int
include_subclasses(A, genconverter, union_strategy=configure_tagged_union)
assert genconverter.structure({"a": 1}, A) == A(1)
def test_cyclic_classes(genconverter: Converter):
"""A cyclic reference case from issue #542."""
@define
class Base:
pass
@define
class Subclass1(Base):
b: str
a: Base
@define
class Subclass2(Base):
b: str
include_subclasses(Base, genconverter, union_strategy=configure_tagged_union)
assert genconverter.structure(
{"b": "a", "_type": "Subclass1", "a": {"b": "c", "_type": "Subclass2"}}, Base
) == Subclass1("a", Subclass2("c"))
def test_cycles_classes_2(genconverter: Converter):
"""A cyclic reference case from #430."""
@define
class A:
x: int
@define
class Derived(A):
d: A
include_subclasses(A, genconverter, union_strategy=configure_tagged_union)
assert genconverter.structure(
[
{
"x": 9,
"d": {"x": 99, "d": {"x": 999, "_type": "A"}, "_type": "Derived"},
"_type": "Derived",
}
],
list[A],
) == [Derived(9, Derived(99, A(999)))]
def test_unsupported_class(genconverter: Converter):
"""Non-attrs/dataclass classes raise proper errors."""
class NewParent:
"""Not an attrs class."""
a: int
@define
class NewChild(NewParent):
pass
@define
class NewChild2(NewParent):
pass
genconverter.register_structure_hook(NewParent, lambda v, _: NewParent(v))
with pytest.raises(StructureHandlerNotFoundError):
include_subclasses(NewParent, genconverter)
def test_parents_with_generics(genconverter: Converter):
"""Ensure proper handling of generic parents #648."""
@define
class GenericParent(typing.Generic[T]):
p: T
@define
class Child1G(GenericParent[str]):
c: str
include_subclasses(GenericParent[str], genconverter)
assert genconverter.structure({"p": 5, "c": 5}, GenericParent[str]) == Child1G(
"5", "5"
)
def test_parents_with_generics_tagged_union(genconverter: Converter):
"""Ensure proper handling of generic parents with configure_tagged_union, #682."""
@define
class GenericParent(typing.Generic[T]):
p: T
@define
class Child1G(GenericParent[str]):
c: str
@define
class Child2G(GenericParent[int]):
c: str
union_strategy = functools.partial(
configure_tagged_union,
tag_generator=lambda cl: (typing.get_origin(cl) or cl).__name__,
)
include_subclasses(GenericParent[Any], genconverter, union_strategy=union_strategy)
assert genconverter.unstructure(Child1G("5", "5")) == {
"p": "5",
"c": "5",
"_type": "Child1G",
}
assert genconverter.unstructure(Child2G(1, "5")) == {
"p": 1,
"c": "5",
"_type": "Child2G",
}
assert genconverter.structure(
{"p": "5", "c": "5", "_type": "Child1G"}, GenericParent[Any]
) == Child1G("5", "5")
assert genconverter.structure(
{"p": 1, "c": "5", "_type": "Child2G"}, GenericParent[Any]
) == Child2G(1, "5")
def test_dataclasses(genconverter: Converter):
"""Dict dataclasses work."""
@dataclass
class ParentDC:
a: int
@dataclass
class ChildDC1(ParentDC):
b: str
include_subclasses(ParentDC, genconverter)
assert genconverter.structure({"a": 1, "b": "a"}, ParentDC) == ChildDC1(1, "a")
@pytest.mark.skipif(not is_py311_plus, reason="slotted dataclasses supported on 3.11+")
def test_dataclasses_slots(genconverter: Converter):
"""Slotted dataclasses work."""
@dataclass(slots=True)
class ParentDC:
a: int
@dataclass(slots=True)
class ChildDC1(ParentDC):
b: str
include_subclasses(ParentDC, genconverter)
assert genconverter.structure({"a": 1, "b": "a"}, ParentDC) == ChildDC1(1, "a")
|