/
fields.py
378 lines (297 loc) · 9.92 KB
/
fields.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
import asyncio
from collections import OrderedDict
from enum import Enum
from typing import (
Dict,
Generic,
TypeVar,
Union,
Type,
List,
Optional,
Any,
TYPE_CHECKING,
)
from typing import OrderedDict as OrderedDictType
from bson import ObjectId, DBRef
from bson.errors import InvalidId
from pydantic import BaseModel, parse_obj_as
from pydantic.fields import ModelField
from pydantic.json import ENCODERS_BY_TYPE
from pymongo import ASCENDING
from beanie.odm.enums import SortDirection
from beanie.odm.operators.find.comparison import (
Eq,
GT,
GTE,
LT,
LTE,
NE,
In,
)
from beanie.odm.utils.parsing import parse_obj
from pymongo import IndexModel
if TYPE_CHECKING:
from beanie.odm.documents import DocType
def Indexed(typ, index_type=ASCENDING, **kwargs):
"""
Returns a subclass of `typ` with an extra attribute `_indexed` as a tuple:
- Index 0: `index_type` such as `pymongo.ASCENDING`
- Index 1: `kwargs` passed to `IndexModel`
When instantiated the type of the result will actually be `typ`.
"""
class NewType(typ):
_indexed = (index_type, kwargs)
def __new__(cls, *args, **kwargs):
return typ.__new__(typ, *args, **kwargs)
NewType.__name__ = f"Indexed {typ.__name__}"
return NewType
class PydanticObjectId(ObjectId):
"""
Object Id field. Compatible with Pydantic.
"""
@classmethod
def __get_validators__(cls):
yield cls.validate
@classmethod
def validate(cls, v):
if isinstance(v, bytes):
v = v.decode("utf-8")
try:
return PydanticObjectId(v)
except InvalidId:
raise TypeError("Id must be of type PydanticObjectId")
@classmethod
def __modify_schema__(cls, field_schema):
field_schema.update(
type="string",
examples=["5eb7cf5a86d9755df3a6c593", "5eb7cfb05e32e07750a1756a"],
)
ENCODERS_BY_TYPE[
PydanticObjectId
] = str # it is a workaround to force pydantic make json schema for this field
class ExpressionField(str):
def __getitem__(self, item):
"""
Get sub field
:param item: name of the subfield
:return: ExpressionField
"""
return ExpressionField(f"{self}.{item}")
def __getattr__(self, item):
"""
Get sub field
:param item: name of the subfield
:return: ExpressionField
"""
return ExpressionField(f"{self}.{item}")
def __hash__(self):
return hash(str(self))
def __eq__(self, other):
if isinstance(other, ExpressionField):
return super(ExpressionField, self).__eq__(other)
return Eq(field=self, other=other)
def __gt__(self, other):
return GT(field=self, other=other)
def __ge__(self, other):
return GTE(field=self, other=other)
def __lt__(self, other):
return LT(field=self, other=other)
def __le__(self, other):
return LTE(field=self, other=other)
def __ne__(self, other):
return NE(field=self, other=other)
def __pos__(self):
return self, SortDirection.ASCENDING
def __neg__(self):
return self, SortDirection.DESCENDING
def __copy__(self):
return self
def __deepcopy__(self, memo):
return self
class DeleteRules(str, Enum):
DO_NOTHING = "DO_NOTHING"
DELETE_LINKS = "DELETE_LINKS"
class WriteRules(str, Enum):
DO_NOTHING = "DO_NOTHING"
WRITE = "WRITE"
class LinkTypes(str, Enum):
DIRECT = "DIRECT"
OPTIONAL_DIRECT = "OPTIONAL_DIRECT"
LIST = "LIST"
OPTIONAL_LIST = "OPTIONAL_LIST"
BACK_DIRECT = "BACK_DIRECT"
BACK_LIST = "BACK_LIST"
OPTIONAL_BACK_DIRECT = "OPTIONAL_BACK_DIRECT"
OPTIONAL_BACK_LIST = "OPTIONAL_BACK_LIST"
class LinkInfo(BaseModel):
field_name: str
lookup_field_name: str
model_class: Type[BaseModel] # Document class
link_type: LinkTypes
nested_links: Optional[Dict]
T = TypeVar("T")
class Link(Generic[T]):
def __init__(self, ref: DBRef, model_class: Type[T]):
self.ref = ref
self.model_class = model_class
async def fetch(self, fetch_links: bool = False) -> Union[T, "Link"]:
result = await self.model_class.get( # type: ignore
self.ref.id, with_children=True, fetch_links=fetch_links
)
return result or self
@classmethod
async def fetch_one(cls, link: "Link"):
return await link.fetch()
@classmethod
async def fetch_list(
cls, links: List[Union["Link", "DocType"]], fetch_links: bool = False
):
"""
Fetch list that contains links and documents
:param links:
:param fetch_links:
:return:
"""
data = Link.repack_links(links) # type: ignore
ids_to_fetch = []
model_class = None
for doc_id, link in data.items():
if isinstance(link, Link):
if model_class is None:
model_class = link.model_class
else:
if model_class != link.model_class:
raise ValueError(
"All the links must have the same model class"
)
ids_to_fetch.append(link.ref.id)
fetched_models = await model_class.find( # type: ignore
In("_id", ids_to_fetch),
with_children=True,
fetch_links=fetch_links,
).to_list()
for model in fetched_models:
data[model.id] = model
return list(data.values())
@staticmethod
def repack_links(
links: List[Union["Link", "DocType"]]
) -> OrderedDictType[Any, Any]:
result = OrderedDict()
for link in links:
if isinstance(link, Link):
result[link.ref.id] = link
else:
result[link.id] = link
return result
@classmethod
async def fetch_many(cls, links: List["Link"]):
coros = []
for link in links:
coros.append(link.fetch())
return await asyncio.gather(*coros)
@classmethod
def __get_validators__(cls):
yield cls.validate
@classmethod
def validate(cls, v: Union[DBRef, T], field: ModelField):
model_class = field.sub_fields[0].type_ # type: ignore
if isinstance(v, DBRef):
return cls(ref=v, model_class=model_class)
if isinstance(v, Link):
return v
if isinstance(v, dict) or isinstance(v, BaseModel):
return parse_obj(model_class, v)
new_id = parse_obj_as(model_class.__fields__["id"].type_, v)
ref = DBRef(collection=model_class.get_collection_name(), id=new_id)
return cls(ref=ref, model_class=model_class)
def to_ref(self):
return self.ref
def to_dict(self):
return {"id": str(self.ref.id), "collection": self.ref.collection}
ENCODERS_BY_TYPE[Link] = lambda o: o.to_dict()
class BackLink(Generic[T]):
"""Back reference to a document"""
def __init__(self, model_class: Type[T]):
self.model_class = model_class
@classmethod
def __get_validators__(cls):
yield cls.validate
@classmethod
def validate(cls, v: Union[DBRef, T], field: ModelField):
model_class = field.sub_fields[0].type_ # type: ignore
if isinstance(v, dict) or isinstance(v, BaseModel):
return parse_obj(model_class, v)
return cls(model_class=model_class)
def to_dict(self):
return {"collection": self.model_class.get_collection_name()}
ENCODERS_BY_TYPE[BackLink] = lambda o: o.to_dict()
class IndexModelField:
def __init__(self, index: IndexModel):
self.index = index
self.name = index.document["name"]
self.fields = tuple(sorted(self.index.document["key"]))
self.options = tuple(
sorted(
(k, v)
for k, v in self.index.document.items()
if k not in ["key", "v"]
)
)
def __eq__(self, other):
return self.fields == other.fields and self.options == other.options
def __repr__(self):
return f"IndexModelField({self.name}, {self.fields}, {self.options})"
@classmethod
def __get_validators__(cls):
yield cls.validate
@classmethod
def validate(cls, v):
if isinstance(v, IndexModel):
return IndexModelField(v)
else:
return IndexModelField(IndexModel(v))
@staticmethod
def list_difference(
left: List["IndexModelField"], right: List["IndexModelField"]
):
result = []
for index in left:
if index not in right:
result.append(index)
return result
@staticmethod
def list_to_index_model(left: List["IndexModelField"]):
return [index.index for index in left]
@classmethod
def from_motor_index_information(cls, index_info: dict):
result = []
for name, details in index_info.items():
fields = details["key"]
if ("_id", 1) in fields:
continue
options = {k: v for k, v in details.items() if k != "key"}
index_model = IndexModelField(
IndexModel(fields, name=name, **options)
)
result.append(index_model)
return result
def same_fields(self, other: "IndexModelField"):
return self.fields == other.fields
@staticmethod
def find_index_with_the_same_fields(
indexes: List["IndexModelField"], index: "IndexModelField"
):
for i in indexes:
if i.same_fields(index):
return i
return None
@staticmethod
def merge_indexes(
left: List["IndexModelField"], right: List["IndexModelField"]
):
left_dict = {index.fields: index for index in left}
right_dict = {index.fields: index for index in right}
left_dict.update(right_dict)
return list(left_dict.values())