recursive_schema
get_pydantic() with named, reusable, recursive pydantic models.
A schema is built per variant of a model: the model itself (one nested model per
model, the default), or with the relation back to its parent left out
(Book_without_author below Author.books with
omit_back_relations=True), plus the include/exclude/flatten selector still in
scope and the remaining depth. A relation points to the variant of its target by
a forward reference, so cycles become recursive models ($ref in the JSON
schema) instead of a copy of the schema per path, and the number of models grows
with the models (or the (model, relation) pairs), not with the paths.
Names depend only on the variant, so the OpenAPI document does not depend on the
order of get_pydantic() calls::
| Text Only | |
|---|---|
1 2 3 4 5 6 | |
RecursiveSchemaBuilder
Builds the pydantic models of get_pydantic() as recursive models::
| Text Only | |
|---|---|
1 | |
Generated models are kept per variant until the relation graph changes, and a variant keeps its class name when it is rebuilt.
Source code in ormar/models/recursive_schema.py
| Python | |
|---|---|
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 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 | |
__init__(omit_back_relations=False)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
omit_back_relations
|
bool
|
leave the relation back to the parent out of a nested model; False gives one nested model per model, with every relation optional |
False
|
Source code in ormar/models/recursive_schema.py
| Python | |
|---|---|
148 149 150 151 152 153 154 155 156 157 | |
build(model, include=None, exclude=None, flatten_map=None, max_depth=None)
Returns the root pydantic model of a model, building every variant it needs that was not built before.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
model
|
type[PydanticMixin]
|
ormar model to convert |
required |
include
|
Union[set, dict, None]
|
fields of own and nested models to include |
None
|
exclude
|
Union[set, dict, None]
|
fields of own and nested models to exclude |
None
|
flatten_map
|
Optional[FlattenMap]
|
relations to represent as their primary key |
None
|
max_depth
|
Optional[int]
|
number of relation levels to nest at most |
None
|
Returns:
| Type | Description |
|---|---|
type[pydantic.BaseModel]
|
pydantic model |
Source code in ormar/models/recursive_schema.py
| Python | |
|---|---|
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 | |
create_model(variant, name, include, exclude, flatten_map)
Creates the pydantic class of a variant with forward references to the variants of its relations.
Returns:
| Type | Description |
|---|---|
type[pydantic.BaseModel]
|
pydantic model with a deferred build |
Source code in ormar/models/recursive_schema.py
| Python | |
|---|---|
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 | |
relation_type(variant, field, include, exclude, flatten_map, defaults)
Returns the annotation of a relation field: the pk type of a flattened
relation or a forward reference to the variant of the target, left out
for the relation back to the parent and beyond max_depth. Nested
relations are optional, as a dump stops where the target model is
already on the path.
Returns:
| Type | Description |
|---|---|
Any
|
annotation or None when the relation is left out |
Source code in ormar/models/recursive_schema.py
| Python | |
|---|---|
363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 | |
unique_name(variant)
Returns the class name of a variant, the same for the life of the process. Two variants with the same name (models with the same class name in different modules) get a number suffix in the order they are first built.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
variant
|
SchemaVariant
|
variant to name |
required |
Returns:
| Type | Description |
|---|---|
str
|
unique class name |
Source code in ormar/models/recursive_schema.py
| Python | |
|---|---|
275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 | |
variant(model, include, exclude, flatten_map, omitted_relation, remaining_depth, nested)
Returns the key of one generated model.
Returns:
| Type | Description |
|---|---|
SchemaVariant
|
variant key |
Source code in ormar/models/recursive_schema.py
| Python | |
|---|---|
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 | |
variant_name(variant, include, exclude, flatten_map)
Returns the class name of a variant, building the variant on first use and after the relation graph changed. A variant that is being built is referenced by its name only, which closes the cycle.
Returns:
| Type | Description |
|---|---|
str
|
class name of the variant |
Source code in ormar/models/recursive_schema.py
| Python | |
|---|---|
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 | |
SchemaVariant
dataclass
Identifies one generated pydantic model.
Source code in ormar/models/recursive_schema.py
| Python | |
|---|---|
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 | |
name()
Returns the class name of the variant, built from the variant only.
Returns:
| Type | Description |
|---|---|
str
|
class name |
Source code in ormar/models/recursive_schema.py
| Python | |
|---|---|
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 | |
canonical(value)
Returns a text form of an include/exclude/flatten selector that does not depend on the order of sets and dicts, so equal selectors give equal variants and names in every process::
| Text Only | |
|---|---|
1 | |
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
Any
|
selector in any accepted form |
required |
Returns:
| Type | Description |
|---|---|
str
|
canonical text |
Source code in ormar/models/recursive_schema.py
| Python | |
|---|---|
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 | |
dump_ormar_instance(cls, data)
Validates an ormar instance (e.g. returned from a FastAPI endpoint with a
get_pydantic() response model) through its model_dump(): the dump
stops where a model is already on the path, while validating the loaded
instances attribute by attribute would follow the relations back to the
parent into a recursion error.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
cls
|
type
|
generated pydantic model |
required |
data
|
Any
|
input of the validation |
required |
Returns:
| Type | Description |
|---|---|
Any
|
dict of an ormar instance, other input unchanged |
Source code in ormar/models/recursive_schema.py
| Python | |
|---|---|
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |