0.0.0+develop

flytekitplugins.airflow.task

Class	Description
`AirflowContainerTask`	This python container task is used to wrap an Airflow task.
`AirflowObj`	This class is used to store the Airflow task configuration.
`AirflowTask`	This python task is used to wrap an Airflow task.
`AirflowTaskResolver`	This class is used to resolve an Airflow task.

Property	Type	Description
`airflow_task_resolver`	`AirflowTaskResolver`

flytekitplugins.airflow.task.AirflowContainerTask

This python container task is used to wrap an Airflow task. It is used to run an Airflow task in a container. The airflow task module, name and parameters are stored in the task config.

Some of the Airflow operators are not deferrable, For example, BeamRunJavaPipelineOperator, BeamRunPythonPipelineOperator. These tasks don’t have an async method to get the job status, so cannot be used in the Flyte agent. We run these tasks in a container.

        
    
class AirflowContainerTask(
    name: str,
    task_config: flytekitplugins.airflow.task.AirflowObj,
    inputs: typing.Optional[typing.Dict[str, typing.Type]],
    kwargs,
)

Parameter	Type
`name`	`str`
`task_config`	`flytekitplugins.airflow.task.AirflowObj`
`inputs`	`typing.Optional[typing.Dict[str, typing.Type]]`
`kwargs`	`**kwargs`

Methods

Method	Description
`compile()`	Generates a node that encapsulates this task in a workflow definition.
`construct_node_metadata()`	Used when constructing the node that encapsulates this task as part of a broader workflow definition.
`dispatch_execute()`	This method translates Flyte’s Type system based input values and invokes the actual call to the executor.
`execute()`	This method will be invoked to execute the task.
`find_lhs()`
`get_command()`	Returns the command which should be used in the container definition for the serialized version of this task.
`get_config()`	Returns the task config as a serializable dictionary.
`get_container()`	Returns the container definition (if any) that is used to run the task on hosted Flyte.
`get_custom()`	Return additional plugin-specific custom data (if any) as a serializable dictionary.
`get_default_command()`	Returns the default pyflyte-execute command used to run this on hosted Flyte platforms.
`get_extended_resources()`	Returns the extended resources to allocate to the task on hosted Flyte.
`get_image()`	Update image spec based on fast registration usage, and return string representing the image.
`get_input_types()`	Returns the names and python types as a dictionary for the inputs of this task.
`get_k8s_pod()`	Returns the kubernetes pod definition (if any) that is used to run the task on hosted Flyte.
`get_sql()`	Returns the Sql definition (if any) that is used to run the task on hosted Flyte.
`get_type_for_input_var()`	Returns the python type for an input variable by name.
`get_type_for_output_var()`	Returns the python type for the specified output variable by name.
`local_execute()`	This function is used only in the local execution path and is responsible for calling dispatch execute.
`local_execution_mode()`
`post_execute()`	Post execute is called after the execution has completed, with the user_params and can be used to clean-up,.
`pre_execute()`	This is the method that will be invoked directly before executing the task method and before all the inputs.
`reset_command_fn()`	Resets the command which should be used in the container definition of this task to the default arguments.
`sandbox_execute()`	Call dispatch_execute, in the context of a local sandbox execution.
`set_command_fn()`	By default, the task will run on the Flyte platform using the pyflyte-execute command.
`set_resolver()`	By default, flytekit uses the DefaultTaskResolver to resolve the task.

compile()

        
    
def compile(
    ctx: flytekit.core.context_manager.FlyteContext,
    args,
    kwargs,
) -> typing.Union[typing.Tuple[flytekit.core.promise.Promise], flytekit.core.promise.Promise, flytekit.core.promise.VoidPromise, NoneType]

Generates a node that encapsulates this task in a workflow definition.

Parameter	Type
`ctx`	`flytekit.core.context_manager.FlyteContext`
`args`	`*args`
`kwargs`	`**kwargs`

construct_node_metadata()

def construct_node_metadata()

Used when constructing the node that encapsulates this task as part of a broader workflow definition.

dispatch_execute()

        
    
def dispatch_execute(
    ctx: flytekit.core.context_manager.FlyteContext,
    input_literal_map: flytekit.models.literals.LiteralMap,
) -> typing.Union[flytekit.models.literals.LiteralMap, flytekit.models.dynamic_job.DynamicJobSpec, typing.Coroutine]

This method translates Flyte’s Type system based input values and invokes the actual call to the executor This method is also invoked during runtime.

VoidPromise is returned in the case when the task itself declares no outputs.
Literal Map is returned when the task returns either one more outputs in the declaration. Individual outputs may be none
DynamicJobSpec is returned when a dynamic workflow is executed

Parameter	Type
`ctx`	`flytekit.core.context_manager.FlyteContext`
`input_literal_map`	`flytekit.models.literals.LiteralMap`

execute()

        
    
def execute(
    kwargs,
) -> typing.Any

This method will be invoked to execute the task.

Parameter	Type
`kwargs`	`**kwargs`

find_lhs()

def find_lhs()

get_command()

        
    
def get_command(
    settings: SerializationSettings,
) -> List[str]

Returns the command which should be used in the container definition for the serialized version of this task registered on a hosted Flyte platform.

Parameter	Type
`settings`	`SerializationSettings`

get_config()

        
    
def get_config(
    settings: SerializationSettings,
) -> Optional[Dict[str, str]]

Returns the task config as a serializable dictionary. This task config consists of metadata about the custom defined for this task.

Parameter	Type
`settings`	`SerializationSettings`

get_container()

        
    
def get_container(
    settings: SerializationSettings,
) -> _task_model.Container

Returns the container definition (if any) that is used to run the task on hosted Flyte.

Parameter	Type
`settings`	`SerializationSettings`

get_custom()

        
    
def get_custom(
    settings: flytekit.configuration.SerializationSettings,
) -> typing.Optional[typing.Dict[str, typing.Any]]

Return additional plugin-specific custom data (if any) as a serializable dictionary.

Parameter	Type
`settings`	`flytekit.configuration.SerializationSettings`

get_default_command()

        
    
def get_default_command(
    settings: SerializationSettings,
) -> List[str]

Returns the default pyflyte-execute command used to run this on hosted Flyte platforms.

Parameter	Type
`settings`	`SerializationSettings`

get_extended_resources()

        
    
def get_extended_resources(
    settings: SerializationSettings,
) -> Optional[tasks_pb2.ExtendedResources]

Returns the extended resources to allocate to the task on hosted Flyte.

Parameter	Type
`settings`	`SerializationSettings`

get_image()

        
    
def get_image(
    settings: SerializationSettings,
) -> str

Update image spec based on fast registration usage, and return string representing the image

Parameter	Type
`settings`	`SerializationSettings`

get_input_types()

def get_input_types()

Returns the names and python types as a dictionary for the inputs of this task.

get_k8s_pod()

        
    
def get_k8s_pod(
    settings: SerializationSettings,
) -> _task_model.K8sPod

Returns the kubernetes pod definition (if any) that is used to run the task on hosted Flyte.

Parameter	Type
`settings`	`SerializationSettings`

get_sql()

        
    
def get_sql(
    settings: flytekit.configuration.SerializationSettings,
) -> typing.Optional[flytekit.models.task.Sql]

Returns the Sql definition (if any) that is used to run the task on hosted Flyte.

Parameter	Type
`settings`	`flytekit.configuration.SerializationSettings`

get_type_for_input_var()

        
    
def get_type_for_input_var(
    k: str,
    v: typing.Any,
) -> typing.Type[typing.Any]

Returns the python type for an input variable by name.

Parameter	Type
`k`	`str`
`v`	`typing.Any`

get_type_for_output_var()

        
    
def get_type_for_output_var(
    k: str,
    v: typing.Any,
) -> typing.Type[typing.Any]

Returns the python type for the specified output variable by name.

Parameter	Type
`k`	`str`
`v`	`typing.Any`

local_execute()

        
    
def local_execute(
    ctx: flytekit.core.context_manager.FlyteContext,
    kwargs,
) -> typing.Union[typing.Tuple[flytekit.core.promise.Promise], flytekit.core.promise.Promise, flytekit.core.promise.VoidPromise, typing.Coroutine, NoneType]

This function is used only in the local execution path and is responsible for calling dispatch execute. Use this function when calling a task with native values (or Promises containing Flyte literals derived from Python native values).

Parameter	Type
`ctx`	`flytekit.core.context_manager.FlyteContext`
`kwargs`	`**kwargs`

local_execution_mode()

def local_execution_mode()

post_execute()

        
    
def post_execute(
    user_params: typing.Optional[flytekit.core.context_manager.ExecutionParameters],
    rval: typing.Any,
) -> typing.Any

Post execute is called after the execution has completed, with the user_params and can be used to clean-up, or alter the outputs to match the intended tasks outputs. If not overridden, then this function is a No-op

Parameter	Type
`user_params`	`typing.Optional[flytekit.core.context_manager.ExecutionParameters]`
`rval`	`typing.Any`

pre_execute()

        
    
def pre_execute(
    user_params: typing.Optional[flytekit.core.context_manager.ExecutionParameters],
) -> typing.Optional[flytekit.core.context_manager.ExecutionParameters]

This is the method that will be invoked directly before executing the task method and before all the inputs are converted. One particular case where this is useful is if the context is to be modified for the user process to get some user space parameters. This also ensures that things like SparkSession are already correctly setup before the type transformers are called

This should return either the same context of the mutated context

Parameter	Type
`user_params`	`typing.Optional[flytekit.core.context_manager.ExecutionParameters]`

reset_command_fn()

def reset_command_fn()

Resets the command which should be used in the container definition of this task to the default arguments. This is useful when the command line is overridden at serialization time.

sandbox_execute()

        
    
def sandbox_execute(
    ctx: flytekit.core.context_manager.FlyteContext,
    input_literal_map: flytekit.models.literals.LiteralMap,
) -> flytekit.models.literals.LiteralMap

Call dispatch_execute, in the context of a local sandbox execution. Not invoked during runtime.

Parameter	Type
`ctx`	`flytekit.core.context_manager.FlyteContext`
`input_literal_map`	`flytekit.models.literals.LiteralMap`

set_command_fn()

        
    
def set_command_fn(
    get_command_fn: Optional[Callable[[SerializationSettings], List[str]]],
)

By default, the task will run on the Flyte platform using the pyflyte-execute command. However, it can be useful to update the command with which the task is serialized for specific cases like running map tasks (“pyflyte-map-execute”) or for fast-executed tasks.

Parameter	Type
`get_command_fn`	`Optional[Callable[[SerializationSettings], List[str]]]`

set_resolver()

        
    
def set_resolver(
    resolver: TaskResolverMixin,
)

By default, flytekit uses the DefaultTaskResolver to resolve the task. This method allows the user to set a custom task resolver. It can be useful to override the task resolver for specific cases like running tasks in the jupyter notebook.

Parameter	Type
`resolver`	`TaskResolverMixin`

Properties

Property	Type	Description
`container_image`
`deck_fields`		If not empty, this task will output deck html file for the specified decks
`disable_deck`		If true, this task will not output deck html file
`docs`
`enable_deck`		If true, this task will output deck html file
`environment`		Any environment variables that supplied during the execution of the task.
`instantiated_in`
`interface`
`lhs`
`location`
`metadata`
`name`
`python_interface`		Returns this task’s python interface.
`resources`
`security_context`
`task_config`		Returns the user-specified task config which is used for plugin-specific handling of the task.
`task_resolver`
`task_type`
`task_type_version`

flytekitplugins.airflow.task.AirflowObj

This class is used to store the Airflow task configuration. It is serialized and stored in the Flyte task config. It can be trigger, hook, operator or sensor. For example:

from airflow.sensors.filesystem import FileSensor sensor = FileSensor(task_id=“id”, filepath="/tmp/1234")

In this case, the attributes of AirflowObj will be: module: airflow.sensors.filesystem name: FileSensor parameters: {“task_id”: “id”, “filepath”: “/tmp/1234”}

        
    
class AirflowObj(
    module: str,
    name: str,
    parameters: typing.Dict[str, typing.Any],
)

Parameter	Type
`module`	`str`
`name`	`str`
`parameters`	`typing.Dict[str, typing.Any]`

flytekitplugins.airflow.task.AirflowTask

This python task is used to wrap an Airflow task. It is used to run an Airflow task in Flyte agent. The airflow task module, name and parameters are stored in the task config. We run the Airflow task in the agent.

        
    
class AirflowTask(
    name: str,
    task_config: typing.Optional[flytekitplugins.airflow.task.AirflowObj],
    inputs: typing.Optional[typing.Dict[str, typing.Type]],
    kwargs,
)

Parameter	Type
`name`	`str`
`task_config`	`typing.Optional[flytekitplugins.airflow.task.AirflowObj]`
`inputs`	`typing.Optional[typing.Dict[str, typing.Type]]`
`kwargs`	`**kwargs`

Methods

Method	Description
`agent_signal_handler()`
`compile()`	Generates a node that encapsulates this task in a workflow definition.
`construct_node_metadata()`	Used when constructing the node that encapsulates this task as part of a broader workflow definition.
`dispatch_execute()`	This method translates Flyte’s Type system based input values and invokes the actual call to the executor.
`execute()`
`find_lhs()`
`get_config()`	Returns the task config as a serializable dictionary.
`get_container()`	Returns the container definition (if any) that is used to run the task on hosted Flyte.
`get_custom()`	Return additional plugin-specific custom data (if any) as a serializable dictionary.
`get_extended_resources()`	Returns the extended resources to allocate to the task on hosted Flyte.
`get_input_types()`	Returns the names and python types as a dictionary for the inputs of this task.
`get_k8s_pod()`	Returns the kubernetes pod definition (if any) that is used to run the task on hosted Flyte.
`get_sql()`	Returns the Sql definition (if any) that is used to run the task on hosted Flyte.
`get_type_for_input_var()`	Returns the python type for an input variable by name.
`get_type_for_output_var()`	Returns the python type for the specified output variable by name.
`local_execute()`	This function is used only in the local execution path and is responsible for calling dispatch execute.
`local_execution_mode()`
`post_execute()`	Post execute is called after the execution has completed, with the user_params and can be used to clean-up,.
`pre_execute()`	This is the method that will be invoked directly before executing the task method and before all the inputs.
`sandbox_execute()`	Call dispatch_execute, in the context of a local sandbox execution.

agent_signal_handler()

        
    
def agent_signal_handler(
    resource_meta: flytekit.extend.backend.base_agent.ResourceMeta,
    signum: int,
    frame: frame,
) -> typing.Any

Parameter	Type
`resource_meta`	`flytekit.extend.backend.base_agent.ResourceMeta`
`signum`	`int`
`frame`	`frame`

compile()

        
    
def compile(
    ctx: flytekit.core.context_manager.FlyteContext,
    args,
    kwargs,
) -> typing.Union[typing.Tuple[flytekit.core.promise.Promise], flytekit.core.promise.Promise, flytekit.core.promise.VoidPromise, NoneType]

Generates a node that encapsulates this task in a workflow definition.

Parameter	Type
`ctx`	`flytekit.core.context_manager.FlyteContext`
`args`	`*args`
`kwargs`	`**kwargs`

construct_node_metadata()

def construct_node_metadata()

Used when constructing the node that encapsulates this task as part of a broader workflow definition.

dispatch_execute()

        
    
def dispatch_execute(
    ctx: flytekit.core.context_manager.FlyteContext,
    input_literal_map: flytekit.models.literals.LiteralMap,
) -> typing.Union[flytekit.models.literals.LiteralMap, flytekit.models.dynamic_job.DynamicJobSpec, typing.Coroutine]

This method translates Flyte’s Type system based input values and invokes the actual call to the executor This method is also invoked during runtime.

VoidPromise is returned in the case when the task itself declares no outputs.
Literal Map is returned when the task returns either one more outputs in the declaration. Individual outputs may be none
DynamicJobSpec is returned when a dynamic workflow is executed

Parameter	Type
`ctx`	`flytekit.core.context_manager.FlyteContext`
`input_literal_map`	`flytekit.models.literals.LiteralMap`

execute()

        
    
def execute(
    kwargs,
) -> flytekit.models.literals.LiteralMap

Parameter	Type
`kwargs`	`**kwargs`

find_lhs()

def find_lhs()

get_config()

        
    
def get_config(
    settings: flytekit.configuration.SerializationSettings,
) -> typing.Optional[typing.Dict[str, str]]

Returns the task config as a serializable dictionary. This task config consists of metadata about the custom defined for this task.

Parameter	Type
`settings`	`flytekit.configuration.SerializationSettings`

get_container()

        
    
def get_container(
    settings: flytekit.configuration.SerializationSettings,
) -> typing.Optional[flytekit.models.task.Container]

Returns the container definition (if any) that is used to run the task on hosted Flyte.

Parameter	Type
`settings`	`flytekit.configuration.SerializationSettings`

get_custom()

        
    
def get_custom(
    settings: flytekit.configuration.SerializationSettings,
) -> typing.Dict[str, typing.Any]

Return additional plugin-specific custom data (if any) as a serializable dictionary.

Parameter	Type
`settings`	`flytekit.configuration.SerializationSettings`

get_extended_resources()

        
    
def get_extended_resources(
    settings: flytekit.configuration.SerializationSettings,
) -> typing.Optional[flyteidl.core.tasks_pb2.ExtendedResources]

Returns the extended resources to allocate to the task on hosted Flyte.

Parameter	Type
`settings`	`flytekit.configuration.SerializationSettings`

get_input_types()

def get_input_types()

Returns the names and python types as a dictionary for the inputs of this task.

get_k8s_pod()

        
    
def get_k8s_pod(
    settings: flytekit.configuration.SerializationSettings,
) -> typing.Optional[flytekit.models.task.K8sPod]

Returns the kubernetes pod definition (if any) that is used to run the task on hosted Flyte.

Parameter	Type
`settings`	`flytekit.configuration.SerializationSettings`

get_sql()

        
    
def get_sql(
    settings: flytekit.configuration.SerializationSettings,
) -> typing.Optional[flytekit.models.task.Sql]

Returns the Sql definition (if any) that is used to run the task on hosted Flyte.

Parameter	Type
`settings`	`flytekit.configuration.SerializationSettings`

get_type_for_input_var()

        
    
def get_type_for_input_var(
    k: str,
    v: typing.Any,
) -> typing.Type[typing.Any]

Returns the python type for an input variable by name.

Parameter	Type
`k`	`str`
`v`	`typing.Any`

get_type_for_output_var()

        
    
def get_type_for_output_var(
    k: str,
    v: typing.Any,
) -> typing.Type[typing.Any]

Returns the python type for the specified output variable by name.

Parameter	Type
`k`	`str`
`v`	`typing.Any`

local_execute()

        
    
def local_execute(
    ctx: flytekit.core.context_manager.FlyteContext,
    kwargs,
) -> typing.Union[typing.Tuple[flytekit.core.promise.Promise], flytekit.core.promise.Promise, flytekit.core.promise.VoidPromise, typing.Coroutine, NoneType]

Parameter	Type
`ctx`	`flytekit.core.context_manager.FlyteContext`
`kwargs`	`**kwargs`

local_execution_mode()

def local_execution_mode()

post_execute()

        
    
def post_execute(
    user_params: typing.Optional[flytekit.core.context_manager.ExecutionParameters],
    rval: typing.Any,
) -> typing.Any

Parameter	Type
`user_params`	`typing.Optional[flytekit.core.context_manager.ExecutionParameters]`
`rval`	`typing.Any`

pre_execute()

        
    
def pre_execute(
    user_params: typing.Optional[flytekit.core.context_manager.ExecutionParameters],
) -> typing.Optional[flytekit.core.context_manager.ExecutionParameters]

This should return either the same context of the mutated context

Parameter	Type
`user_params`	`typing.Optional[flytekit.core.context_manager.ExecutionParameters]`

sandbox_execute()

        
    
def sandbox_execute(
    ctx: flytekit.core.context_manager.FlyteContext,
    input_literal_map: flytekit.models.literals.LiteralMap,
) -> flytekit.models.literals.LiteralMap

Call dispatch_execute, in the context of a local sandbox execution. Not invoked during runtime.

Parameter	Type
`ctx`	`flytekit.core.context_manager.FlyteContext`
`input_literal_map`	`flytekit.models.literals.LiteralMap`

Properties

Property	Type	Description
`deck_fields`		If not empty, this task will output deck html file for the specified decks
`disable_deck`		If true, this task will not output deck html file
`docs`
`enable_deck`		If true, this task will output deck html file
`environment`		Any environment variables that supplied during the execution of the task.
`instantiated_in`
`interface`
`lhs`
`location`
`metadata`
`name`
`python_interface`		Returns this task’s python interface.
`security_context`
`task_config`		Returns the user-specified task config which is used for plugin-specific handling of the task.
`task_type`
`task_type_version`

flytekitplugins.airflow.task.AirflowTaskResolver

This class is used to resolve an Airflow task. It will load an airflow task in the container.

        
    
class AirflowTaskResolver(
    args,
    kwargs,
)

Parameter	Type
`args`	`*args`
`kwargs`	`**kwargs`

Methods

Method	Description
`find_lhs()`
`get_all_tasks()`	Future proof method.
`load_task()`	This method is used to load an Airflow task.
`loader_args()`	Return a list of strings that can help identify the parameter Task.
`name()`
`task_name()`	Overridable function that can optionally return a custom name for a given task.

find_lhs()

def find_lhs()

get_all_tasks()

def get_all_tasks()

Future proof method. Just making it easy to access all tasks (Not required today as we auto register them)

load_task()

        
    
def load_task(
    loader_args: typing.List[str],
) -> typing.Union[airflow.models.baseoperator.BaseOperator, airflow.sensors.base.BaseSensorOperator, airflow.triggers.base.BaseTrigger]

This method is used to load an Airflow task.

Parameter	Type
`loader_args`	`typing.List[str]`

loader_args()

        
    
def loader_args(
    settings: flytekit.configuration.SerializationSettings,
    task: flytekit.core.python_auto_container.PythonAutoContainerTask,
) -> typing.List[str]

Return a list of strings that can help identify the parameter Task

Parameter	Type
`settings`	`flytekit.configuration.SerializationSettings`
`task`	`flytekit.core.python_auto_container.PythonAutoContainerTask`

name()

def name()

task_name()

        
    
def task_name(
    t: flytekit.core.base_task.Task,
) -> typing.Optional[str]

Overridable function that can optionally return a custom name for a given task

Parameter	Type
`t`	`flytekit.core.base_task.Task`

Properties

Property	Type	Description
`instantiated_in`
`lhs`
`location`

On this page

flytekitplugins.airflow.task

Directory

Classes

Variables

flytekitplugins.airflow.task.AirflowContainerTask

Methods

compile()

construct_node_metadata()

dispatch_execute()

execute()

find_lhs()

get_command()

get_config()

get_container()

get_custom()

get_default_command()

get_extended_resources()

get_image()

get_input_types()

get_k8s_pod()

get_sql()

get_type_for_input_var()

get_type_for_output_var()

local_execute()

local_execution_mode()

post_execute()

pre_execute()

reset_command_fn()

sandbox_execute()

set_command_fn()

set_resolver()

Properties

flytekitplugins.airflow.task.AirflowObj

flytekitplugins.airflow.task.AirflowTask

Methods

agent_signal_handler()

compile()

construct_node_metadata()

dispatch_execute()

execute()

find_lhs()

get_config()

get_container()

get_custom()

get_extended_resources()

get_input_types()

get_k8s_pod()

get_sql()

get_type_for_input_var()

get_type_for_output_var()

local_execute()

local_execution_mode()

post_execute()

pre_execute()

sandbox_execute()

Properties

flytekitplugins.airflow.task.AirflowTaskResolver

Methods

find_lhs()

get_all_tasks()

load_task()

loader_args()

name()

task_name()

Properties