Skip to content

Properties

Properties for the Model metaclass.

MetaProperties

Bases: type

Properties for the Model metaclass.

Source code in src/ramifice/properties.py 
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
class MetaProperties(type):
    """Properties for the Model metaclass."""

    @property
    def META(cls) -> dict[str, Any]:
        """Model metadata."""
        return cls._META

    @property
    def collection_name(cls) -> str:
        """The name of the model instance in the database."""
        metadata = cls.META
        # Get collection for current model.
        collection: AsyncCollection = Config.MONGO_DATABASE[metadata["collection_name"]]
        return collection.name

    @property
    def collection_full_name(cls) -> str:
        """The full name of the model instance in the database.

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

    @property
    def database(cls) -> AsyncDatabase:
        """AsyncBatabase for a model instance."""
        metadata = cls.META
        # Get collection for current model.
        collection: AsyncCollection = Config.MONGO_DATABASE[metadata["collection_name"]]
        return collection.database

    @property
    def collection(cls) -> AsyncCollection:
        """AsyncCollection for a model instance."""
        metadata = cls.META
        # Get collection for current model.
        collection: AsyncCollection = Config.MONGO_DATABASE[metadata["collection_name"]]
        return collection

META property

Model metadata.

collection property

AsyncCollection for a model instance.

collection_full_name property

The full name of the model instance in the database.

The full name is of the form database_name.collection_name.

collection_name property

The name of the model instance in the database.

database property

AsyncBatabase for a model instance.