ormar/docs/api/models/helpers/pydantic.md

models.helpers.pydantic

create_pydantic_field

create_pydantic_field(field_name: str, model: Type["Model"], model_field: Type[ManyToManyField]) -> None

Registers pydantic field on through model that leads to passed model and is registered as field_name passed.

Through model is fetched from through attributed on passed model_field.

Arguments:

• field_name (str): field name to register
• model (Model class): type of field to register
• model_field (ManyToManyField class): relation field from which through model is extracted

get_pydantic_field

get_pydantic_field(field_name: str, model: Type["Model"]) -> "ModelField"

Extracts field type and if it's required from Model model_fields by passed field_name. Returns a pydantic field with type of field_name field type.

Arguments:

• field_name (str): field name to fetch from Model and name of pydantic field
• model (Model class): type of field to register

Returns:

(pydantic.ModelField): newly created pydantic field

populate_default_pydantic_field_value

populate_default_pydantic_field_value(ormar_field: Type[BaseField], field_name: str, attrs: dict) -> dict

Grabs current value of the ormar Field in class namespace (so the default_value declared on ormar model if set) and converts it to pydantic.FieldInfo that pydantic is able to extract later.

On FieldInfo there are saved all needed params like max_length of the string and other constraints that pydantic can use to build it's own field validation used by ormar.

Arguments:

• ormar_field (ormar Field): field to convert
• field_name (str): field to convert name
• attrs (Dict): current class namespace

Returns:

(Dict): updated namespace dict

populate_pydantic_default_values

populate_pydantic_default_values(attrs: Dict) -> Tuple[Dict, Dict]

Extracts ormar fields from annotations (deprecated) and from namespace dictionary of the class. Fields declared on model are all subclasses of the BaseField class.

Trigger conversion of ormar field into pydantic FieldInfo, which has all needed paramaters saved.

Overwrites the annotations of ormar fields to corresponding types declared on ormar fields (constructed dynamically for relations). Those annotations are later used by pydantic to construct it's own fields.

Arguments:

• attrs (Dict): current class namespace

Returns:

(Tuple[Dict, Dict]): namespace of the class updated, dict of extracted model_fields

get_pydantic_base_orm_config

get_pydantic_base_orm_config() -> Type[BaseConfig]

Returns empty pydantic Config with orm_mode set to True.

Returns:

(pydantic Config): empty default config with orm_mode set.

get_potential_fields

get_potential_fields(attrs: Dict) -> Dict

Gets all the fields in current class namespace that are Fields.

Arguments:

• attrs (Dict): current class namespace

Returns:

(Dict): extracted fields that are ormar Fields