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
|
from abc import abstractmethod
from collections.abc import Iterable
from typing import (
TYPE_CHECKING,
Any,
ClassVar,
Dict,
List,
Mapping,
Optional,
Tuple,
Type,
TypeVar,
Union,
overload,
)
from pydantic import (
BaseModel,
)
from pymongo.asynchronous.client_session import AsyncClientSession
from beanie.odm.enums import SortDirection
from beanie.odm.interfaces.detector import ModelType
from beanie.odm.queries.find import FindMany, FindOne
from beanie.odm.settings.base import ItemSettings
if TYPE_CHECKING:
from beanie.odm.documents import Document
from beanie.odm.union_doc import UnionDoc
from beanie.odm.views import View
DocumentProjectionType = TypeVar("DocumentProjectionType", bound=BaseModel)
FindType = TypeVar("FindType", bound=Union["Document", "UnionDoc", "View"])
class FindInterface:
# Customization
# Query builders could be replaced in the inherited classes
_find_one_query_class: ClassVar[Type] = FindOne
_find_many_query_class: ClassVar[Type] = FindMany
_inheritance_inited: bool = False
_class_id: ClassVar[Optional[str]]
_children: ClassVar[Dict[str, Type]]
@classmethod
@abstractmethod
def get_model_type(cls) -> ModelType:
pass
@classmethod
@abstractmethod
def get_settings(cls) -> ItemSettings:
pass
@overload
@classmethod
def find_one( # type: ignore
cls: Type[FindType],
*args: Union[Mapping[Any, Any], bool],
projection_model: None = None,
session: Optional[AsyncClientSession] = None,
ignore_cache: bool = False,
fetch_links: bool = False,
with_children: bool = False,
nesting_depth: Optional[int] = None,
nesting_depths_per_field: Optional[Dict[str, int]] = None,
**pymongo_kwargs: Any,
) -> FindOne[FindType]: ...
@overload
@classmethod
def find_one( # type: ignore
cls: Type[FindType],
*args: Union[Mapping[Any, Any], bool],
projection_model: Type["DocumentProjectionType"],
session: Optional[AsyncClientSession] = None,
ignore_cache: bool = False,
fetch_links: bool = False,
with_children: bool = False,
nesting_depth: Optional[int] = None,
nesting_depths_per_field: Optional[Dict[str, int]] = None,
**pymongo_kwargs: Any,
) -> FindOne["DocumentProjectionType"]: ...
@classmethod
def find_one( # type: ignore
cls: Type[FindType],
*args: Union[Mapping[Any, Any], bool],
projection_model: Optional[Type["DocumentProjectionType"]] = None,
session: Optional[AsyncClientSession] = None,
ignore_cache: bool = False,
fetch_links: bool = False,
with_children: bool = False,
nesting_depth: Optional[int] = None,
nesting_depths_per_field: Optional[Dict[str, int]] = None,
**pymongo_kwargs: Any,
) -> Union[FindOne[FindType], FindOne["DocumentProjectionType"]]:
"""
Find one document by criteria.
Returns [FindOne](query.md#findone) query object.
When awaited this will either return a document or None if no document exists for the search criteria.
:param args: *Mapping[Any, Any] - search criteria
:param projection_model: Optional[Type[BaseModel]] - projection model
:param session: Optional[AsyncClientSession] - pymongo session.
:param ignore_cache: bool
:param **pymongo_kwargs: pymongo native parameters for find operation (if Document class contains links, this parameter must fit the respective parameter of the aggregate MongoDB function)
:return: [FindOne](query.md#findone) - find query instance
"""
args = cls._add_class_id_filter(args, with_children)
return cls._find_one_query_class(document_model=cls).find_one(
*args,
projection_model=projection_model,
session=session,
ignore_cache=ignore_cache,
fetch_links=fetch_links,
nesting_depth=nesting_depth,
nesting_depths_per_field=nesting_depths_per_field,
**pymongo_kwargs,
)
@overload
@classmethod
def find_many( # type: ignore
cls: Type[FindType],
*args: Union[Mapping[Any, Any], bool],
projection_model: None = None,
skip: Optional[int] = None,
limit: Optional[int] = None,
sort: Union[None, str, List[Tuple[str, SortDirection]]] = None,
session: Optional[AsyncClientSession] = None,
ignore_cache: bool = False,
fetch_links: bool = False,
with_children: bool = False,
lazy_parse: bool = False,
nesting_depth: Optional[int] = None,
nesting_depths_per_field: Optional[Dict[str, int]] = None,
**pymongo_kwargs: Any,
) -> FindMany[FindType]: ...
@overload
@classmethod
def find_many( # type: ignore
cls: Type[FindType],
*args: Union[Mapping[Any, Any], bool],
projection_model: Optional[Type["DocumentProjectionType"]] = None,
skip: Optional[int] = None,
limit: Optional[int] = None,
sort: Union[None, str, List[Tuple[str, SortDirection]]] = None,
session: Optional[AsyncClientSession] = None,
ignore_cache: bool = False,
fetch_links: bool = False,
with_children: bool = False,
lazy_parse: bool = False,
nesting_depth: Optional[int] = None,
nesting_depths_per_field: Optional[Dict[str, int]] = None,
**pymongo_kwargs: Any,
) -> FindMany["DocumentProjectionType"]: ...
@classmethod
def find_many( # type: ignore
cls: Type[FindType],
*args: Union[Mapping[Any, Any], bool],
projection_model: Optional[Type["DocumentProjectionType"]] = None,
skip: Optional[int] = None,
limit: Optional[int] = None,
sort: Union[None, str, List[Tuple[str, SortDirection]]] = None,
session: Optional[AsyncClientSession] = None,
ignore_cache: bool = False,
fetch_links: bool = False,
with_children: bool = False,
lazy_parse: bool = False,
nesting_depth: Optional[int] = None,
nesting_depths_per_field: Optional[Dict[str, int]] = None,
**pymongo_kwargs: Any,
) -> Union[FindMany[FindType], FindMany["DocumentProjectionType"]]:
"""
Find many documents by criteria.
Returns [FindMany](query.md#findmany) query object
:param args: *Mapping[Any, Any] - search criteria
:param skip: Optional[int] - The number of documents to omit.
:param limit: Optional[int] - The maximum number of results to return.
:param sort: Union[None, str, List[Tuple[str, SortDirection]]] - A key or a list of (key, direction) pairs specifying the sort order for this query.
:param projection_model: Optional[Type[BaseModel]] - projection model
:param session: Optional[AsyncClientSession] - pymongo session.
:param ignore_cache: bool
:param lazy_parse: bool
:param **pymongo_kwargs: pymongo native parameters for find operation (if Document class contains links, this parameter must fit the respective parameter of the aggregate MongoDB function)
:return: [FindMany](query.md#findmany) - query instance
"""
args = cls._add_class_id_filter(args, with_children)
return cls._find_many_query_class(document_model=cls).find_many(
*args,
sort=sort,
skip=skip,
limit=limit,
projection_model=projection_model,
session=session,
ignore_cache=ignore_cache,
fetch_links=fetch_links,
lazy_parse=lazy_parse,
nesting_depth=nesting_depth,
nesting_depths_per_field=nesting_depths_per_field,
**pymongo_kwargs,
)
@overload
@classmethod
def find( # type: ignore
cls: Type[FindType],
*args: Union[Mapping[Any, Any], bool],
projection_model: None = None,
skip: Optional[int] = None,
limit: Optional[int] = None,
sort: Union[None, str, List[Tuple[str, SortDirection]]] = None,
session: Optional[AsyncClientSession] = None,
ignore_cache: bool = False,
fetch_links: bool = False,
with_children: bool = False,
lazy_parse: bool = False,
nesting_depth: Optional[int] = None,
nesting_depths_per_field: Optional[Dict[str, int]] = None,
**pymongo_kwargs: Any,
) -> FindMany[FindType]: ...
@overload
@classmethod
def find( # type: ignore
cls: Type[FindType],
*args: Union[Mapping[Any, Any], bool],
projection_model: Type["DocumentProjectionType"],
skip: Optional[int] = None,
limit: Optional[int] = None,
sort: Union[None, str, List[Tuple[str, SortDirection]]] = None,
session: Optional[AsyncClientSession] = None,
ignore_cache: bool = False,
fetch_links: bool = False,
with_children: bool = False,
lazy_parse: bool = False,
nesting_depth: Optional[int] = None,
nesting_depths_per_field: Optional[Dict[str, int]] = None,
**pymongo_kwargs: Any,
) -> FindMany["DocumentProjectionType"]: ...
@classmethod
def find( # type: ignore
cls: Type[FindType],
*args: Union[Mapping[Any, Any], bool],
projection_model: Optional[Type["DocumentProjectionType"]] = None,
skip: Optional[int] = None,
limit: Optional[int] = None,
sort: Union[None, str, List[Tuple[str, SortDirection]]] = None,
session: Optional[AsyncClientSession] = None,
ignore_cache: bool = False,
fetch_links: bool = False,
with_children: bool = False,
lazy_parse: bool = False,
nesting_depth: Optional[int] = None,
nesting_depths_per_field: Optional[Dict[str, int]] = None,
**pymongo_kwargs: Any,
) -> Union[FindMany[FindType], FindMany["DocumentProjectionType"]]:
"""
The same as find_many
"""
return cls.find_many(
*args,
skip=skip,
limit=limit,
sort=sort,
projection_model=projection_model,
session=session,
ignore_cache=ignore_cache,
fetch_links=fetch_links,
with_children=with_children,
lazy_parse=lazy_parse,
nesting_depth=nesting_depth,
nesting_depths_per_field=nesting_depths_per_field,
**pymongo_kwargs,
)
@overload
@classmethod
def find_all( # type: ignore
cls: Type[FindType],
skip: Optional[int] = None,
limit: Optional[int] = None,
sort: Union[None, str, List[Tuple[str, SortDirection]]] = None,
projection_model: None = None,
session: Optional[AsyncClientSession] = None,
ignore_cache: bool = False,
with_children: bool = False,
lazy_parse: bool = False,
nesting_depth: Optional[int] = None,
nesting_depths_per_field: Optional[Dict[str, int]] = None,
**pymongo_kwargs: Any,
) -> FindMany[FindType]: ...
@overload
@classmethod
def find_all( # type: ignore
cls: Type[FindType],
skip: Optional[int] = None,
limit: Optional[int] = None,
sort: Union[None, str, List[Tuple[str, SortDirection]]] = None,
projection_model: Optional[Type["DocumentProjectionType"]] = None,
session: Optional[AsyncClientSession] = None,
ignore_cache: bool = False,
with_children: bool = False,
lazy_parse: bool = False,
nesting_depth: Optional[int] = None,
nesting_depths_per_field: Optional[Dict[str, int]] = None,
**pymongo_kwargs: Any,
) -> FindMany["DocumentProjectionType"]: ...
@classmethod
def find_all( # type: ignore
cls: Type[FindType],
skip: Optional[int] = None,
limit: Optional[int] = None,
sort: Union[None, str, List[Tuple[str, SortDirection]]] = None,
projection_model: Optional[Type["DocumentProjectionType"]] = None,
session: Optional[AsyncClientSession] = None,
ignore_cache: bool = False,
with_children: bool = False,
lazy_parse: bool = False,
nesting_depth: Optional[int] = None,
nesting_depths_per_field: Optional[Dict[str, int]] = None,
**pymongo_kwargs: Any,
) -> Union[FindMany[FindType], FindMany["DocumentProjectionType"]]:
"""
Get all the documents
:param skip: Optional[int] - The number of documents to omit.
:param limit: Optional[int] - The maximum number of results to return.
:param sort: Union[None, str, List[Tuple[str, SortDirection]]] - A key or a list of (key, direction) pairs specifying the sort order for this query.
:param projection_model: Optional[Type[BaseModel]] - projection model
:param session: Optional[AsyncClientSession] - pymongo session.
:param **pymongo_kwargs: pymongo native parameters for find operation (if Document class contains links, this parameter must fit the respective parameter of the aggregate MongoDB function)
:return: [FindMany](query.md#findmany) - query instance
"""
return cls.find_many(
{},
skip=skip,
limit=limit,
sort=sort,
projection_model=projection_model,
session=session,
ignore_cache=ignore_cache,
with_children=with_children,
lazy_parse=lazy_parse,
nesting_depth=nesting_depth,
nesting_depths_per_field=nesting_depths_per_field,
**pymongo_kwargs,
)
@overload
@classmethod
def all( # type: ignore
cls: Type[FindType],
projection_model: None = None,
skip: Optional[int] = None,
limit: Optional[int] = None,
sort: Union[None, str, List[Tuple[str, SortDirection]]] = None,
session: Optional[AsyncClientSession] = None,
ignore_cache: bool = False,
with_children: bool = False,
lazy_parse: bool = False,
nesting_depth: Optional[int] = None,
nesting_depths_per_field: Optional[Dict[str, int]] = None,
**pymongo_kwargs: Any,
) -> FindMany[FindType]: ...
@overload
@classmethod
def all( # type: ignore
cls: Type[FindType],
projection_model: Type["DocumentProjectionType"],
skip: Optional[int] = None,
limit: Optional[int] = None,
sort: Union[None, str, List[Tuple[str, SortDirection]]] = None,
session: Optional[AsyncClientSession] = None,
ignore_cache: bool = False,
with_children: bool = False,
lazy_parse: bool = False,
nesting_depth: Optional[int] = None,
nesting_depths_per_field: Optional[Dict[str, int]] = None,
**pymongo_kwargs: Any,
) -> FindMany["DocumentProjectionType"]: ...
@classmethod
def all( # type: ignore
cls: Type[FindType],
projection_model: Optional[Type["DocumentProjectionType"]] = None,
skip: Optional[int] = None,
limit: Optional[int] = None,
sort: Union[None, str, List[Tuple[str, SortDirection]]] = None,
session: Optional[AsyncClientSession] = None,
ignore_cache: bool = False,
with_children: bool = False,
lazy_parse: bool = False,
nesting_depth: Optional[int] = None,
nesting_depths_per_field: Optional[Dict[str, int]] = None,
**pymongo_kwargs: Any,
) -> Union[FindMany[FindType], FindMany["DocumentProjectionType"]]:
"""
the same as find_all
"""
return cls.find_all(
skip=skip,
limit=limit,
sort=sort,
projection_model=projection_model,
session=session,
ignore_cache=ignore_cache,
with_children=with_children,
lazy_parse=lazy_parse,
nesting_depth=nesting_depth,
nesting_depths_per_field=nesting_depths_per_field,
**pymongo_kwargs,
)
@classmethod
async def count(cls) -> int:
"""
Number of documents in the collections
The same as find_all().count()
:return: int
"""
return await cls.find_all().count() # type: ignore
@classmethod
def _add_class_id_filter(cls, args: Tuple, with_children: bool = False):
# skip if _class_id is already added
if any(
(
True
for a in args
if isinstance(a, Iterable) and cls.get_settings().class_id in a
)
):
return args
if (
cls.get_model_type() == ModelType.Document
and cls._inheritance_inited
):
if not with_children:
args += ({cls.get_settings().class_id: cls._class_id},)
else:
args += (
{
cls.get_settings().class_id: {
"$in": [cls._class_id]
+ [cname for cname in cls._children.keys()]
}
},
)
if cls.get_settings().union_doc:
args += (
{
cls.get_settings().class_id: cls.get_settings().union_doc_alias
},
)
return args
|
