flytekit.core.python_function_task.PythonInstanceTask

class flytekit.core.python_function_task.PythonInstanceTask(*args, **kwargs)[source]

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. (Execute needs to be overridden). This base class ensures that the module loader will invoke the right class automatically, by capturing the module name and variable in the module name.

Please see class level documentation.

__init__(name, task_config, task_type='python-task', task_resolver=None, **kwargs)[source]

Please see class level documentation.

Parameters

Methods

__init__(name, task_config[, task_type, ...])

Please see class level documentation.

compile(ctx, *args, **kwargs)

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(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.

execute(**kwargs)

This method will be invoked to execute the task.

find_lhs()

get_command(settings)

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

get_config(settings)

Returns the task config as a serializable dictionary.

get_container(settings)

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

get_custom(settings)

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

get_default_command(settings)

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

get_input_types()

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

get_k8s_pod(settings)

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

get_sql(settings)

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.

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.

pre_execute(user_params)

This is the method that will be invoked directly before executing the task method and before all the inputs are converted.

reset_command_fn()

Resets the command which should be used in the container definition of this task to the default arguments.

set_command_fn([get_command_fn])

By default, the task will run on the Flyte platform using the pyflyte-execute command.

Attributes

container_image

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