-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add example of object ref with createmodel
- Loading branch information
Showing
3 changed files
with
76 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,75 @@ | ||
from __future__ import annotations | ||
|
||
from typing import Dict, List, Optional | ||
|
||
from pydantic import ( | ||
BaseModel, | ||
ConfigDict, | ||
Field, | ||
create_model, | ||
field_validator, | ||
model_validator, | ||
) | ||
|
||
id_to_entity: Dict[str, Entity] = {} | ||
|
||
|
||
class Entity(BaseModel): | ||
name: str = Field(..., description="The name of this entity") | ||
value: str = Field(..., description="The value of this entity") | ||
ref: Optional[str] = Field( | ||
default=None, description="Reference another Entity name" | ||
) | ||
model_config = ConfigDict(extra="forbid") | ||
|
||
@model_validator(mode="after") # type: ignore | ||
def add_ibek_attributes(cls, entity: Entity): | ||
id_to_entity[entity.name] = entity | ||
|
||
return entity | ||
|
||
|
||
@field_validator("ref", mode="after") | ||
def lookup_instance(cls, id): | ||
try: | ||
return id_to_entity[id] | ||
except KeyError: | ||
raise KeyError(f"object {id} not found in {list(id_to_entity)}") | ||
|
||
|
||
validators = {"Entity": lookup_instance} | ||
|
||
# add validator to the Entity class using create model | ||
Entity2 = create_model( | ||
"Entity", | ||
__validators__=validators, | ||
__base__=Entity, | ||
) # type: ignore | ||
|
||
args = {"entities": (List[Entity2], None)} | ||
Entities = create_model( | ||
"Entities", **args, __config__=ConfigDict(extra="forbid") | ||
) # type: ignore | ||
|
||
|
||
model1 = Entities( | ||
**{ | ||
"entities": [ | ||
{"name": "one", "value": "OneValue"}, | ||
{"name": "two", "value": "TwoValue", "ref": "one"}, | ||
] | ||
} | ||
) | ||
|
||
# demonstrate that entity one has a reference to entity two | ||
assert model1.entities[1].ref.value == "OneValue" | ||
|
||
# this should throw an error because entity one has illegal arguments | ||
model2 = Entities( | ||
**{ | ||
"entities": [ | ||
{"name": "one", "value": "OneValue", "illegal": "bad argument"}, | ||
{"name": "two", "value": "TwoValue", "ref": "one"}, | ||
] | ||
} | ||
) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters