File: test_index_definition.py

package info (click to toggle)
python-odmantic 1.0.2-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, trixie
  • size: 1,640 kB
  • sloc: python: 8,547; sh: 37; makefile: 34; xml: 13; javascript: 3
file content (164 lines) | stat: -rw-r--r-- 3,896 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
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
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
164
from odmantic.field import Field
from odmantic.index import Index, ODMCompoundIndex, ODMSingleFieldIndex
from odmantic.model import EmbeddedModel, Model
from odmantic.query import asc, desc


def test_single_index_definition():
    class M(Model):
        f: int = Field(index=True)

    indexes = M.__indexes__()
    assert len(indexes) == 1
    index = indexes[0]
    assert isinstance(index, ODMSingleFieldIndex)
    assert not index.unique
    assert index.key_name == "f"


def test_single_index_with_key_name_definition():
    class M(Model):
        f: int = Field(key_name="custom", index=True)

    indexes = M.__indexes__()
    assert len(indexes) == 1
    index = indexes[0]
    assert isinstance(index, ODMSingleFieldIndex)
    assert not index.unique
    assert index.key_name == "custom"


def test_single_index_unique_definition():
    class M(Model):
        f: int = Field(unique=True)

    indexes = M.__indexes__()
    assert len(indexes) == 1
    index = indexes[0]
    assert isinstance(index, ODMSingleFieldIndex)
    assert index.unique


def test_single_index_index_and_unique_definition():
    class M(Model):
        f: int = Field(index=True, unique=True)

    indexes = M.__indexes__()
    assert len(indexes) == 1
    index = indexes[0]
    assert isinstance(index, ODMSingleFieldIndex)
    assert index.unique


def test_single_index_definition_from_generator():
    class M(Model):
        f: int

        model_config = {
            "indexes": lambda: [Index(M.f, unique=True)],
        }

    indexes = M.__indexes__()
    assert len(indexes) == 1
    index = indexes[0]
    assert isinstance(index, ODMSingleFieldIndex)
    assert index.unique


def test_compound_index_definition():
    class M(Model):
        f: int
        g: str

        model_config = {
            "indexes": lambda: [Index(M.f, desc(M.g), unique=True)],
        }

    indexes = M.__indexes__()
    assert len(indexes) == 1
    index = indexes[0]
    assert isinstance(index, ODMCompoundIndex)
    assert index.fields == (asc(M.f), desc(M.g))
    assert index.unique


def test_multiple_indexes_definition():
    class M(Model):
        f: int
        g: str
        h: float = Field(index=True)

        model_config = {
            "indexes": lambda: [
                Index(M.f, desc(M.g), unique=True, name="asc_desc"),
                Index(M.g),
            ],
        }

    indexes = M.__indexes__()
    assert len(indexes) == 3

    assert isinstance(indexes[0], ODMSingleFieldIndex)
    assert indexes[0].key_name == "h"

    assert isinstance(indexes[1], ODMCompoundIndex)
    assert indexes[1].fields == (asc(M.f), desc(M.g))
    assert indexes[1].unique
    assert indexes[1].index_name == "asc_desc"
    assert indexes[1].unique

    assert isinstance(indexes[2], ODMSingleFieldIndex)
    assert not indexes[2].unique


def test_embedded_index_definition():
    class E(EmbeddedModel):
        f: int

    class M(Model):
        e: E = Field(index=True)

    indexes = M.__indexes__()
    assert len(indexes) == 1
    index = indexes[0]

    assert isinstance(index, ODMSingleFieldIndex)
    assert index.key_name == "e"


def test_embedded_index_definition_generator():
    class E(EmbeddedModel):
        f: int

    class M(Model):
        e: E

        model_config = {
            "indexes": lambda: [Index(M.e)],
        }

    indexes = M.__indexes__()
    assert len(indexes) == 1
    index = indexes[0]

    assert isinstance(index, ODMSingleFieldIndex)
    assert index.key_name == "e"


def test_embedded_field_index_definition():
    class E(EmbeddedModel):
        f: int

    class M(Model):
        e: E

        model_config = {
            "indexes": lambda: [Index(M.e.f)],
        }

    indexes = M.__indexes__()
    assert len(indexes) == 1
    index = indexes[0]

    assert isinstance(index, ODMSingleFieldIndex)
    assert index.key_name == "e.f"