Module `mongoset.model.document_model_objects`

Expand source code

from __future__ import annotations

from typing import Optional, Dict, Any

from pydantic.main import BaseModel, ModelMetaclass

from mongoset.model.immutable_arguments import _add_immutables_to_namespace, Immutable


class _ObjectModelMetaclass(ModelMetaclass):
    def __new__(mcs, name, bases, namespace, **kwargs):
        namespace = _add_immutables_to_namespace(bases, namespace)
        return super().__new__(mcs, name, bases, namespace, **kwargs)


class ObjectModel(BaseModel, metaclass=_ObjectModelMetaclass):
    """
    The base class for all models. DocumentModel extends this class, adding an id field so
    that it can be used as a document in a mongodb collection
    """

    __immutables__: Dict[str, Immutable]

    def __init__(self, **data: Any) -> None:
        self.__config__.validate_assignment = True
        super().__init__(**data)

    def serialize(self) -> dict:
        """
        Same as the pydantic dict() function, but removes
        all entries that have a value of None
        """
        return {k: v for k, v in super().dict().items() if v is not None}

    def force_set(self, name, value):
        """
        Do not use this function, it is for internally overwriting
        the id when an ObjectModel is inserted into the table
        """
        super().__setattr__(name, value)

    def __setattr__(self, name, value):
        if name in self.__immutables__:
            if name in self.__dict__:
                raise ValueError(f"{self.__class__.__name__}.{name} is immutable")

        return super().__setattr__(name, value)


class DocumentModel(ObjectModel):
    """
    An ObjectModel with an id field. Intended to be used as a document in a mongodb collection
    """

    id: Optional[str] = Immutable()

Classes

class DocumentModel (*, id: str = None)

An ObjectModel with an id field. Intended to be used as a document in a mongodb collection

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class DocumentModel(ObjectModel):
    """
    An ObjectModel with an id field. Intended to be used as a document in a mongodb collection
    """

    id: Optional[str] = Immutable()

Ancestors

ObjectModel
pydantic.main.BaseModel
pydantic.utils.Representation

Inherited members

ObjectModel:
- force_set
- serialize

class ObjectModel

The base class for all models. DocumentModel extends this class, adding an id field so that it can be used as a document in a mongodb collection

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class ObjectModel(BaseModel, metaclass=_ObjectModelMetaclass):
    """
    The base class for all models. DocumentModel extends this class, adding an id field so
    that it can be used as a document in a mongodb collection
    """

    __immutables__: Dict[str, Immutable]

    def __init__(self, **data: Any) -> None:
        self.__config__.validate_assignment = True
        super().__init__(**data)

    def serialize(self) -> dict:
        """
        Same as the pydantic dict() function, but removes
        all entries that have a value of None
        """
        return {k: v for k, v in super().dict().items() if v is not None}

    def force_set(self, name, value):
        """
        Do not use this function, it is for internally overwriting
        the id when an ObjectModel is inserted into the table
        """
        super().__setattr__(name, value)

    def __setattr__(self, name, value):
        if name in self.__immutables__:
            if name in self.__dict__:
                raise ValueError(f"{self.__class__.__name__}.{name} is immutable")

        return super().__setattr__(name, value)

Ancestors

pydantic.main.BaseModel
pydantic.utils.Representation

Subclasses

DocumentModel

Methods

def force_set(self, name, value)

Do not use this function, it is for internally overwriting the id when an ObjectModel is inserted into the table

Expand source code

def force_set(self, name, value):
    """
    Do not use this function, it is for internally overwriting
    the id when an ObjectModel is inserted into the table
    """
    super().__setattr__(name, value)

def serialize(self) ‑> dict

Same as the pydantic dict() function, but removes all entries that have a value of None

Expand source code

def serialize(self) -> dict:
    """
    Same as the pydantic dict() function, but removes
    all entries that have a value of None
    """
    return {k: v for k, v in super().dict().items() if v is not None}