Task Parameters Summary

:numref:task_arguments summarizes all arguments that can be found in the @task decorator.

Table 8 Arguments of the @task decorator

Argument

Value

Formal parameter name

(default: empty)

The parameter is an object or a simple tipe that will be inferred.

IN

Read-only parameter, all types.

IN_DELETE

Read-only parameter, all types. Automatic delete after usage.

INOUT

Read-write parameter, all types except file and primitives.

OUT

Write-only parameter, all types except file and primitives (requires default constructor).

CONCURRENT

Concurrent read-write parameter, all types except file and primitives.

COMMUTATIVE

Commutative read-write parameter, all types except file and primitives.

FILE(_IN)

Read-only file parameter.

FILE_INOUT

Read-write file parameter.

FILE_OUT

Write-only file parameter.

FILE_CONCURRENT

Concurrent read-write file parameter.

FILE_COMMUTATIVE

Commutative read-write file parameter.

DIRECTORY(_IN)

The parameter is a read-only directory.

DIRECTORY_INOUT

The parameter is a read-write directory.

DIRECTORY_OUT

the parameter is a write-only directory.

COLLECTION(_IN)

Read-only collection parameter (list).

COLLECTION_IN_DELETE

Single usage read-only collection parameter (list).

COLLECTION_INOUT

Read-write collection parameter (list).

COLLECTION_OUT

Read-only collection parameter (list).

COLLECTION_FILE(_IN)

Read-only collection of files parameter (list of files).

COLLECTION_FILE_INOUT

Read-write collection of files parameter (list of files).

COLLECTION_FILE_OUT

Read-only collection of files parameter (list of files).

DICTIONARY(_IN)

Read-only dictionary parameter (dict).

DICTIONARY_IN_DELETE

Single usage read-only collection dictionary (dict).

DICTIONARY_INOUT

Read-write dictionary parameter (dict).

STREAM_IN

The parameter is a read-only stream.

STREAM_OUT

The parameter is a write-only stream.

STDIN

The parameter is a file for standard input redirection (only for binaries).

STDOUT

The parameter is a file for standard output redirection (only for binaries).

STDERR

The parameter is a file for standard error redirection (only for binaries).

Explicit: {Type:(empty=object)/FILE/COLLECTION/DICTIONARY, Direction:(empty=IN)/IN/IN_DELETE/INOUT/OUT/CONCURRENT}

returns

Return type or number of returned elements

target_direction

INOUT (default), IN or CONCURRENT

priority

True or False (default)

is_distributed

True or False (default)

is_replicated

True or False (default)

on_failure

’RETRY’ (default), ’CANCEL_SUCCESSORS’, ’FAIL’ or ’IGNORE’

time_out

int (time in seconds)

cache_returns

True or False (default) - Requires to enable the cache

is_reduce

True or False (default)

chunk_size

Reduction chunk size (int)

numba

True or False (default) or mode (string)

numba_flags

Numba flags (dictionary of strings)

numba_signature

Numba signature (list of strings)

numba_declaration

Numba declaration (string)