Skip to content

motorhead.model.document

BaseDocument

Bases: BaseModel

Pydantic BaseModel for documents, embedded documents, and related models.

It's just a convenience class that adds a default Pydantic ConfigDict with the necessary settings to enable custom types (e.g. ObjectId) and population by name in subclasses, so you don't have to set these settings yourself.

Source code in motorhead/model/document.py 
 6
 7
 8
 9
10
11
12
13
14
15
class BaseDocument(BaseModel):
    """
    Pydantic `BaseModel` for documents, embedded documents, and related models.

    It's just a convenience class that adds a default Pydantic `ConfigDict` with the
    necessary settings to enable custom types (e.g. `ObjectId`) and population by name
    in subclasses, so you don't have to set these settings yourself.
    """

    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)

Document

Bases: BaseDocument

Pydantic base model for MongoDB documents.

It exposes the _id attribute as id.

Source code in motorhead/model/document.py 
18
19
20
21
22
23
24
25
class Document(BaseDocument):
    """
    Pydantic base model for MongoDB documents.

    It exposes the `_id` attribute as `id`.
    """

    id: ObjectId = Field(alias="_id")