GitHub

FieldEvolve

API reference for FieldEvolve.

field_evolve(mapping)(self): each named variant's schema mapped.

Attributes

AttributeTypeDescription
variants= variants
mapping= mapping

Functions

__init__

__init__(variants, mapping) -> None
ParameterTypeDescription
variantstuple[str, ...]
mappingMapping[str, Callable[[AnyCodec], AnyCodec]]
def __init__(
    self, variants: tuple[str, ...], mapping: Mapping[str, Callable[[AnyCodec], AnyCodec]]
) -> None:
    self.variants = variants
    self.mapping = mapping

__call__

__call__(field) -> VariantField[Any]
ParameterTypeDescription
fieldVariantField[Any] | AnyCodec

Returns VariantField[Any]

def __call__(self, field: VariantField[Any] | AnyCodec, /) -> VariantField[Any]:
    schemas = (
        field.schemas
        if isinstance(field, VariantField)
        else dict.fromkeys(self.variants, field)
    )
    evolved = {
        variant: self.mapping[variant](schema) if variant in self.mapping else schema
        for variant, schema in schemas.items()
    }
    return VariantField(evolved)