ewoksxrpd.tasks.data_access.TaskWithDataAccess#

class ewoksxrpd.tasks.data_access.TaskWithDataAccess(*args, **kw)[source]#

Bases: TaskWithProgress

MISSING_DATA = <MISSING_DATA>#
assert_ready_to_execute()#
cancel()#

Function called when a task is cancelled. To be implemented by the derived classes

property cancelled: bool#

Return True if the task has been cancelled by the user

classmethod class_nonce()#
classmethod class_nonce_data()#
classmethod class_registry_name()#
Return type:

Optional[str]

cleanup_references()#

Removes all references to the inputs. Side effect: fixes the uhash of the task and outputs

property done#

Completed (with or without exception)

property exception#
execute(force_rerun=False, raise_on_error=True, cleanup_references=False)#
Parameters:

  • force_rerun (Optional[bool]) –

  • raise_on_error (Optional[bool]) –

  • cleanup_references (Optional[bool]) –

property failed#

Completed with exception

fix_uhash()#

Fix the uhash when it is derived from the uhash data.

get_data(*args, **kw)[source]#
get_image(*args, **kw)[source]#
get_input_uhashes()#
get_input_value(key, default=<MISSING_DATA>)#
Parameters:

default (Any) –

get_input_values()#
get_named_input_values()#
get_output_transfer_data()#

The values are either DataUri or Variable

get_output_uhashes()#
get_output_value(key, default=<MISSING_DATA>)#
Parameters:

default (Any) –

get_output_values()#
get_positional_input_values()#
get_retry_options()[source]#
classmethod get_subclass(registry_name, _second_attempt=False)#

Retrieving a derived class

classmethod get_subclass_names()#
Return type:

List[str]

classmethod get_subclasses()#
get_uhash_init(serialize=False)#
classmethod input_names()#
property input_uhashes#
property input_values#

DEPRECATED

property input_variables#
property inputs#
instance_nonce()#
classmethod instantiate(registry_name, **kw)#

Factory method for instantiating a derived class.

Parameters:

  • registry_name (str) – for example “tasklib.tasks.MyTask” or “MyTask”

  • **kw – Task constructor arguments

  • registry_name –

Returns Task:

property is_ready_to_execute#
iter_bliss_data(*args, **kw)[source]#
iter_bliss_data_from_memory(*args, **kw)[source]#
property job_id: str | None#
property label#
property missing_inputs#
property missing_outputs#
property named_input_values#

DEPRECATED

property node_id#
property npositional_inputs#
open_h5item(url, create=False, **openoptions)[source]#
Parameters:

  • url (Union[str, DataUrl]) –

  • create (bool) –

Return type:

Iterator[Union[Group, Dataset, ndarray]]

classmethod optional_input_names()#
property output_metadata: dict | None#
classmethod output_names()#
property output_transfer_data#

DEPRECATED

property output_uhashes#

DEPRECATED

property output_values#

DEPRECATED

property output_variables#
property outputs#
property positional_input_values#

DEPRECATED

property progress: int | None#

Task advancement. If a task progress is not provided then return None

classmethod required_input_names()#
reset_state()#
run()#

To be implemented by the derived classes

set_uhash_init(pre_uhash=None, instance_nonce=None)#
Parameters:

  • pre_uhash (Union[str, bytes, UniversalHash, HasUhash, None]) –

  • instance_nonce (Optional[Any]) –

property succeeded#

Completed without exception and with output values

property uhash: UniversalHash | None#
uhash_randomize()#
undo_fix_uhash()#
undo_randomize()#
property workflow_id: str | None#