flytekitplugins.omegaconf.listconfig_transformer

Directory

Classes

Variables

flytekitplugins.omegaconf.listconfig_transformer.ListConfigTransformer

Base transformer type that should be implemented for every python native type that can be handled by flytekit

def ListConfigTransformer()

Construct ListConfigTransformer.

Methods

assert_type()

def assert_type(
    t: Type[T],
    v: T,
)

from_binary_idl()

def from_binary_idl(
    binary_idl_object: Binary,
    expected_python_type: Type[T],
) -> Optional[T]

This function primarily handles deserialization for untyped dicts, dataclasses, Pydantic BaseModels, and attribute access.｀

For untyped dict, dataclass, and pydantic basemodel: Life Cycle (Untyped Dict as example): python val -> msgpack bytes -> binary literal scalar -> msgpack bytes -> python val (to_literal) (from_binary_idl)

For attribute access: Life Cycle: python val -> msgpack bytes -> binary literal scalar -> resolved golang value -> binary literal scalar -> msgpack bytes -> python val (to_literal) (propeller attribute access) (from_binary_idl)

from_generic_idl()

def from_generic_idl(
    generic: Struct,
    expected_python_type: Type[T],
) -> Optional[T]

TODO: Support all Flyte Types. This is for dataclass attribute access from input created from the Flyte Console.

Note:

• This can be removed in the future when the Flyte Console support generate Binary IDL Scalar as input.

get_literal_type()

def get_literal_type(
    t: typing.Type[omegaconf.listconfig.ListConfig],
) -> flytekit.models.types.LiteralType

Provide type hint for Flytekit type system.

To support the multivariate typing of nodes in a ListConfig, we encode them as binaries (no introspection) with multiple files.

guess_python_type()

def guess_python_type(
    literal_type: LiteralType,
) -> Type[T]

Converts the Flyte LiteralType to a python object type.

isinstance_generic()

def isinstance_generic(
    obj,
    generic_alias,
)

to_html()

def to_html(
    ctx: FlyteContext,
    python_val: T,
    expected_python_type: Type[T],
) -> str

Converts any python val (dataframe, int, float) to a html string, and it will be wrapped in the HTML div

to_literal()

def to_literal(
    ctx: flytekit.core.context_manager.FlyteContext,
    python_val: ~T,
    python_type: typing.Type[~T],
    expected: flytekit.models.types.LiteralType,
) -> flytekit.models.literals.Literal

Convert from given python type object ListConfig to the Literal representation.

Since the ListConfig type does not offer additional type hints for its nodes, typing information is stored within the literal itself rather than the Flyte LiteralType.

to_python_value()

def to_python_value(
    ctx: flytekit.core.context_manager.FlyteContext,
    lv: flytekit.models.literals.Literal,
    expected_python_type: typing.Type[omegaconf.listconfig.ListConfig],
) -> omegaconf.listconfig.ListConfig

Re-hydrate the custom object from Flyte Literal value.

Properties