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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
|
from uuid import uuid4
import pytest
from beanie.odm.utils.pydantic import IS_PYDANTIC_V2
from tests.odm.models import (
DocumentWithBackLink,
DocumentWithDecimalField,
DocumentWithIndexedObjectId,
DocumentWithLink,
DocumentWithListBackLink,
DocumentWithListLink,
DocumentWithOptionalLink,
)
def test_schema_export_of_model_with_decimal_field():
doc = DocumentWithDecimalField(amt=0.1, other_amt=3.5)
if IS_PYDANTIC_V2:
json_schema = doc.model_json_schema()
assert json_schema["properties"]["amt"]["anyOf"][0]["type"] == "number"
assert json_schema["properties"]["amt"]["anyOf"][1]["type"] == "string"
assert (
json_schema["properties"]["other_amt"]["anyOf"][0]["type"]
== "number"
)
assert (
json_schema["properties"]["other_amt"]["anyOf"][1]["type"]
== "string"
)
else:
json_schema = doc.schema()
assert json_schema["properties"]["amt"]["type"] == "number"
assert json_schema["properties"]["other_amt"]["type"] == "number"
def test_schema_export_of_model_with_pydanticobjectid():
doc = DocumentWithIndexedObjectId(
pyid="5f8d0a8b0b7e3a1e4c9f4b1e", uuid=uuid4(), email="test@test.com"
)
if IS_PYDANTIC_V2:
json_schema = doc.model_json_schema()
assert (
json_schema["properties"]["_id"]["anyOf"][0]["$ref"]
== "#/$defs/PydanticObjectId"
)
assert (
json_schema["properties"]["pyid"]["$ref"]
== "#/$defs/PydanticObjectId"
)
else:
json_schema = doc.schema()
assert json_schema["properties"]["_id"]["type"] == "string"
assert json_schema["properties"]["pyid"]["type"] == "string"
def test_schema_export_of_model_with_link():
if IS_PYDANTIC_V2:
json_schema = DocumentWithLink.model_json_schema()
link_alternate_representation = json_schema["properties"]["link"][
"anyOf"
]
else:
json_schema = DocumentWithLink.schema()
link_alternate_representation = json_schema["definitions"][
"DocumentWithLink"
]["properties"]["link"]["anyOf"]
assert link_alternate_representation[0]["type"] == "object"
assert link_alternate_representation[1]["type"] == "object"
@pytest.mark.skipif(
not IS_PYDANTIC_V2,
reason="schema dumping support is more complete with pydantic v2",
)
def test_schema_export_of_model_with_optional_link():
if IS_PYDANTIC_V2:
json_schema = DocumentWithOptionalLink.model_json_schema()
else:
json_schema = DocumentWithOptionalLink.schema()
link_alternate_representation = json_schema["properties"]["link"]["anyOf"]
assert link_alternate_representation[0]["type"] == "object"
assert link_alternate_representation[1]["type"] == "object"
assert link_alternate_representation[2]["type"] == "null"
def test_schema_export_of_model_with_list_link():
if IS_PYDANTIC_V2:
json_schema = DocumentWithListLink.model_json_schema()
link_alternate_representation = json_schema["properties"]["link"][
"items"
]["anyOf"]
link_definition = json_schema["properties"]["link"]["type"]
else:
json_schema = DocumentWithListLink.schema()
link_alternate_representation = json_schema["definitions"][
"DocumentWithListLink"
]["properties"]["link"]["items"]["anyOf"]
link_definition = json_schema["definitions"]["DocumentWithListLink"][
"properties"
]["link"]["type"]
assert link_definition == "array"
assert link_alternate_representation[0]["type"] == "object"
assert link_alternate_representation[1]["type"] == "object"
def test_schema_export_of_model_with_backlink():
if IS_PYDANTIC_V2:
json_schema = DocumentWithBackLink.model_json_schema()
back_link_definition = json_schema["properties"]["back_link"]["type"]
else:
json_schema = DocumentWithBackLink.schema()
back_link_definition = json_schema["definitions"][
"DocumentWithBackLink"
]["properties"]["back_link"]["anyOf"][1]["type"]
assert back_link_definition == "object"
def test_schema_export_of_model_with_list_backlink():
if IS_PYDANTIC_V2:
json_schema = DocumentWithListBackLink.model_json_schema()
assert json_schema["properties"]["back_link"]["type"] == "array"
assert (
json_schema["properties"]["back_link"]["items"]["type"] == "object"
)
else:
json_schema = DocumentWithListBackLink.schema()
assert (
json_schema["definitions"]["DocumentWithListBackLink"][
"properties"
]["back_link"]["type"]
== "array"
)
assert (
json_schema["definitions"]["DocumentWithListBackLink"][
"properties"
]["back_link"]["items"]["anyOf"][1]["type"]
== "object"
)
@pytest.mark.skipif(
not IS_PYDANTIC_V2,
reason="schema dumping support is more complete with pydantic v2",
)
@pytest.mark.parametrize(
"model_type",
[
DocumentWithDecimalField,
DocumentWithIndexedObjectId,
DocumentWithLink,
DocumentWithOptionalLink,
DocumentWithListLink,
DocumentWithBackLink,
DocumentWithListBackLink,
],
)
def test_json_serialization_of_model(model_type):
validation_schema = model_type.model_json_schema(mode="serialization")
assert validation_schema is not None
assert isinstance(validation_schema, dict)
|
