2.0.0b35

AsyncFunctionTaskTemplate

Package: flyte.extend

A task template that wraps an asynchronous functions. This is automatically created when an asynchronous function is decorated with the task decorator.

        
    
class AsyncFunctionTaskTemplate(
    name: str,
    interface: NativeInterface,
    short_name: str,
    task_type: str,
    task_type_version: int,
    image: Union[str, Image, Literal['auto']],
    resources: Optional[Resources],
    cache: CacheRequest,
    interruptible: bool,
    retries: Union[int, RetryStrategy],
    reusable: Union[ReusePolicy, None],
    docs: Optional[Documentation],
    env_vars: Optional[Dict[str, str]],
    secrets: Optional[SecretRequest],
    timeout: Optional[TimeoutType],
    pod_template: Optional[Union[str, PodTemplate]],
    report: bool,
    queue: Optional[str],
    debuggable: bool,
    parent_env: Optional[weakref.ReferenceType[TaskEnvironment]],
    parent_env_name: Optional[str],
    max_inline_io_bytes: int,
    triggers: Tuple[Trigger, ...],
    _call_as_synchronous: bool,
    func: F,
    plugin_config: Optional[Any],
)

Parameter	Type	Description
`name`	`str`
`interface`	`NativeInterface`
`short_name`	`str`
`task_type`	`str`
`task_type_version`	`int`
`image`	`Union[str, Image, Literal['auto']]`
`resources`	`Optional[Resources]`
`cache`	`CacheRequest`
`interruptible`	`bool`
`retries`	`Union[int, RetryStrategy]`
`reusable`	`Union[ReusePolicy, None]`
`docs`	`Optional[Documentation]`
`env_vars`	`Optional[Dict[str, str]]`
`secrets`	`Optional[SecretRequest]`
`timeout`	`Optional[TimeoutType]`
`pod_template`	`Optional[Union[str, PodTemplate]]`
`report`	`bool`
`queue`	`Optional[str]`
`debuggable`	`bool`
`parent_env`	`Optional[weakref.ReferenceType[TaskEnvironment]]`
`parent_env_name`	`Optional[str]`
`max_inline_io_bytes`	`int`
`triggers`	`Tuple[Trigger, ...]`
`_call_as_synchronous`	`bool`
`func`	`F`
`plugin_config`	`Optional[Any]`

Methods

Method	Description
`aio()`	The aio function allows executing “sync” tasks, in an async context.
`config()`	Returns additional configuration for the task.
`container_args()`	Returns the container args for the task.
`custom_config()`	Returns additional configuration for the task.
`data_loading_config()`	This configuration allows executing raw containers in Flyte using the Flyte CoPilot system.
`execute()`	This is the execute method that will be called when the task is invoked.
`forward()`	Think of this as a local execute method for your task.
`override()`	Override various parameters of the task template.
`post()`	This is the postexecute function that will be.
`pre()`	This is the preexecute function that will be.
`sql()`	Returns the SQL for the task.

aio()

        
    
def aio(
    args: *args,
    kwargs: **kwargs,
) -> Coroutine[Any, Any, R] | R

The aio function allows executing “sync” tasks, in an async context. This helps with migrating v1 defined sync tasks to be used within an asyncio parent task. This function will also re-raise exceptions from the underlying task.

Example:

        
    
@env.task
def my_legacy_task(x: int) -&gt; int:
    return x

@env.task
async def my_new_parent_task(n: int) -&gt; List[int]:
    collect = []
    for x in range(n):
        collect.append(my_legacy_task.aio(x))
    return asyncio.gather(*collect)

Parameter	Type	Description
`args`	`*args`
`kwargs`	`**kwargs`	:return:

config()

        
    
def config(
    sctx: SerializationContext,
) -> Dict[str, str]

Returns additional configuration for the task. This is a set of key-value pairs that can be used to configure the task execution environment at runtime. This is usually used by plugins.

Parameter	Type	Description
`sctx`	`SerializationContext`

container_args()

        
    
def container_args(
    serialize_context: SerializationContext,
) -> List[str]

Returns the container args for the task. This is a set of key-value pairs that can be used to configure the task execution environment at runtime. This is usually used by plugins.

Parameter	Type	Description
`serialize_context`	`SerializationContext`

custom_config()

        
    
def custom_config(
    sctx: SerializationContext,
) -> Dict[str, str]

Returns additional configuration for the task. This is a set of key-value pairs that can be used to configure the task execution environment at runtime. This is usually used by plugins.

Parameter	Type	Description
`sctx`	`SerializationContext`

data_loading_config()

        
    
def data_loading_config(
    sctx: SerializationContext,
) -> DataLoadingConfig

This configuration allows executing raw containers in Flyte using the Flyte CoPilot system Flyte CoPilot, eliminates the needs of sdk inside the container. Any inputs required by the users container are side-loaded in the input_path Any outputs generated by the user container - within output_path are automatically uploaded

Parameter	Type	Description
`sctx`	`SerializationContext`

execute()

        
    
def execute(
    args: *args,
    kwargs: **kwargs,
) -> R

This is the execute method that will be called when the task is invoked. It will call the actual function.

TODO We may need to keep this as the bare func execute, and need a pre and post execute some other func.

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

forward()

        
    
def forward(
    args: *args,
    kwargs: **kwargs,
) -> Coroutine[Any, Any, R] | R

Think of this as a local execute method for your task. This function will be invoked by the call method when not in a Flyte task execution context. See the implementation below for an example.

Parameter	Type	Description
`args`	`*args`
`kwargs`	`**kwargs`	:return:

override()

        
    
def override(
    short_name: Optional[str],
    resources: Optional[Resources],
    cache: Optional[CacheRequest],
    retries: Union[int, RetryStrategy],
    timeout: Optional[TimeoutType],
    reusable: Union[ReusePolicy, Literal['off'], None],
    env_vars: Optional[Dict[str, str]],
    secrets: Optional[SecretRequest],
    max_inline_io_bytes: int | None,
    pod_template: Optional[Union[str, PodTemplate]],
    queue: Optional[str],
    interruptible: Optional[bool],
    kwargs: **kwargs,
) -> TaskTemplate

Override various parameters of the task template. This allows for dynamic configuration of the task when it is called, such as changing the image, resources, cache policy, etc.

Parameter	Type	Description
`short_name`	`Optional[str]`	Optional override for the short name of the task.
`resources`	`Optional[Resources]`	Optional override for the resources to use for the task.
`cache`	`Optional[CacheRequest]`	Optional override for the cache policy for the task.
`retries`	`Union[int, RetryStrategy]`	Optional override for the number of retries for the task.
`timeout`	`Optional[TimeoutType]`	Optional override for the timeout for the task.
`reusable`	`Union[ReusePolicy, Literal['off'], None]`	Optional override for the reusability policy for the task.
`env_vars`	`Optional[Dict[str, str]]`	Optional override for the environment variables to set for the task.
`secrets`	`Optional[SecretRequest]`	Optional override for the secrets that will be injected into the task at runtime.
`max_inline_io_bytes`	`int \| None`	Optional override for the maximum allowed size (in bytes) for all inputs and outputs passed directly to the task.
`pod_template`	`Optional[Union[str, PodTemplate]]`	Optional override for the pod template to use for the task.
`queue`	`Optional[str]`	Optional override for the queue to use for the task.
`interruptible`	`Optional[bool]`
`kwargs`	`**kwargs`	Additional keyword arguments for further overrides. Some fields like name, image, docs, and interface cannot be overridden. :return: A new TaskTemplate instance with the overridden parameters.

post()

        
    
def post(
    return_vals: Any,
) -> Any

This is the postexecute function that will be called after the task is executed

Parameter	Type	Description
`return_vals`	`Any`

pre()

        
    
def pre(
    args,
    kwargs,
) -> Dict[str, Any]

This is the preexecute function that will be called before the task is executed

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

sql()

        
    
def sql(
    sctx: SerializationContext,
) -> Optional[str]

Returns the SQL for the task. This is a set of key-value pairs that can be used to configure the task execution environment at runtime. This is usually used by plugins.

Parameter	Type	Description
`sctx`	`SerializationContext`

Properties

Property	Type	Description
`native_interface`	`None`
`source_file`	`None`	Returns the source file of the function, if available. This is useful for debugging and tracing.