Extending Flytekit

This package contains things that are useful when extending Flytekit.

get_serializable(entity_mapping, settings, ...)

The flytekit authoring code produces objects representing Flyte entities (tasks, workflows, etc.).

context_manager

class ExecutionState.Mode(value)[source]

Defines the possible execution modes, which in turn affects execution behavior.

SQLTask(*args, **kwargs)

Base task types for all SQL tasks.

IgnoreOutputs

This exception should be used to indicate that the outputs generated by this can be safely ignored.

PythonTask(*args, **kwargs)

Base Class for all Tasks with a Python native Interface.

ExecutionState(working_dir[, mode, ...])

This is the context that is active when executing a task or a local workflow.

Image(name, fqn, tag)

Image is a structured wrapper for task container images used in object serialization.

ImageConfig([default_image, images])

ImageConfig holds available images which can be used at registration time.

SerializationSettings(project, domain, ...)

These settings are provided while serializing a workflow and task, before registration.

Interface([inputs, outputs, ...])

A Python native interface object, like inspect.signature but simpler.

Promise(var, val)

This object is a wrapper and exists for three main reasons. Let's assume we're dealing with a task like ::.

TaskPlugins()

This is the TaskPlugins factory for task types that are derivative of PythonFunctionTask.

DictTransformer()

Transformer that transforms a univariate dictionary Dict[str, T] to a Literal Map or transforms a untyped dictionary to a JSON (struct/Generic)

T

alias of TypeVar('T')

TypeEngine(*args, **kwds)

Core Extensible TypeEngine of Flytekit.

TypeTransformer(name, t[, ...])

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

PythonCustomizedContainerTask(*args, **kwargs)

Please take a look at the comments for :py:class`flytekit.extend.ExecutableTemplateShimTask` as well.

ExecutableTemplateShimTask(tt, ...)

The canonical @task decorated Python function task is pretty simple to reason about.

ShimTaskExecutor(*args, **kwargs)

DataPersistence(name[, default_prefix])

Base abstract type for all DataPersistence operations.

DataPersistencePlugins()

DataPersistencePlugins is the core plugin registry that stores all DataPersistence plugins.