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
|
# SPDX-License-Identifier: (Apache-2.0 OR MIT)
import abc
import uuid
from dataclasses import InitVar, asdict, dataclass, field
from enum import Enum
from typing import ClassVar, Dict, Optional
import pytest
import orjson
class AnEnum(Enum):
ONE = 1
TWO = 2
@dataclass
class EmptyDataclass:
pass
@dataclass
class EmptyDataclassSlots:
__slots__ = ()
@dataclass
class Dataclass1:
name: str
number: int
sub: Optional["Dataclass1"]
@dataclass
class Dataclass2:
name: Optional[str] = field(default="?")
@dataclass
class Dataclass3:
a: str
b: int
c: dict
d: bool
e: float
f: list
g: tuple
@dataclass
class Dataclass4:
a: str = field()
b: int = field(metadata={"unrelated": False})
c: float = 1.1
@dataclass
class Datasubclass(Dataclass1):
additional: bool
@dataclass
class Slotsdataclass:
__slots__ = ("a", "b", "_c", "d")
a: str
b: int
_c: str
d: InitVar[str]
cls_var: ClassVar[str] = "cls"
@dataclass
class Defaultdataclass:
a: uuid.UUID
b: AnEnum
@dataclass
class UnsortedDataclass:
c: int
b: int
a: int
d: Optional[Dict]
@dataclass
class InitDataclass:
a: InitVar[str]
b: InitVar[str]
cls_var: ClassVar[str] = "cls"
ab: str = ""
def __post_init__(self, a: str, b: str):
self._other = 1
self.ab = f"{a} {b}"
class AbstractBase(abc.ABC):
@abc.abstractmethod
def key(self):
raise NotImplementedError
@dataclass(frozen=True)
class ConcreteAbc(AbstractBase):
__slots__ = ("attr",)
attr: float
def key(self):
return "dkjf"
class TestDataclass:
def test_dataclass(self):
"""
dumps() dataclass
"""
obj = Dataclass1("a", 1, None)
assert orjson.dumps(obj) == b'{"name":"a","number":1,"sub":null}'
def test_dataclass_recursive(self):
"""
dumps() dataclass recursive
"""
obj = Dataclass1("a", 1, Dataclass1("b", 2, None))
assert (
orjson.dumps(obj)
== b'{"name":"a","number":1,"sub":{"name":"b","number":2,"sub":null}}'
)
def test_dataclass_circular(self):
"""
dumps() dataclass circular
"""
obj1 = Dataclass1("a", 1, None)
obj2 = Dataclass1("b", 2, obj1)
obj1.sub = obj2
with pytest.raises(orjson.JSONEncodeError):
orjson.dumps(obj1)
def test_dataclass_empty(self):
"""
dumps() no attributes
"""
assert orjson.dumps(EmptyDataclass()) == b"{}"
def test_dataclass_empty_slots(self):
"""
dumps() no attributes slots
"""
assert orjson.dumps(EmptyDataclassSlots()) == b"{}"
def test_dataclass_default_arg(self):
"""
dumps() dataclass default arg
"""
obj = Dataclass2()
assert orjson.dumps(obj) == b'{"name":"?"}'
def test_dataclass_types(self):
"""
dumps() dataclass types
"""
obj = Dataclass3("a", 1, {"a": "b"}, True, 1.1, [1, 2], (3, 4))
assert (
orjson.dumps(obj)
== b'{"a":"a","b":1,"c":{"a":"b"},"d":true,"e":1.1,"f":[1,2],"g":[3,4]}'
)
def test_dataclass_metadata(self):
"""
dumps() dataclass metadata
"""
obj = Dataclass4("a", 1, 2.1)
assert orjson.dumps(obj) == b'{"a":"a","b":1,"c":2.1}'
def test_dataclass_classvar(self):
"""
dumps() dataclass class variable
"""
obj = Dataclass4("a", 1)
assert orjson.dumps(obj) == b'{"a":"a","b":1,"c":1.1}'
def test_dataclass_subclass(self):
"""
dumps() dataclass subclass
"""
obj = Datasubclass("a", 1, None, False)
assert (
orjson.dumps(obj)
== b'{"name":"a","number":1,"sub":null,"additional":false}'
)
def test_dataclass_slots(self):
"""
dumps() dataclass with __slots__ does not include under attributes, InitVar, or ClassVar
"""
obj = Slotsdataclass("a", 1, "c", "d")
assert "__dict__" not in dir(obj)
assert orjson.dumps(obj) == b'{"a":"a","b":1}'
def test_dataclass_default(self):
"""
dumps() dataclass with default
"""
def default(__obj):
if isinstance(__obj, uuid.UUID):
return str(__obj)
elif isinstance(__obj, Enum):
return __obj.value
obj = Defaultdataclass(
uuid.UUID("808989c0-00d5-48a8-b5c4-c804bf9032f2"), AnEnum.ONE
)
assert (
orjson.dumps(obj, default=default)
== b'{"a":"808989c0-00d5-48a8-b5c4-c804bf9032f2","b":1}'
)
def test_dataclass_sort(self):
"""
OPT_SORT_KEYS has no effect on dataclasses
"""
obj = UnsortedDataclass(1, 2, 3, None)
assert (
orjson.dumps(obj, option=orjson.OPT_SORT_KEYS)
== b'{"c":1,"b":2,"a":3,"d":null}'
)
def test_dataclass_sort_sub(self):
"""
dataclass fast path does not prevent OPT_SORT_KEYS from cascading
"""
obj = UnsortedDataclass(1, 2, 3, {"f": 2, "e": 1})
assert (
orjson.dumps(obj, option=orjson.OPT_SORT_KEYS)
== b'{"c":1,"b":2,"a":3,"d":{"e":1,"f":2}}'
)
def test_dataclass_under(self):
"""
dumps() does not include under attributes, InitVar, or ClassVar
"""
obj = InitDataclass("zxc", "vbn")
assert orjson.dumps(obj) == b'{"ab":"zxc vbn"}'
def test_dataclass_option(self):
"""
dumps() accepts deprecated OPT_SERIALIZE_DATACLASS
"""
obj = Dataclass1("a", 1, None)
assert (
orjson.dumps(obj, option=orjson.OPT_SERIALIZE_DATACLASS)
== b'{"name":"a","number":1,"sub":null}'
)
class TestDataclassPassthrough:
def test_dataclass_passthrough_raise(self):
"""
dumps() dataclass passes to default with OPT_PASSTHROUGH_DATACLASS
"""
obj = Dataclass1("a", 1, None)
with pytest.raises(orjson.JSONEncodeError):
orjson.dumps(obj, option=orjson.OPT_PASSTHROUGH_DATACLASS)
with pytest.raises(orjson.JSONEncodeError):
orjson.dumps(
InitDataclass("zxc", "vbn"), option=orjson.OPT_PASSTHROUGH_DATACLASS
)
def test_dataclass_passthrough_default(self):
"""
dumps() dataclass passes to default with OPT_PASSTHROUGH_DATACLASS
"""
obj = Dataclass1("a", 1, None)
assert (
orjson.dumps(obj, option=orjson.OPT_PASSTHROUGH_DATACLASS, default=asdict)
== b'{"name":"a","number":1,"sub":null}'
)
def default(obj):
if isinstance(obj, Dataclass1):
return {"name": obj.name, "number": obj.number}
raise TypeError
assert (
orjson.dumps(obj, option=orjson.OPT_PASSTHROUGH_DATACLASS, default=default)
== b'{"name":"a","number":1}'
)
class TestAbstractDataclass:
def test_dataclass_abc(self):
obj = ConcreteAbc(1.0)
assert orjson.dumps(obj) == b'{"attr":1.0}'
|