model_field
Returns a schema for a model field, e.g.:
from pydantic_core import core_schema
field = core_schema.model_field(schema=core_schema.int_schema())
def model_field(
schema: CoreSchema,
validation_alias: str | list[str | int] | list[list[str | int]] | None = None,
serialization_alias: str | None = None,
serialization_exclude: bool | None = None,
serialization_exclude_if: Callable[[Any], bool] | None = None,
frozen: bool | None = None,
metadata: dict[str, Any] | None = None
) - > ModelField
Returns a schema for a model field, e.g.:
from pydantic_core import core_schema
field = core_schema.model_field(schema=core_schema.int_schema())
Parameters
| Name | Type | Description |
|---|---|---|
| schema | CoreSchema | The core schema to use for validating and serializing the field's value |
| validation_alias | `str | list[str |
| serialization_alias | `str | None` = None |
| serialization_exclude | `bool | None` = None |
| serialization_exclude_if | `Callable[[Any], bool] | None` = None |
| frozen | `bool | None` = None |
| metadata | `dict[str, Any] | None` = None |
Returns
| Type | Description |
|---|---|
ModelField | A dictionary representing the model field schema configuration. |