Skip to content

base#

Base Inheritance Models

CreatedModifiedMixin #

Bases: ZooModel

Created and modified mixin

Source code in zoo/schemas/base.py 
 96
 97
 98
 99
100
101
102
103
104
105
106
class CreatedModifiedMixin(ZooModel):
    """
    Created and modified mixin
    """

    created_at: datetime.datetime = Field(
        description="The date and time the record was created",
    )
    updated_at: datetime.datetime = Field(
        description="The date and time the record was last modified",
    )

DeletedMixin #

Bases: ZooModel

Deleted mixin

Source code in zoo/schemas/base.py 
109
110
111
112
113
114
115
116
117
class DeletedMixin(ZooModel):
    """
    Deleted mixin
    """

    deleted_at: Optional[datetime.datetime] = Field(
        default=None,
        description="The date and time the record was deleted",
    )

OptionalIdMixin #

Bases: ZooModel

Id mixin, id is optional

This is used for create table models

Source code in zoo/schemas/base.py 
76
77
78
79
80
81
82
83
84
85
class OptionalIdMixin(ZooModel):
    """
    Id mixin, id is optional

    This is used for create table models
    """

    id: Optional[int] = Field(  # noqa: A003
        default=None, description="The unique identifier for the table"
    )

RequiredIdMixin #

Bases: ZooModel

Id mixin with required id

Source code in zoo/schemas/base.py 
88
89
90
91
92
93
class RequiredIdMixin(ZooModel):
    """
    Id mixin with required id
    """

    id: int = Field(description="The unique identifier for the table")  # noqa: A003

ZooModel #

Bases: BaseModel

Base model for all zoo models

Source code in zoo/schemas/base.py 
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
class ZooModel(BaseModel):
    """
    Base model for all zoo models
    """

    __example__: ClassVar[Dict[str, Any]] = {}

    __openapi_db_fields__: ClassVar[Dict[str, Any]] = {
        "id": 1,
        "created_at": "2021-01-01T00:00:00.000000",
        "updated_at": "2021-01-02T09:12:34.567890",
        "deleted_at": None,
    }

    @classmethod
    def get_openapi_read_example(cls) -> Dict[str, Any]:
        """
        Get the openapi read example
        """
        if not cls.__example__:
            error_msg = "Example not implemented"
            raise NotImplementedError(error_msg)
        return {
            "examples": [
                {
                    **cls.__example__,
                    **cls.__openapi_db_fields__,
                }
            ]
        }

    @classmethod
    def get_openapi_create_example(cls) -> Dict[str, Any]:
        """
        Get the openapi create example
        """
        if not cls.__example__:
            error_msg = "Example not implemented"
            raise NotImplementedError(error_msg)
        return {"examples": [cls.__example__]}

    @classmethod
    def get_openapi_update_example(cls) -> Dict[str, Any]:
        """
        Get the openapi update example
        """
        if not cls.__example__:
            error_msg = "Example not implemented"
            raise NotImplementedError(error_msg)
        keys_to_use = max(len(cls.__example__.keys()) // 2, 1)
        half_example_keys = list(cls.__example__.keys())[:keys_to_use]
        half_example = {key: cls.__example__[key] for key in half_example_keys}
        return {"examples": [half_example]}

    @classmethod
    def get_openapi_delete_example(cls) -> Dict[str, Any]:
        """
        Get the openapi delete example
        """
        read_example = cls.get_openapi_read_example()
        for i in range(len(read_example["examples"])):
            read_example["examples"][i]["deleted_at"] = "2021-01-02T09:12:34.567890"
        return read_example

get_openapi_create_example() classmethod #

Get the openapi create example

Source code in zoo/schemas/base.py 
42
43
44
45
46
47
48
49
50
@classmethod
def get_openapi_create_example(cls) -> Dict[str, Any]:
    """
    Get the openapi create example
    """
    if not cls.__example__:
        error_msg = "Example not implemented"
        raise NotImplementedError(error_msg)
    return {"examples": [cls.__example__]}

get_openapi_delete_example() classmethod #

Get the openapi delete example

Source code in zoo/schemas/base.py 
65
66
67
68
69
70
71
72
73
@classmethod
def get_openapi_delete_example(cls) -> Dict[str, Any]:
    """
    Get the openapi delete example
    """
    read_example = cls.get_openapi_read_example()
    for i in range(len(read_example["examples"])):
        read_example["examples"][i]["deleted_at"] = "2021-01-02T09:12:34.567890"
    return read_example

get_openapi_read_example() classmethod #

Get the openapi read example

Source code in zoo/schemas/base.py 
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
@classmethod
def get_openapi_read_example(cls) -> Dict[str, Any]:
    """
    Get the openapi read example
    """
    if not cls.__example__:
        error_msg = "Example not implemented"
        raise NotImplementedError(error_msg)
    return {
        "examples": [
            {
                **cls.__example__,
                **cls.__openapi_db_fields__,
            }
        ]
    }

get_openapi_update_example() classmethod #

Get the openapi update example

Source code in zoo/schemas/base.py 
52
53
54
55
56
57
58
59
60
61
62
63
@classmethod
def get_openapi_update_example(cls) -> Dict[str, Any]:
    """
    Get the openapi update example
    """
    if not cls.__example__:
        error_msg = "Example not implemented"
        raise NotImplementedError(error_msg)
    keys_to_use = max(len(cls.__example__.keys()) // 2, 1)
    half_example_keys = list(cls.__example__.keys())[:keys_to_use]
    half_example = {key: cls.__example__[key] for key in half_example_keys}
    return {"examples": [half_example]}