GitHub

EncodeTo

API reference for EncodeTo.

encode_to(to, transformation): apply with .pipe to a schema whose Encoded is T.

Functions

__init__

__init__(to, transformation) -> None
ParameterTypeDescription
toSource[Any, E_co, RD_co, RE_co]
transformationTransformation[Any, Any, Any, Any]
def __init__(
    self,
    to: Source[Any, E_co, RD_co, RE_co],
    transformation: Transformation[Any, Any, Any, Any],
) -> None:
    self._to = to
    self._transformation = transformation

__call__

__call__[A, RD2 = Never, RE2 = Never](schema: OptionalKey[A, T_co, RD2, RE2], /) -> OptionalKey[A, E_co, RD_co | RD2, RE_co | RE2]
__call__[A, RD2 = Never, RE2 = Never](schema: Codec[A, T_co, RD2, RE2], /) -> DecodeToSchema[A, E_co, RD_co | RD2, RE_co | RE2]
ParameterTypeDescription
schema
@overload
def __call__[A, RD2 = Never, RE2 = Never](
    self, schema: OptionalKey[A, T_co, RD2, RE2], /
) -> OptionalKey[A, E_co, RD_co | RD2, RE_co | RE2]: ...
@overload
def __call__[A, RD2 = Never, RE2 = Never](
    self, schema: Codec[A, T_co, RD2, RE2], /
) -> DecodeToSchema[A, E_co, RD_co | RD2, RE_co | RE2]: ...
def __call__(
    self, schema: Source[Any, Any, Any, Any], /
) -> DecodeToSchema[Any, Any, Any, Any] | OptionalKey[Any, Any, Any, Any]:
    if isinstance(schema, OptionalKey):
        # Optional on the type side only: the encoded key is ``to``'s.
        to = schema.schema.__codec__()
        node = ast.decode_to(
            _source_ast(self._to), ast.optional_key(to.ast), self._transformation
        )
        return OptionalKey(DecodeToSchema(node, self._to, to))
    return _make(self._to, schema, self._transformation)