|
| 1 | +from dataclasses import dataclass |
| 2 | +from typing import Annotated, NamedTuple, TypedDict |
| 3 | + |
| 4 | +from attrs import define |
| 5 | + |
| 6 | +from cattrs import Converter |
| 7 | +from cattrs.cols import ( |
| 8 | + is_namedtuple, |
| 9 | + namedtuple_dict_structure_factory, |
| 10 | + namedtuple_dict_unstructure_factory, |
| 11 | +) |
| 12 | +from cattrs.gen import make_dict_structure_fn, make_dict_unstructure_fn, override |
| 13 | +from cattrs.gen.typeddicts import make_dict_structure_fn as make_td_structure_fn |
| 14 | +from cattrs.gen.typeddicts import make_dict_unstructure_fn as make_td_unstructure_fn |
| 15 | + |
| 16 | + |
| 17 | +def test_annotated_override_attrs(genconverter: Converter): |
| 18 | + """Annotated overrides work for attrs classes.""" |
| 19 | + |
| 20 | + @define |
| 21 | + class A: |
| 22 | + a: Annotated[int, override(rename="b")] |
| 23 | + c: Annotated[int, override(omit=True)] = 1 |
| 24 | + d: Annotated[int, override(rename="e")] = 2 |
| 25 | + |
| 26 | + instance = A(1) |
| 27 | + # 'a' is renamed to 'b', 'c' is omitted. 'd' is default so present as 'e' |
| 28 | + assert genconverter.unstructure(instance) == {"b": 1, "e": 2} |
| 29 | + |
| 30 | + assert genconverter.structure({"b": 1, "e": 2}, A) == A(1) |
| 31 | + |
| 32 | + |
| 33 | +def test_annotated_override_dataclasses(genconverter: Converter): |
| 34 | + """Annotated overrides work for dataclasses.""" |
| 35 | + |
| 36 | + @dataclass |
| 37 | + class A: |
| 38 | + a: Annotated[int, override(rename="b")] |
| 39 | + c: Annotated[int, override(omit=True)] = 1 |
| 40 | + |
| 41 | + instance = A(1) |
| 42 | + assert genconverter.unstructure(instance) == {"b": 1} |
| 43 | + |
| 44 | + assert genconverter.structure({"b": 1}, A) == A(1) |
| 45 | + |
| 46 | + |
| 47 | +def test_annotated_override_typeddict(genconverter: Converter): |
| 48 | + """Annotated overrides work for TypedDicts.""" |
| 49 | + |
| 50 | + class TD(TypedDict): |
| 51 | + a: Annotated[int, override(rename="b")] |
| 52 | + c: Annotated[int, override(omit=True)] |
| 53 | + |
| 54 | + instance: TD = {"a": 1, "c": 2} |
| 55 | + |
| 56 | + assert genconverter.unstructure(instance, TD) == {"b": 1} |
| 57 | + |
| 58 | + # Let's simplify and just test rename for now to avoid required field issues with omit. |
| 59 | + class TD2(TypedDict): |
| 60 | + a: Annotated[int, override(rename="b")] |
| 61 | + |
| 62 | + inst2: TD2 = {"a": 1} |
| 63 | + assert genconverter.unstructure(inst2, TD2) == {"b": 1} |
| 64 | + assert genconverter.structure({"b": 1}, TD2) == {"a": 1} |
| 65 | + |
| 66 | + |
| 67 | +def test_annotated_override_namedtuple(genconverter: Converter): |
| 68 | + """Annotated overrides work for NamedTuples using dict factories.""" |
| 69 | + |
| 70 | + # We need to register the dict factories for NamedTuples |
| 71 | + genconverter.register_unstructure_hook_factory( |
| 72 | + is_namedtuple, namedtuple_dict_unstructure_factory |
| 73 | + ) |
| 74 | + genconverter.register_structure_hook_factory( |
| 75 | + is_namedtuple, namedtuple_dict_structure_factory |
| 76 | + ) |
| 77 | + |
| 78 | + class NT(NamedTuple): |
| 79 | + a: Annotated[int, override(rename="b")] |
| 80 | + c: Annotated[int, override(omit=True)] = 1 |
| 81 | + |
| 82 | + instance = NT(1) |
| 83 | + assert genconverter.unstructure(instance) == {"b": 1} |
| 84 | + assert genconverter.structure({"b": 1}, NT) == NT(1) |
| 85 | + |
| 86 | + |
| 87 | +def test_annotated_override_precedence(genconverter: Converter): |
| 88 | + """Test that explicit kwargs override Annotated metadata.""" |
| 89 | + |
| 90 | + @define |
| 91 | + class A: |
| 92 | + a: Annotated[int, override(rename="b")] |
| 93 | + |
| 94 | + # Override the rename back to 'a' explicitly |
| 95 | + unstructure_fn = make_dict_unstructure_fn(A, genconverter, a=override(rename="a")) |
| 96 | + genconverter.register_unstructure_hook(A, unstructure_fn) |
| 97 | + |
| 98 | + assert genconverter.unstructure(A(1)) == {"a": 1} |
| 99 | + |
| 100 | + # # Structure override |
| 101 | + structure_fn = make_dict_structure_fn(A, genconverter, a=override(rename="a")) |
| 102 | + genconverter.register_structure_hook(A, structure_fn) |
| 103 | + |
| 104 | + assert genconverter.structure({"a": 1}, A) == A(1) |
| 105 | + |
| 106 | + |
| 107 | +def test_annotated_override_hooks(genconverter: Converter): |
| 108 | + """struct_hook and unstruct_hook work in Annotated.""" |
| 109 | + |
| 110 | + def double_hook(v): |
| 111 | + return v * 2 |
| 112 | + |
| 113 | + def half_hook(v, _): |
| 114 | + return v // 2 |
| 115 | + |
| 116 | + @define |
| 117 | + class A: |
| 118 | + a: Annotated[int, override(unstruct_hook=double_hook, struct_hook=half_hook)] |
| 119 | + |
| 120 | + assert genconverter.unstructure(A(10)) == {"a": 20} |
| 121 | + assert genconverter.structure({"a": 20}, A) == A(10) |
| 122 | + |
| 123 | + |
| 124 | +def test_annotated_override_omit_if_default(genconverter: Converter): |
| 125 | + """omit_if_default works in Annotated.""" |
| 126 | + |
| 127 | + @define |
| 128 | + class A: |
| 129 | + a: Annotated[int, override(omit_if_default=True)] = 0 |
| 130 | + b: int = 1 |
| 131 | + |
| 132 | + # a matches default, should be omitted. b matches default but no override, should stay (default behavior is to keep) |
| 133 | + assert genconverter.unstructure(A()) == {"b": 1} |
| 134 | + assert genconverter.unstructure(A(a=1)) == {"a": 1, "b": 1} |
0 commit comments