flytekit.configuration.file

Directory

Classes

Methods

Variables

Methods

bool_transformer()

def bool_transformer(
    config_val: typing.Any,
) -> bool

comma_list_transformer()

def comma_list_transformer(
    config_val: typing.Any,
)

int_transformer()

def int_transformer(
    config_val: typing.Any,
)

read_file_if_exists()

def read_file_if_exists(
    filename: typing.Optional[str],
    encoding,
) -> typing.Optional[str]

Reads the contents of the file if passed a path. Otherwise, returns None.

Returns: The contents of the file as a string or None.

set_if_exists()

def set_if_exists(
    d: dict,
    k: str,
    v: typing.Any,
) -> dict

Given a dict d sets the key k with value of config v, if the config value v is set and return the updated dictionary.

flytekit.configuration.file.ConfigEntry

A top level Config entry holder, that holds multiple different representations of the config. Legacy means the INI style config files. YAML support is for the flytectl config file, which is there by default when flytectl starts a sandbox

Parameters

class ConfigEntry(
    legacy: LegacyConfigEntry,
    yaml_entry: typing.Optional[YamlConfigEntry],
    transform: typing.Optional[typing.Callable[[str], typing.Any]],
)

Methods

read()

def read(
    cfg: typing.Optional[ConfigFile],
) -> typing.Optional[typing.Any]

Reads the config Entry from the various sources in the following order, #. First try to read from the relevant environment variable, #. If missing, then try to read from the legacy config file, if one was parsed. #. If missing, then try to read from the yaml file.

The constructor for ConfigFile currently does not allow specification of both the ini and yaml style formats.

flytekit.configuration.file.ConfigFile

Parameters

class ConfigFile(
    location: str,
)

Load the config from this location

Properties

Methods

get()

def get(
    c: typing.Union[LegacyConfigEntry, YamlConfigEntry],
) -> typing.Any

flytekit.configuration.file.LegacyConfigEntry

Creates a record for the config entry. contains

Parameters

class LegacyConfigEntry(
    section: str,
    option: str,
    type_: typing.Type,
)

Methods

get_env_name()

def get_env_name()

read_from_env()

def read_from_env(
    transform: typing.Optional[typing.Callable],
) -> typing.Optional[typing.Any]

Reads the config entry from environment variable, the structure of the env var is current FLYTE_{SECTION}_{OPTION} all upper cased. We will change this in the future.

read_from_file()

def read_from_file(
    cfg: ConfigFile,
    transform: typing.Optional[typing.Callable],
) -> typing.Optional[typing.Any]

flytekit.configuration.file.YamlConfigEntry

Creates a record for the config entry.

Parameters

class YamlConfigEntry(
    switch: str,
    config_value_type: typing.Type,
)

Methods

read_from_file()

def read_from_file(
    cfg: ConfigFile,
    transform: typing.Optional[typing.Callable],
) -> typing.Optional[typing.Any]