Skip to content

General

General purpose query methods.

GeneralMixin

General purpose query methods.

Source code in src\ramifice\commons\general.py 
 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
class GeneralMixin:
    """General purpose query methods."""

    @classmethod
    def from_mongo_doc(
        cls,
        mongo_doc: dict[str, Any],
    ) -> Any:
        """Create object instance from Mongo document."""
        obj: Any = cls()
        lang: str = translations.CURRENT_LOCALE
        for name, data in mongo_doc.items():
            field = obj.__dict__.get(name)
            if field is None:
                continue
            if field.field_type == "TextField":
                field.value = data.get(lang, "- -") if data is not None else None
            elif field.group == "pass":
                field.value = None
            else:
                field.value = data
        return obj

    @classmethod
    async def estimated_document_count(  # type: ignore[no-untyped-def]
        cls,
        comment: Any | None = None,
        **kwargs,
    ) -> int:
        """Get an estimate of the number of documents in this collection using collection metadata."""
        # Get collection for current model.
        collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
        #
        return await collection.estimated_document_count(
            comment=comment,
            **kwargs,
        )

    @classmethod
    async def count_documents(  # type: ignore[no-untyped-def]
        cls,
        filter: Any,
        session: Any | None = None,
        comment: Any | None = None,
        **kwargs,
    ) -> int:
        """Count the number of documents in this collection."""
        # Get collection for current model.
        collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
        # Correcting filter.
        if filter is not None:
            filter = correct_mongo_filter(cls, filter)

        return await collection.count_documents(
            filter=filter,
            session=session,
            comment=comment,
            **kwargs,
        )

    @classmethod
    async def aggregate(  # type: ignore[no-untyped-def]
        cls,
        pipeline: Any,
        session: Any | None = None,
        let: Any | None = None,
        comment: Any | None = None,
        **kwargs,
    ) -> AsyncCommandCursor:
        """Perform an aggregation using the aggregation framework on this collection."""
        # Get collection for current model.
        collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
        # Correcting filter.
        if pipeline is not None:
            pipeline = correct_mongo_filter(cls, pipeline)

        return await collection.aggregate(
            pipeline=pipeline,
            session=session,
            let=let,
            comment=comment,
            **kwargs,
        )

    @classmethod
    async def distinct(  # type: ignore[no-untyped-def]
        cls,
        key: Any,
        filter: Any | None = None,
        session: Any | None = None,
        comment: Any | None = None,
        hint: Any | None = None,
        **kwargs,
    ) -> list[Any]:
        """Get a list of distinct values for key among all documents in this collection.

        Returns an array of unique values for specified field of collection.
        """
        # Get collection for current model.
        collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
        # Correcting filter.
        if filter is not None:
            filter = correct_mongo_filter(cls, filter)

        return await collection.distinct(
            key=key,
            filter=filter,
            session=session,
            comment=comment,
            hint=hint,
            **kwargs,
        )

    @classmethod
    def collection_name(cls) -> str:
        """The name of this AsyncCollection."""
        # Get collection for current model.
        collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
        #
        return collection.name

    @classmethod
    def collection_full_name(cls) -> str:
        """The full name of this AsyncCollection.

        The full name is of the form database_name.collection_name.
        """
        # Get collection for current model.
        collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
        #
        return collection.full_name

    @classmethod
    def database(cls) -> AsyncDatabase:
        """Get AsyncBatabase for the current Model."""
        # Get collection for current model.
        collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
        #
        return collection.database

    @classmethod
    def collection(cls) -> AsyncCollection:
        """Get AsyncCollection for the current Model."""
        # Get collection for current model.
        collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
        #
        return collection

aggregate(pipeline, session=None, let=None, comment=None, **kwargs) async classmethod

Perform an aggregation using the aggregation framework on this collection.

Source code in src\ramifice\commons\general.py 
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
@classmethod
async def aggregate(  # type: ignore[no-untyped-def]
    cls,
    pipeline: Any,
    session: Any | None = None,
    let: Any | None = None,
    comment: Any | None = None,
    **kwargs,
) -> AsyncCommandCursor:
    """Perform an aggregation using the aggregation framework on this collection."""
    # Get collection for current model.
    collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
    # Correcting filter.
    if pipeline is not None:
        pipeline = correct_mongo_filter(cls, pipeline)

    return await collection.aggregate(
        pipeline=pipeline,
        session=session,
        let=let,
        comment=comment,
        **kwargs,
    )

collection() classmethod

Get AsyncCollection for the current Model.

Source code in src\ramifice\commons\general.py 
157
158
159
160
161
162
163
@classmethod
def collection(cls) -> AsyncCollection:
    """Get AsyncCollection for the current Model."""
    # Get collection for current model.
    collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
    #
    return collection

collection_full_name() classmethod

The full name of this AsyncCollection.

The full name is of the form database_name.collection_name.

Source code in src\ramifice\commons\general.py 
138
139
140
141
142
143
144
145
146
147
@classmethod
def collection_full_name(cls) -> str:
    """The full name of this AsyncCollection.

    The full name is of the form database_name.collection_name.
    """
    # Get collection for current model.
    collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
    #
    return collection.full_name

collection_name() classmethod

The name of this AsyncCollection.

Source code in src\ramifice\commons\general.py 
130
131
132
133
134
135
136
@classmethod
def collection_name(cls) -> str:
    """The name of this AsyncCollection."""
    # Get collection for current model.
    collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
    #
    return collection.name

count_documents(filter, session=None, comment=None, **kwargs) async classmethod

Count the number of documents in this collection.

Source code in src\ramifice\commons\general.py 
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
@classmethod
async def count_documents(  # type: ignore[no-untyped-def]
    cls,
    filter: Any,
    session: Any | None = None,
    comment: Any | None = None,
    **kwargs,
) -> int:
    """Count the number of documents in this collection."""
    # Get collection for current model.
    collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
    # Correcting filter.
    if filter is not None:
        filter = correct_mongo_filter(cls, filter)

    return await collection.count_documents(
        filter=filter,
        session=session,
        comment=comment,
        **kwargs,
    )

database() classmethod

Get AsyncBatabase for the current Model.

Source code in src\ramifice\commons\general.py 
149
150
151
152
153
154
155
@classmethod
def database(cls) -> AsyncDatabase:
    """Get AsyncBatabase for the current Model."""
    # Get collection for current model.
    collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
    #
    return collection.database

distinct(key, filter=None, session=None, comment=None, hint=None, **kwargs) async classmethod

Get a list of distinct values for key among all documents in this collection.

Returns an array of unique values for specified field of collection.

Source code in src\ramifice\commons\general.py 
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
@classmethod
async def distinct(  # type: ignore[no-untyped-def]
    cls,
    key: Any,
    filter: Any | None = None,
    session: Any | None = None,
    comment: Any | None = None,
    hint: Any | None = None,
    **kwargs,
) -> list[Any]:
    """Get a list of distinct values for key among all documents in this collection.

    Returns an array of unique values for specified field of collection.
    """
    # Get collection for current model.
    collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
    # Correcting filter.
    if filter is not None:
        filter = correct_mongo_filter(cls, filter)

    return await collection.distinct(
        key=key,
        filter=filter,
        session=session,
        comment=comment,
        hint=hint,
        **kwargs,
    )

estimated_document_count(comment=None, **kwargs) async classmethod

Get an estimate of the number of documents in this collection using collection metadata.

Source code in src\ramifice\commons\general.py 
40
41
42
43
44
45
46
47
48
49
50
51
52
53
@classmethod
async def estimated_document_count(  # type: ignore[no-untyped-def]
    cls,
    comment: Any | None = None,
    **kwargs,
) -> int:
    """Get an estimate of the number of documents in this collection using collection metadata."""
    # Get collection for current model.
    collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
    #
    return await collection.estimated_document_count(
        comment=comment,
        **kwargs,
    )

from_mongo_doc(mongo_doc) classmethod

Create object instance from Mongo document.

Source code in src\ramifice\commons\general.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
@classmethod
def from_mongo_doc(
    cls,
    mongo_doc: dict[str, Any],
) -> Any:
    """Create object instance from Mongo document."""
    obj: Any = cls()
    lang: str = translations.CURRENT_LOCALE
    for name, data in mongo_doc.items():
        field = obj.__dict__.get(name)
        if field is None:
            continue
        if field.field_type == "TextField":
            field.value = data.get(lang, "- -") if data is not None else None
        elif field.group == "pass":
            field.value = None
        else:
            field.value = data
    return obj