Skip to main content
Ctrl+K

ewoksorange 5.0

  • Tutorials
  • How-to Guides
  • Reference
  • github
  • pypi
  • Tutorials
  • How-to Guides
  • Reference
  • github
  • pypi

Section Navigation

  • API documentation
    • ewoksorange
      • ewoksorange.bindings
        • ewoksorange.bindings.convert_graph
        • ewoksorange.bindings.execute_graph
        • ewoksorange.bindings.load_graph
        • ewoksorange.bindings.save_graph
        • ewoksorange.bindings.bindings
        • ewoksorange.bindings.events
        • ewoksorange.bindings.invalid_data
        • ewoksorange.bindings.owsconvert
        • ewoksorange.bindings.owsettings
        • ewoksorange.bindings.owsignal_manager
        • ewoksorange.bindings.owwidgets
        • ewoksorange.bindings.progress
        • ewoksorange.bindings.qtapp
        • ewoksorange.bindings.taskexecuter
        • ewoksorange.bindings.taskexecutor_queue
        • ewoksorange.bindings.taskwrapper
      • ewoksorange.canvas
        • ewoksorange.canvas.config
        • ewoksorange.canvas.handler
        • ewoksorange.canvas.main
        • ewoksorange.canvas.utils
      • ewoksorange.discovery
        • ewoksorange.discovery.widget_discovery
      • ewoksorange.engine
        • ewoksorange.engine.OrangeWorkflowEngine
      • ewoksorange.gui
        • ewoksorange.gui.canvas
        • ewoksorange.gui.concurrency
        • ewoksorange.gui.data_viewer
        • ewoksorange.gui.orange_imports
        • ewoksorange.gui.orange_utils
        • ewoksorange.gui.owwidgets
        • ewoksorange.gui.parameterform
        • ewoksorange.gui.qt_utils
        • ewoksorange.gui.qtsignals
        • ewoksorange.gui.simpletypesmixin
        • ewoksorange.gui.utils
        • ewoksorange.gui.widgets
        • ewoksorange.gui.workflows
      • ewoksorange.orange_version
      • ewoksorange.pkg_meta
        • ewoksorange.pkg_meta.get_distribution
        • ewoksorange.pkg_meta.get_distribution_name
      • ewoksorange.registration
      • ewoksorange.tests
        • ewoksorange.tests.conftest
        • ewoksorange.tests.examples
        • ewoksorange.tests.test_OneThreadPerRun
        • ewoksorange.tests.test_custom_signals
        • ewoksorange.tests.test_default_values
        • ewoksorange.tests.test_default_widget
        • ewoksorange.tests.test_dynamic_link
        • ewoksorange.tests.test_examples
        • ewoksorange.tests.test_execute_task
        • ewoksorange.tests.test_hidden_variables
        • ewoksorange.tests.test_link_value_data_type
        • ewoksorange.tests.test_listoperations
        • ewoksorange.tests.test_native_tasks
        • ewoksorange.tests.test_ows_conversion
        • ewoksorange.tests.test_parameterform
        • ewoksorange.tests.test_sumtask
        • ewoksorange.tests.test_task_executor
        • ewoksorange.tests.test_tasks
        • ewoksorange.tests.test_tutorials
        • ewoksorange.tests.test_widget_name
        • ewoksorange.tests.test_workflow_events
        • ewoksorange.tests.utils
  • Reference
  • API documentation
  • ewoksorange
  • ewoksorange.tests
  • ewoksorange.tests.test_dynamic_link
  • ewoksorange.tests.test_dynamic_link.EwoksTask

ewoksorange.tests.test_dynamic_link.EwoksTask#

class ewoksorange.tests.test_dynamic_link.EwoksTask(inputs=None, varinfo=None, node_id=None, node_attrs=None, execinfo=None, profile_directory=None)[source]#

Bases: Task

Parameters:
  • inputs (Optional[Mapping])

  • varinfo (Optional[dict])

  • node_id (Union[str, int, tuple, None])

  • node_attrs (Optional[dict])

  • execinfo (Optional[dict])

  • profile_directory (Optional[dict])

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: bool#

Completed (with or without exception)

property exception: Exception | None#
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: bool#

Completed with exception

fix_uhash()#

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

get_input_uhashes()#
get_input_value(key, default=<MISSING_DATA>)#
Parameters:

default (Any)

Return type:

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)

Return type:

Any

get_output_values()#
get_positional_input_values()#
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_model()#
Return type:

Optional[Type[BaseInputModel]]

classmethod input_names()#
Return type:

Set[str]

property input_uhashes#
property input_values#

DEPRECATED

property input_variables: VariableContainer#
property inputs: ReadOnlyVariableContainerNamespace#
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

Returns Task:

property is_ready_to_execute#
property job_id: str | None#
property label: str#
property missing_inputs: VariableContainerMissingNamespace#
property missing_outputs: VariableContainerMissingNamespace#
property n_positional_inputs: int#
classmethod n_required_positional_inputs()#
Return type:

int

property named_input_values#

DEPRECATED

property node_id: str | int | tuple#
property npositional_inputs#

DEPRECATED

classmethod optional_input_names()#
Return type:

Set[str]

property output_metadata: dict | None#
classmethod output_model()#
Return type:

Optional[Type[BaseOutputModel]]

classmethod output_names()#
Return type:

Set[str]

property output_transfer_data#

DEPRECATED

property output_uhashes#

DEPRECATED

property output_values#

DEPRECATED

property output_variables: VariableContainer#
property outputs: VariableContainerNamespace#
property positional_input_values#

DEPRECATED

classmethod required_input_names()#
Return type:

Set[str]

reset_state()#
run()[source]#

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: bool#

Completed without exception and with output values

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

previous

ewoksorange.tests.test_dynamic_link.EwoksOrangeWidget

next

ewoksorange.tests.test_dynamic_link.Mother

On this page
  • EwoksTask
    • EwoksTask.MISSING_DATA
    • EwoksTask.assert_ready_to_execute()
    • EwoksTask.cancel()
    • EwoksTask.cancelled
    • EwoksTask.class_nonce()
    • EwoksTask.class_nonce_data()
    • EwoksTask.class_registry_name()
    • EwoksTask.cleanup_references()
    • EwoksTask.done
    • EwoksTask.exception
    • EwoksTask.execute()
    • EwoksTask.failed
    • EwoksTask.fix_uhash()
    • EwoksTask.get_input_uhashes()
    • EwoksTask.get_input_value()
    • EwoksTask.get_input_values()
    • EwoksTask.get_named_input_values()
    • EwoksTask.get_output_transfer_data()
    • EwoksTask.get_output_uhashes()
    • EwoksTask.get_output_value()
    • EwoksTask.get_output_values()
    • EwoksTask.get_positional_input_values()
    • EwoksTask.get_subclass()
    • EwoksTask.get_subclass_names()
    • EwoksTask.get_subclasses()
    • EwoksTask.get_uhash_init()
    • EwoksTask.input_model()
    • EwoksTask.input_names()
    • EwoksTask.input_uhashes
    • EwoksTask.input_values
    • EwoksTask.input_variables
    • EwoksTask.inputs
    • EwoksTask.instance_nonce()
    • EwoksTask.instantiate()
    • EwoksTask.is_ready_to_execute
    • EwoksTask.job_id
    • EwoksTask.label
    • EwoksTask.missing_inputs
    • EwoksTask.missing_outputs
    • EwoksTask.n_positional_inputs
    • EwoksTask.n_required_positional_inputs()
    • EwoksTask.named_input_values
    • EwoksTask.node_id
    • EwoksTask.npositional_inputs
    • EwoksTask.optional_input_names()
    • EwoksTask.output_metadata
    • EwoksTask.output_model()
    • EwoksTask.output_names()
    • EwoksTask.output_transfer_data
    • EwoksTask.output_uhashes
    • EwoksTask.output_values
    • EwoksTask.output_variables
    • EwoksTask.outputs
    • EwoksTask.positional_input_values
    • EwoksTask.required_input_names()
    • EwoksTask.reset_state()
    • EwoksTask.run()
    • EwoksTask.set_uhash_init()
    • EwoksTask.succeeded
    • EwoksTask.task_identifier
    • EwoksTask.uhash
    • EwoksTask.uhash_randomize()
    • EwoksTask.undo_fix_uhash()
    • EwoksTask.undo_randomize()
    • EwoksTask.workflow_id
Show Source

© Copyright 2021-2025, ESRF.

ewoksorange 5.0.1