AliasGenerator

A data class used by alias_generator as a convenience to create various aliases.

Attributes

Attribute	Type	Description
alias	`Callable[[str], str]	None` = None
validation_alias	`Callable[[str], str	AliasPath
serialization_alias	`Callable[[str], str]	None` = None

---

Constructor

Signature

def AliasGenerator(
    alias: Callable[[str], str]| None = None,
    validation_alias: Callable[[str], str | AliasPath | AliasChoices]| None = None,
    serialization_alias: Callable[[str], str]| None = None
) - > None

Parameters

Name	Type	Description
alias	`Callable[[str], str]	None` = None
validation_alias	`Callable[[str], str	AliasPath
serialization_alias	`Callable[[str], str]	None` = None

---

Methods

---

generate_aliases()

@classmethod
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.

Parameters

Name	Type	Description
field_name	str	The original name of the model field for which all alias types should be generated

Returns

Type	Description
`tuple[str	None, str

---