Core Flytekit#

This package contains all of the most common abstractions you’ll need to write Flyte workflows and extend Flytekit.

Basic Authoring#

These are the essentials needed to get started writing tasks and workflows.

`task`	This is the core decorator to use for any task type in flytekit.
`workflow`	This decorator declares a function to be a Flyte workflow.
`kwtypes`	This is a small helper function to convert the keyword arguments to an OrderedDict of types.
`current_context`	Use this method to get a handle of specific parameters available in a flyte task.
`ExecutionParameters`	This is a run-time user-centric context object that is accessible to every @task method.
`FlyteContext`	This is an internal-facing context object, that most users will not have to deal with.
`map_task`	Use a map task for parallelizable tasks that run across a list of an input type.
`ImperativeWorkflow`	An imperative workflow is a programmatic analogue to the typical `@workflow` function-based workflow and is better suited to programmatic applications.
`create_node`	This is the function you want to call if you need to specify dependencies between tasks that don't consume and/or don't produce outputs. For example, if you have t1() and t2(), both of which do not take in nor produce any outputs, how do you specify that t2 should run before t1? ::.
`NodeOutput`	param node
`FlyteContextManager`	FlyteContextManager manages the execution context within Flytekit.

Important

Tasks and Workflows can both be locally run, assuming the relevant tasks are capable of local execution. This is useful for unit testing.

Branching and Conditionals#

Branches and conditionals can be expressed explicitly in Flyte. These conditions are evaluated in the flyte engine and hence should be used for control flow. dynamic workflows can be used to perform custom conditional logic not supported by flytekit

conditional

Use a conditional section to control the flow of a workflow.

Customizing Tasks & Workflows#

`TaskMetadata`	Metadata for a Task.
`Resources`	This class is used to specify both resource requests and resource limits.
`WorkflowFailurePolicy`	Defines the behavior for a workflow execution in the case of an observed node execution failure.
`PodTemplate`	Custom PodTemplate specification for a Task.

Dynamic and Nested Workflows#

See the Dynamic module for more information.

dynamic

Please first see the comments for flytekit.task() and flytekit.workflow().

Signaling#

`approve`	Create a Gate object for binary approval.
`sleep`	Create a sleep Gate object.
`wait_for_input`	Create a Gate object that waits for user input of the specified type.

Scheduling#

`CronSchedule`	Use this when you have a launch plan that you want to run on a cron expression.
`FixedRate`	Use this class to schedule a fixed-rate interval for a launch plan.

Notifications#

`Email`	This notification should be used when sending regular emails to people.
`PagerDuty`	This notification should be used when sending emails to the PagerDuty service.
`Slack`	This notification should be used when sending emails to the Slack.

Reference Entities#

`get_reference_entity`	See the documentation for `flytekit.reference_task` and `flytekit.reference_workflow` as well.
`LaunchPlanReference`	A reference object containing metadata that points to a remote launch plan.
`TaskReference`	A reference object containing metadata that points to a remote task.
`WorkflowReference`	A reference object containing metadata that points to a remote workflow.
`reference_task`	A reference task is a pointer to a task that already exists on your Flyte installation.
`reference_workflow`	A reference workflow is a pointer to a workflow that already exists on your Flyte installation.
`reference_launch_plan`	A reference launch plan is a pointer to a launch plan that already exists on your Flyte installation.

Core Task Types#

`SQLTask`	Base task types for all SQL tasks.
`ContainerTask`	This is an intermediate class that represents Flyte Tasks that run a container at execution time.
`PythonFunctionTask`	A Python Function task should be used as the base for all extensions that have a python function.
`PythonInstanceTask`	This class should be used as the base class for all Tasks that do not have a user defined function body, but have a platform defined execute method.
`LaunchPlan`	Launch Plans are one of the core constructs of Flyte.

Secrets and SecurityContext#

`Secret`	See Using Secrets in a Task for usage examples.
`SecurityContext`	This is a higher level wrapper object that for the most part users shouldn't have to worry about.

Common Flyte IDL Objects#

`AuthRole`	Auth configuration for IAM or K8s service account.
`Labels`	Label values to be applied to a workflow execution resource.
`Annotations`	Annotation values to be applied to a workflow execution resource.
`WorkflowExecutionPhase`	This class holds enum values used for setting notifications.
`Blob`	This literal model is used to represent binary data offloaded to some storage location which is identifiable with a unique string.
`BlobMetadata`	This is metadata for the Blob literal.
`Literal`	This IDL message represents a literal value in the Flyte ecosystem.
`Scalar`	Scalar wrapper around Flyte types.
`LiteralType`	This is a oneof message, only one of the kwargs may be set, representing one of the Flyte types.
`BlobType`	This type represents offloaded data and is typically used for things like files.

Task Utilities#

HashMethod

Flyte-specific object used to wrap the hash function for a specific type

Documentation#

`Description`	Full user description with formatting preserved.
`Documentation`	DescriptionEntity contains detailed description for the task/workflow/launch plan.
`SourceCode`	Link to source code used to define this task or workflow.