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 | """Marshmallow Enum Fields."""
from enum import Enum
from types import MappingProxyType
from typing import Any
from caseconverter import snakecase, titlecase
from loguru import logger
from marshmallow import fields
from typing_extensions import override
from comicbox.enums.comicbox import ReadingDirectionEnum
from comicbox.enums.comicinfo import ComicInfoPageTypeEnum
from comicbox.enums.maps.age_rating import AGE_RATING_ENUM_MAP
from comicbox.enums.maps.formats import GENERIC_FORMAT_MAP
from comicbox.enums.maps.reading_direction import READING_DIRECTION_ENUM_MAP
from comicbox.fields.fields import StringField, TrapExceptionsMeta
class FuzzyEnumMixin:
"""Fuzzy lookup get_enum() method that allows caseless enum lookups with variations."""
ENUM_ALIAS_MAP = MappingProxyType({})
@staticmethod
def get_key_variations(key: str | Enum) -> set[str]:
"""Get enum caseless slightly fuzzy lookup key variations for a key."""
new_key = key.value if isinstance(key, Enum) else key
new_key = new_key.lower()
key_variations = {new_key}
key_variations.add(new_key.replace(" ", ""))
space_case = snakecase(new_key).replace("_", "")
key_variations.add(space_case)
return key_variations
@classmethod
def add_enum_map_item(cls, key: str | Enum, enum: Enum, enum_map: dict) -> None:
"""Add an enum or string to the lookup table with lowercase spaceless and spaced variations."""
key_variations = cls.get_key_variations(key)
for key_variation in key_variations:
enum_map[key_variation] = enum
def get_enum_alias_map(self) -> dict:
"""Transform the ENUM_ALIAS_MAP into the enum lookup map."""
enum_map = {}
for key, enum in self.ENUM_ALIAS_MAP.items():
self.add_enum_map_item(key, enum, enum_map)
return enum_map
def get_enum(self, value: str | Enum) -> Enum | None:
"""Get an enum from the fuzzy lookup map."""
key: str = value.value if isinstance(value, Enum) else str(value)
key = key.lower()
return self._enum_map.get(key) # pyright: ignore[reportAttributeAccessIssue], # ty: ignore[unresolved-attribute]
class EnumField(FuzzyEnumMixin, fields.Enum, metaclass=TrapExceptionsMeta):
"""Fuzzy lookup Enum field that allows caseless enum lookups with variations."""
ENUM = Enum
def get_enum_map(self) -> dict:
"""Transform the ENUM_ALIAS_MAP into the enum lookup map and add the field enum to it as well."""
enum_map = self.get_enum_alias_map()
for enum in self.ENUM:
self.add_enum_map_item(enum, enum, enum_map)
return enum_map
def __init__(self, *args: Any, **kwargs: Any) -> None:
"""Use the enum."""
super().__init__(self.ENUM, *args, by_value=StringField, **kwargs)
enum_map = self.get_enum_map()
self._enum_map = MappingProxyType(enum_map)
@override
def _deserialize(
self,
value: Enum | str,
attr: str,
data: dict[str, Any],
*args: Any,
**kwargs: Any,
) -> Enum:
enum = self.get_enum(value)
enum = enum or value
return super()._deserialize(enum, attr, data, *args, **kwargs)
@override
def _serialize(
self, value: Enum | Any | None, *args: Any, **kwargs: Any
) -> str | None:
if value is None:
return None
enum = self.get_enum(value)
enum = enum or value
return super()._serialize(enum, *args, **kwargs)
class PageTypeField(EnumField):
"""ComicPageInfo Page Type Field."""
ENUM = ComicInfoPageTypeEnum # pyright: ignore[reportIncompatibleUnannotatedOverride]
class ReadingDirectionField(EnumField):
"""Reading direction enum."""
ENUM = ReadingDirectionEnum # pyright: ignore[reportIncompatibleUnannotatedOverride]
ENUM_ALIAS_MAP = READING_DIRECTION_ENUM_MAP
class EnumBooleanField(EnumField):
"""An Enum Field that also accepts boolean values."""
YES = "Yes"
TRUTHY = frozenset(
{
"1",
"true",
"yes",
}
)
@override
def _deserialize(self, value: Enum | str | bool, attr, data, *args, **kwargs):
if not isinstance(value, self.ENUM):
if value is True or (str(value).lower() in self.TRUTHY):
value = self.YES
else:
value = str(value)
return super()._deserialize(value, attr, data, *args, **kwargs)
@override
def _serialize(self, value, *args, **kwargs) -> str | None:
result = super()._serialize(value, *args, **kwargs)
if not isinstance(result, self.ENUM) and value in self.TRUTHY:
result = super()._serialize(self.YES, *args, **kwargs)
return result
class ComicInfoMangaEnum(Enum):
"""Manga enum for ComicInfo."""
YES_RTL = "YesAndRightToLeft"
NO = "No"
class ComicInfoMangaField(EnumBooleanField):
"""Manga field from ComicInfo."""
ENUM = ComicInfoMangaEnum # pyright: ignore[reportIncompatibleUnannotatedOverride]
@override
def _deserialize(self, value, attr, data, *args, **kwargs):
"""Match a manga value to an acceptable value."""
if data and data.get("reading_direction") == ReadingDirectionEnum.RTL:
reason = (
f"Coerced manga {value} to {ComicInfoMangaEnum.YES_RTL.value}"
"because of reading_direction"
)
logger.warning(reason)
value = ComicInfoMangaEnum.YES_RTL
return super()._deserialize(value, attr, data, *args, **kwargs)
class YesNoEnum(Enum):
"""Yes No Enum."""
NO = "No"
UNKNOWN = "Unknown"
class YesNoField(EnumBooleanField):
"""A yes no kind of boolean field."""
ENUM = YesNoEnum # pyright: ignore[reportIncompatibleUnannotatedOverride]
class PrettifiedStringField(FuzzyEnumMixin, StringField):
"""A string fields that tries to match to an enum and falls back to just titlecasing."""
ENUM_ALIAS_MAP = MappingProxyType({})
def __init__(self, *args: Any, **kwargs: Any) -> None:
"""Use the enum."""
super().__init__(*args, **kwargs)
self._enum_map = MappingProxyType(self.get_enum_alias_map())
def _prettify(self, value: str) -> str:
"""Conform a value to a known enum or titlecase."""
enum = self.get_enum(value)
if enum:
value = enum.value
else:
value = titlecase(value)
value = value.replace(" ", " ")
return value
@override
def _deserialize(self, value: Enum | str, *args: Any, **kwargs: Any) -> str:
str_value: str = value.value if isinstance(value, Enum) else value
str_value = super()._deserialize(str_value, *args, **kwargs)
return self._prettify(str_value)
class OriginalFormatField(PrettifiedStringField):
"""Prettify Original Format."""
ENUM_ALIAS_MAP = GENERIC_FORMAT_MAP
class AgeRatingField(PrettifiedStringField):
"""Prettified Age Rating."""
ENUM_ALIAS_MAP = AGE_RATING_ENUM_MAP
|