Aliases
Support for alias configurations.
Usage docs: https://docs.pydantic.dev/2.6/concepts/alias#aliaspath-and-aliaschoices
A data class used by validation_alias as a convenience to create aliases.
A list of string or integer aliases.
Type: list[int | str]
def convert_to_aliases() -> list[str | int]
Converts arguments to a list of string or integer aliases.
list[str | int] — The list of aliases.
Usage docs: https://docs.pydantic.dev/2.6/concepts/alias#aliaspath-and-aliaschoices
A data class used by validation_alias as a convenience to create aliases.
A list containing a string or AliasPath.
Type: list[str | AliasPath]
def convert_to_aliases() -> list[list[str | int]]
Converts arguments to a list of lists containing string or integer aliases.
list[list[str | int]] — The list of aliases.
Usage docs: https://docs.pydantic.dev/2.6/concepts/alias#using-an-aliasgenerator
A data class used by alias_generator as a convenience to create various aliases.
A callable that takes a field name and returns an alias for it.
Type: Callable[[str], str] | None
A callable that takes a field name and returns a validation alias for it.
Type: Callable[[str], str | AliasPath | AliasChoices] | None
A callable that takes a field name and returns a serialization alias for it.
Type: Callable[[str], str] | None
def generate_aliases(
field_name: str,
) -> tuple[str | None, str | AliasPath | AliasChoices | None, str | None]
Generate alias, validation_alias, and serialization_alias for a field.
tuple[str | None, str | AliasPath | AliasChoices | None, str | None] — A tuple of three aliases - validation, alias, and serialization.