File: test_self.py

package info (click to toggle)
python-cattrs 25.3.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,812 kB
  • sloc: python: 12,236; makefile: 155
file content (145 lines) | stat: -rw-r--r-- 3,961 bytes parent folder | download
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
"""Tests for `typing.Self`."""

from dataclasses import dataclass
from typing import NamedTuple, Optional, TypedDict

from attrs import define
from typing_extensions import Self

from cattrs import Converter
from cattrs.cols import (
    namedtuple_dict_structure_factory,
    namedtuple_dict_unstructure_factory,
)


@define
class WithSelf:
    myself: Optional[Self]
    myself_with_default: Optional[Self] = None


@define
class WithSelfSubclass(WithSelf):
    pass


@dataclass
class WithSelfDataclass:
    myself: Optional[Self]


@dataclass
class WithSelfDataclassSubclass(WithSelfDataclass):
    pass


@define
class WithListOfSelf:
    myself: Optional[Self]
    selves: list[WithSelf]


class WithSelfTypedDict(TypedDict):
    field: int
    myself: Optional[Self]


class WithSelfNamedTuple(NamedTuple):
    myself: Optional[Self]


def test_self_roundtrip(genconverter):
    """A simple roundtrip works."""
    initial = WithSelf(WithSelf(None, WithSelf(None)))
    raw = genconverter.unstructure(initial)

    assert raw == {
        "myself": {
            "myself": None,
            "myself_with_default": {"myself": None, "myself_with_default": None},
        },
        "myself_with_default": None,
    }

    assert genconverter.structure(raw, WithSelf) == initial


def test_self_roundtrip_dataclass(genconverter):
    """A simple roundtrip works for dataclasses."""
    initial = WithSelfDataclass(WithSelfDataclass(None))
    raw = genconverter.unstructure(initial)

    assert raw == {"myself": {"myself": None}}

    assert genconverter.structure(raw, WithSelfDataclass) == initial


def test_self_roundtrip_typeddict(genconverter):
    """A simple roundtrip works for TypedDicts."""
    genconverter.register_unstructure_hook(int, str)

    initial: WithSelfTypedDict = {"field": 1, "myself": {"field": 2, "myself": None}}
    raw = genconverter.unstructure(initial)

    assert raw == {"field": "1", "myself": {"field": "2", "myself": None}}

    assert genconverter.structure(raw, WithSelfTypedDict) == initial


def test_self_roundtrip_namedtuple(genconverter):
    """A simple roundtrip works for NamedTuples."""
    genconverter.register_unstructure_hook_factory(
        lambda t: t is WithSelfNamedTuple, namedtuple_dict_unstructure_factory
    )
    genconverter.register_structure_hook_factory(
        lambda t: t is WithSelfNamedTuple, namedtuple_dict_structure_factory
    )

    initial = WithSelfNamedTuple(WithSelfNamedTuple(None))
    raw = genconverter.unstructure(initial)

    assert raw == {"myself": {"myself": None}}

    assert genconverter.structure(raw, WithSelfNamedTuple) == initial


def test_subclass_roundtrip(genconverter):
    """A simple roundtrip works for a dataclass subclass."""
    initial = WithSelfSubclass(WithSelfSubclass(None))
    raw = genconverter.unstructure(initial)

    assert raw == {
        "myself": {"myself": None, "myself_with_default": None},
        "myself_with_default": None,
    }

    assert genconverter.structure(raw, WithSelfSubclass) == initial


def test_subclass_roundtrip_dataclass(genconverter):
    """A simple roundtrip works for a dataclass subclass."""
    initial = WithSelfDataclassSubclass(WithSelfDataclassSubclass(None))
    raw = genconverter.unstructure(initial)

    assert raw == {"myself": {"myself": None}}

    assert genconverter.structure(raw, WithSelfDataclassSubclass) == initial


def test_nested_roundtrip(genconverter: Converter):
    """A more complex roundtrip, with several Self classes."""
    initial = WithListOfSelf(WithListOfSelf(None, []), [WithSelf(WithSelf(None))])
    raw = genconverter.unstructure(initial)

    assert raw == {
        "myself": {"myself": None, "selves": []},
        "selves": [
            {
                "myself": {"myself": None, "myself_with_default": None},
                "myself_with_default": None,
            }
        ],
    }

    assert genconverter.structure(raw, WithListOfSelf) == initial