est.core.process.io.ReadXasObject#
- class est.core.process.io.ReadXasObject(**kwargs)[source]#
Bases:
Process
- MISSING_DATA = <MISSING_DATA>#
- addCallback(callback)#
- property advancement#
- assert_ready_to_execute()#
- property callbacks#
- 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() str | None #
- cleanup_references()#
Removes all references to the inputs. Side effect: fixes the uhash of the task and outputs
- static definition()[source]#
- Returns:
definition of the process to be saved in HDF5
- Return type:
dict
- property done#
Completed (with or without exception)
- property exception#
- execute(force_rerun: bool | None = False, raise_on_error: bool | None = True, cleanup_references: bool | None = False)#
- property failed#
Completed with exception
- fix_uhash()#
Fix the uhash when it is derived from the uhash data.
- getConfiguration() dict #
- Returns:
parameters of the process to be saved in HDF5
- Return type:
dict
- get_input_uhashes()#
- get_input_value(key, default: ~typing.Any = <MISSING_DATA>)#
- 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: ~typing.Any = <MISSING_DATA>)#
- get_output_values()#
- get_positional_input_values()#
- classmethod get_subclass(registry_name, _second_attempt=False)#
Retrieving a derived class
- classmethod get_subclass_names() 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: str, **kw)#
Factory method for instantiating a derived class.
- Parameters:
registry_name (str) – for example “tasklib.tasks.MyTask” or “MyTask”
**kw – Task constructor arguments
- Returns Task:
- property is_ready_to_execute#
- property job_id: str | None#
- property label#
- property missing_inputs#
- property missing_outputs#
- property name: str#
- property named_input_values#
DEPRECATED
- property node_id#
- property npositional_inputs#
- 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
- program_name() str #
- Returns:
name of the process to be saved in HDF5
- Return type:
dict
- static program_version() str #
- Returns:
version of the process to be saved in HDF5
- Return type:
dict
- property progress: int | None#
Task advancement. If a task progress is not provided then return None
- classmethod required_input_names()#
- reset_state()#
- setConfiguration(configuration: dict)#
- set_uhash_init(pre_uhash: str | bytes | UniversalHash | HasUhash | None = None, instance_nonce: Any | None = None)#
- stop()#
- property succeeded#
Completed without exception and with output values
- property uhash: UniversalHash | None#
- uhash_randomize()#
- undo_fix_uhash()#
- undo_randomize()#
- update_properties(properties)#
- property workflow_id: str | None#