Aliases
Support for alias configurations.
Usage docs: https://docs.pydantic.dev/2.8/concepts/alias#aliaspath-and-aliaschoices
A data class used by validation_alias as a convenience to create aliases.
Type: list[int | str] Default: [first_arg] + list(args)
def convert_to_aliases() -> list[str | int]
Converts arguments to a list of string or integer aliases.
list[str | int] — The list of aliases.
def search_dict_for_path(d: dict) -> Any
Searches a dictionary for the path specified by the alias.
Any — The value at the specified path, or PydanticUndefined if the path is not found.
Usage docs: https://docs.pydantic.dev/2.8/concepts/alias#aliaspath-and-aliaschoices
A data class used by validation_alias as a convenience to create aliases.
Type: list[str | AliasPath] Default: [first_choice] + list(choices)
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.8/concepts/alias#using-an-aliasgenerator
A data class used by alias_generator as a convenience to create various aliases.
Type: Callable[[str], str] | None Default: None
Type: Callable[[str], str | AliasPath | AliasChoices] | None Default: None
Type: Callable[[str], str] | None Default: 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.