flytekit.core.utils

Directory

Classes

Methods

Variables

Methods

has_return_statement()

def has_return_statement(
    func: typing.Callable,
) -> bool

load_proto_from_file()

def load_proto_from_file(
    pb2_type,
    path,
)

str2bool()

def str2bool(
    value: typing.Optional[str],
) -> bool

Convert a string to a boolean. This is useful for parsing environment variables.

Returns: the boolean value

write_proto_to_file()

def write_proto_to_file(
    proto,
    path,
)

flytekit.core.utils.AutoDeletingTempDir

Creates a posix safe tempdir which is auto deleted once out of scope

Parameters

class AutoDeletingTempDir(
    working_dir_prefix = None,
    tmp_dir = None,
    cleanup = True,
)

Properties

Methods

force_cleanup()

def force_cleanup()

get_named_tempfile()

def get_named_tempfile(
    name,
)

list_dir()

def list_dir()

The list of absolute filepaths for all immediate sub-paths

Returns: list[Text]

flytekit.core.utils.ClassDecorator

Abstract class for class decorators. We can attach config on the decorator class and use it in the upper level.

Parameters

class ClassDecorator(
    task_function = None,
    **kwargs,
)

If the decorator is called with arguments, func will be None. If the decorator is called without arguments, func will be function to be decorated.

Methods

execute()

def execute(
    *args,
    **kwargs,
)

This method will be called when the decorated function is called.

get_extra_config()

def get_extra_config()

Get the config of the decorator.

flytekit.core.utils.Directory

Parameters

class Directory(
    path,
)

Properties

Methods

list_dir()

def list_dir()

The list of absolute filepaths for all immediate sub-paths

Returns: list[Text]

flytekit.core.utils.timeit

A context manager and a decorator that measures the execution time of the wrapped code block or functions. It will append a timing information to TimeLineDeck. For instance:

@timeit(“Function description”) def function()

with timeit(“Wrapped code block description”): # your code

Parameters

class timeit(
    name: str = '',
)