- class flytekit.ContainerTask(*args, **kwargs)¶
This is an intermediate class that represents Flyte Tasks that run a container at execution time. This is the vast majority of tasks - the typical
@taskdecorated tasks for instance all run a container. An example of something that doesn’t run a container would be something like the Athena SQL task.
task_type (str) – defines a unique task-type for every new extension. If a backend plugin is required then this has to be done in-concert with the backend plugin identifier
name (str) – A unique name for the task instantiation. This is unique for every instance of task.
task_config (T) – Configuration for the task. This is used to configure the specific plugin that handles this task
interface (Optional[Interface]) – A python native typed interface
(inputs) -> outputsthat declares the signature of the task
disable_deck (bool) – If true, this task will not output deck html file
- compile(ctx, *args, **kwargs)¶
Generates a node that encapsulates this task in a workflow definition.
Used when constructing the node that encapsulates this task as part of a broader workflow definition.
- Return type
- dispatch_execute(ctx, input_literal_map)¶
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.
VoidPromiseis returned in the case when the task itself declares no outputs.
Literal Mapis returned when the task returns either one more outputs in the declaration. Individual outputs may be none
DynamicJobSpecis returned when a dynamic workflow is executed
Returns the task config as a serializable dictionary. This task config consists of metadata about the custom defined for this task.
Returns the container definition (if any) that is used to run the task on hosted Flyte.
settings (flytekit.configuration.SerializationSettings) –
- Return type
Return additional plugin-specific custom data (if any) as a serializable dictionary.
Returns the names and python types as a dictionary for the inputs of this task.
Returns the kubernetes pod definition (if any) that is used to run the task on hosted Flyte.
Returns the Sql definition (if any) that is used to run the task on hosted Flyte.
- get_type_for_input_var(k, v)¶
Returns the python type for an input variable by name.
- get_type_for_output_var(k, v)¶
Returns the python type for the specified output variable by name.
- local_execute(ctx, **kwargs)¶
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).
- post_execute(user_params, rval)¶
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
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
If true, this task will not output deck html file
Any environment variables that supplied during the execution of the task.
Returns this task’s python interface.
Returns the user-specified task config which is used for plugin-specific handling of the task.