/
encoder.py
535 lines (414 loc) · 17.6 KB
/
encoder.py
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
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
from __future__ import annotations
import collections
import datetime
import decimal
import re
import sys
import typing
from abc import abstractmethod
from base64 import b64encode
from enum import Enum
from functools import lru_cache
from inspect import isclass
from ipaddress import IPv4Address, IPv6Address
from pathlib import Path, PosixPath, PurePath, PurePosixPath, PureWindowsPath, WindowsPath
from typing import Any, Callable, Dict, Generic, List, Pattern, Protocol, Tuple, Type, TypeVar, Union, final
from uuid import UUID
from chili.typing import (
_ENCODABLE,
_ENCODE_MAPPER,
_PROPERTIES,
UNDEFINED,
Optional,
TypeSchema,
create_schema,
get_origin_type,
get_parameters_map,
get_type_args,
is_class,
is_dataclass,
is_enum_type,
is_named_tuple,
is_newtype,
is_optional,
is_typed_dict,
is_user_string,
map_generic_type,
resolve_forward_reference,
unpack_optional,
)
if sys.version_info >= (3, 10):
from types import UnionType
else:
UnionType = None
from .error import EncoderError
from .iso_datetime import timedelta_to_iso_duration
from .mapper import Mapper
from .state import StateObject
C = TypeVar("C")
U = TypeVar("U")
T = TypeVar("T")
E = TypeVar("E", bound=Enum)
class TypeEncoder(Protocol):
@abstractmethod
def encode(self, value):
...
@final
class SimpleEncoder(TypeEncoder, Generic[T]):
def __init__(self, func: Callable[[Any], T]):
self._encoder = func
def encode(self, value: Any) -> T:
return self._encoder(value)
@final
class ProxyEncoder(Generic[T]):
def __init__(self, type_annotation: Any) -> None:
self._encoder = build_type_encoder(type_annotation)
def decode(self, value: Any) -> T:
return self._encoder.encode(value)
def encode_regex_to_string(value: Pattern) -> str:
"""
Encodes regex into string and preserves flags if they are set. Then regex is normally wrapped between slashes.
"""
flags = []
if re.I & value.flags:
flags.append("i")
if re.M & value.flags:
flags.append("m")
if re.S & value.flags:
flags.append("s")
if re.X & value.flags:
flags.append("x")
if flags:
return f"/{value.pattern}/{''.join(flags)}"
return value.pattern
def encodable(_cls=None, mapper: Optional[Mapper] = None) -> Any:
def _decorate(cls) -> Type[C]:
# Attach schema to make the class encodable
if not hasattr(cls, _PROPERTIES):
setattr(cls, _PROPERTIES, create_schema(cls))
if mapper:
setattr(cls, _ENCODE_MAPPER, mapper)
inner_classes = [
icls
for icls in cls.__dict__.values()
if isclass(icls) and icls.__module__ == cls.__module__ and not hasattr(icls, _PROPERTIES)
]
for inner_class in inner_classes:
_decorate(inner_class)
setattr(cls, _ENCODABLE, True)
return cls
if _cls is None:
return _decorate
return _decorate(_cls)
class TypeEncoders(Dict[Any, TypeEncoder]):
def __hash__(self) -> int: # type: ignore[override]
return hash(tuple(sorted([str(key) for key in self.keys()])))
def ordered_dict(value: collections.OrderedDict) -> List[List[Any]]:
result = []
for i_key, i_value in value.items():
result.append([i_key, i_value])
return result
_builtin_type_encoders = TypeEncoders(
{
bool: SimpleEncoder[bool](bool),
int: SimpleEncoder[int](int),
float: SimpleEncoder[float](float),
str: SimpleEncoder[str](str),
bytes: SimpleEncoder[str](lambda value: b64encode(value).decode("utf8")),
bytearray: SimpleEncoder[str](lambda value: b64encode(value).decode("utf8")),
list: SimpleEncoder[list](list),
set: SimpleEncoder[list](list),
frozenset: SimpleEncoder[list](list),
tuple: SimpleEncoder[list](list),
dict: SimpleEncoder[dict](dict),
collections.OrderedDict: SimpleEncoder[list](ordered_dict),
collections.deque: SimpleEncoder[list](list),
typing.TypedDict: SimpleEncoder[dict](dict), # type: ignore
typing.Dict: SimpleEncoder[dict](dict),
typing.List: SimpleEncoder[list](list),
typing.Sequence: SimpleEncoder[list](list),
typing.Tuple: SimpleEncoder[list](list), # type: ignore
typing.Set: SimpleEncoder[list](list),
typing.FrozenSet: SimpleEncoder[list](list),
typing.Deque: SimpleEncoder[list](list),
typing.AnyStr: SimpleEncoder[str](str), # type: ignore
decimal.Decimal: SimpleEncoder[str](str),
datetime.time: SimpleEncoder[str](lambda value: value.isoformat()),
datetime.date: SimpleEncoder[str](lambda value: value.isoformat()),
datetime.datetime: SimpleEncoder[str](lambda value: value.isoformat()),
datetime.timedelta: SimpleEncoder[str](timedelta_to_iso_duration),
PurePath: SimpleEncoder[str](str),
PureWindowsPath: SimpleEncoder[str](str),
PurePosixPath: SimpleEncoder[str](str),
Path: SimpleEncoder[str](str),
PosixPath: SimpleEncoder[str](str),
WindowsPath: SimpleEncoder[str](str),
Pattern: SimpleEncoder[str](encode_regex_to_string),
re.Pattern: SimpleEncoder[str](encode_regex_to_string),
IPv6Address: SimpleEncoder[str](str),
IPv4Address: SimpleEncoder[str](str),
UUID: SimpleEncoder[str](str),
}
)
class ListEncoder(TypeEncoder):
def __init__(self, item_encoder: TypeEncoder):
self.item_encoder = item_encoder
def encode(self, value: typing.List) -> list:
return [self.item_encoder.encode(item) for item in value]
class TupleEncoder(TypeEncoder):
def __init__(self, items_encoder: List[Union[TypeEncoder, Any]]):
self.items_encoder = items_encoder
self._variadic = items_encoder[-1] is Ellipsis
def encode(self, value: Tuple) -> List:
if self._variadic:
return self._encode_variadic(value)
return self._encode_static(value)
def _encode_variadic(self, value: Tuple) -> List:
result = []
type_encoders = self.items_encoder[:-1]
num_encoders = len(type_encoders)
for index, item in enumerate(value):
encoder = type_encoders[min(index, num_encoders - 1)]
result.append(encoder.encode(item))
return result
def _encode_static(self, value: Tuple) -> List:
result = [encoder.encode(value[index]) for index, encoder in enumerate(self.items_encoder)]
return result
class DictEncoder(TypeEncoder):
def __init__(self, encoders: List[TypeEncoder]):
self.key_encoder, self.value_encoder = encoders
def encode(self, value: dict) -> dict:
return {self.key_encoder.encode(i_key): self.value_encoder.encode(i_value) for i_key, i_value in value.items()}
class OrderedDictEncoder(TypeEncoder):
def __init__(self, encoders: List[TypeEncoder]):
self.key_encoder, self.value_encoder = encoders
def encode(self, value: dict) -> list:
return [
[self.key_encoder.encode(i_key), self.value_encoder.encode(i_value)] for i_key, i_value in value.items()
]
class ClassEncoder(TypeEncoder):
_fields: Dict[str, TypeEncoder]
_schema: TypeSchema
def __init__(self, class_name: Type, extra_encoders: TypeEncoders = None, force: bool = False):
self.class_name = class_name
self._extra_encoders = extra_encoders
self._schema = create_schema(class_name) # type: ignore
self.force = force
def encode(self, value: Any) -> StateObject:
if not isinstance(value, self.class_name):
raise EncoderError.invalid_input
if not hasattr(self, "_fields"):
self._fields = self._build()
result = {}
for name, field in self._schema.items():
prop_value = self._fields[name].encode(getattr(value, name, field.default_value))
if prop_value is not UNDEFINED:
result[name] = prop_value
return result
def _build(self) -> Dict[str, TypeEncoder]:
return {name: self._build_type_encoder(field.type) for name, field in self._schema.items()}
def _build_type_encoder(self, a_type: Type) -> TypeEncoder:
return build_type_encoder(a_type, self._extra_encoders, self.class_name.__module__, self.force) # type: ignore
class GenericClassEncoder(ClassEncoder):
def __init__(self, class_name: Type, extra_encoders: TypeEncoders = None, force: bool = False):
self._generic_type = class_name
self._extra_encoders = extra_encoders
self._generic_parameters = get_parameters_map(class_name)
self.force = force
type_: Type = get_origin_type(class_name) # type: ignore
super().__init__(type_)
def _build_type_encoder(self, a_type: Type) -> TypeEncoder:
return build_type_encoder(
map_generic_type(a_type, self._generic_parameters),
self._extra_encoders,
self._generic_type.__module__,
self.force
)
class EnumEncoder(TypeEncoder, Generic[E]):
def __init__(self, enum_type: Type):
self.enum_type = enum_type
def encode(self, value: E) -> Any:
if not isinstance(value, self.enum_type):
raise EncoderError.invalid_input
return value.value
class NamedTupleEncoder(TypeEncoder):
def __init__(self, class_name: Type, extra_encoders: TypeEncoders = None, force: bool = False):
self.type = class_name
self._is_typed = hasattr(class_name, "__annotations__")
self._arg_encoders: List[TypeEncoder] = []
self._extra_encoders = extra_encoders
self.force = force
if self._is_typed:
self._build()
def encode(self, value: tuple) -> list:
if not self._is_typed:
return list(value)
return [
self._arg_encoders[index].encode(item) if index < len(self._arg_encoders) else item
for index, item in enumerate(value)
]
def _build(self) -> None:
field_types = self.type.__annotations__
for item_type in field_types.values():
self._arg_encoders.append(build_type_encoder(item_type, self._extra_encoders, self.type.__module__, self.force))
class TypedDictEncoder(TypeEncoder):
def __init__(self, class_name: Type, extra_encoders: TypeEncoders = None, force: bool = False):
self.type = class_name
self._key_encoders = {}
self.force = force
for key_name, key_type in class_name.__annotations__.items():
self._key_encoders[key_name] = build_type_encoder(key_type, extra_encoders, class_name.__module__, self.force)
def encode(self, value: dict) -> dict:
return {key: self._key_encoders[key].encode(item) for key, item in value.items()}
class OptionalTypeEncoder(TypeEncoder):
def __init__(self, type_encoder: TypeEncoder):
self._encoder = type_encoder
def encode(self, value: Any) -> Any:
if value is None:
return None
return self._encoder.encode(value)
class UnionEncoder(TypeEncoder):
def __init__(self, supported_types: List[Type], extra_encoders: TypeEncoders = None, force: bool = False):
self.supported_types = supported_types
self._extra_encoders = extra_encoders
self.force = force
def encode(self, value: Any) -> Any:
value_type = type(value)
if value_type not in self.supported_types:
raise EncoderError.invalid_input
return build_type_encoder(value_type, self._extra_encoders, force=self.force).encode(value) # type: ignore
_supported_generics = {
list: ListEncoder,
tuple: TupleEncoder,
dict: DictEncoder,
set: ListEncoder,
frozenset: ListEncoder,
collections.deque: ListEncoder,
collections.OrderedDict: OrderedDictEncoder,
}
@lru_cache(maxsize=None)
def build_type_encoder(
a_type: Type, extra_encoders: TypeEncoders = None, module: Any = None, force: bool = False
) -> TypeEncoder:
if extra_encoders and a_type in extra_encoders:
return extra_encoders[a_type]
if a_type in _builtin_type_encoders:
return _builtin_type_encoders[a_type]
origin_type = get_origin_type(a_type)
if origin_type is None and is_dataclass(a_type):
if issubclass(a_type, Generic): # type: ignore
raise EncoderError.invalid_type
return ClassEncoder(a_type, extra_encoders, force)
if origin_type and is_dataclass(origin_type):
if issubclass(origin_type, Generic): # type: ignore
return GenericClassEncoder(a_type)
return ClassEncoder(a_type, extra_encoders, force)
if origin_type is None:
origin_type = a_type
if is_class(origin_type) and is_enum_type(origin_type):
return EnumEncoder(origin_type)
if is_class(origin_type) and is_named_tuple(origin_type):
return NamedTupleEncoder(origin_type, extra_encoders, force)
if is_class(origin_type) and is_typed_dict(origin_type):
return TypedDictEncoder(origin_type, extra_encoders, force)
if is_class(origin_type) and is_user_string(origin_type):
return SimpleEncoder[str](str)
if origin_type is Union or (UnionType and isinstance(origin_type, UnionType)):
type_args = get_type_args(a_type)
if len(type_args) == 2 and type_args[-1] is type(None):
return OptionalTypeEncoder(build_type_encoder(type_args[0], extra_encoders, module, force)) # type: ignore
return UnionEncoder(type_args, extra_encoders, force=force)
if isinstance(a_type, typing.ForwardRef) and module is not None:
resolved_reference = resolve_forward_reference(module, a_type)
if resolved_reference is not None:
return Encoder[resolved_reference](encoders=extra_encoders) # type: ignore[valid-type]
if typing.get_origin(origin_type) is not None:
raise EncoderError.invalid_type(a_type)
if hasattr(origin_type, _PROPERTIES):
if origin_type != a_type:
return GenericClassEncoder(a_type)
return Encoder[origin_type](encoders=extra_encoders) # type: ignore[valid-type]
if isinstance(a_type, TypeVar):
if a_type.__bound__ is None:
raise EncoderError.invalid_type(a_type)
return build_type_encoder(a_type.__bound__, extra_encoders, module, force)
if is_newtype(a_type):
return build_type_encoder(a_type.__supertype__, extra_encoders, module, force)
if origin_type not in _supported_generics:
if is_class(origin_type) and force:
return Encoder[origin_type](encoders=extra_encoders) # type: ignore[valid-type]
raise EncoderError.invalid_type(type=a_type)
type_attributes: List[TypeEncoder] = [
build_type_encoder(subtype, extra_encoders=extra_encoders, module=module, force=force) # type: ignore
if subtype is not ...
else ... # noqa: E501
for subtype in get_type_args(a_type)
]
if len(type_attributes) == 1:
return _supported_generics[origin_type](type_attributes[0]) # type: ignore
return _supported_generics[origin_type](type_attributes) # type: ignore
class Encoder(Generic[T]):
__generic__: Type[T]
_encoders: Dict[str, TypeEncoder]
def __init__(self, encoders: Union[Dict, TypeEncoders] = None, mapper: Optional[Mapper] = None):
if encoders and not isinstance(encoders, TypeEncoders):
encoders = TypeEncoders(encoders)
self.encode_mapper = mapper
self.type_encoders = encoders
def encode(self, obj: T) -> StateObject:
if not hasattr(self, "_encoders"):
self._encoders = self._build_encoders()
result = {}
for key, prop in self.schema.items():
if hasattr(obj, key):
value = getattr(obj, key)
elif is_optional(prop.type):
value = prop.default_value
else:
continue
result[key] = self._encoders[prop.name].encode(value)
if hasattr(self.__generic__, _ENCODE_MAPPER):
mapper = getattr(self.__generic__, _ENCODE_MAPPER)
return mapper.map(result)
elif self.encode_mapper:
return self.encode_mapper.map(result)
return result
@property
def schema(self) -> TypeSchema:
return getattr(self.__generic__, _PROPERTIES)
def _build_encoders(self) -> Dict[str, TypeEncoder]:
schema: TypeSchema = self.schema
return {
prop.name: build_type_encoder(prop.type, extra_encoders=self.type_encoders, force=True) # type: ignore
for prop in schema.values()
}
@classmethod
def __class_getitem__(cls, item: Any) -> Type[Encoder]: # noqa: E501
if not isclass(item):
raise EncoderError.invalid_generic_type
if is_dataclass(item):
item = encodable(item)
if not hasattr(item, _ENCODABLE):
item = encodable(item)
return type( # type: ignore
f"{cls.__qualname__}[{item.__module__}.{item.__qualname__}]",
tuple([cls]),
{
"__generic__": item,
},
)
def encode(
obj: Any,
type_hint: Type = None,
encoders: Union[TypeEncoders, Dict[Any, TypeEncoder]] = None,
force: bool = False,
) -> StateObject:
if encoders and not isinstance(encoders, TypeEncoders):
encoders = TypeEncoders(encoders)
if type_hint is not None:
encoder = build_type_encoder(type_hint, extra_encoders=encoders, force=force) # type: ignore
else:
encoder = build_type_encoder(type(obj), extra_encoders=encoders, force=force) # type: ignore
if encoder is None:
raise EncoderError.invalid_input
return encoder.encode(obj)