Skip to main content
Ctrl+K
ewoksorange 2.0.1 documentation - Home ewoksorange 2.0.1 documentation - Home
ewoksorange 2.0
  • How-to Guides ?
  • Tutorials
  • Development
  • ewoks orange API
  • GitLab
  • pypi
  • How-to Guides ?
  • Tutorials
  • Development
  • ewoks orange API
  • GitLab
  • pypi

Section Navigation

  • ewoksorange
    • ewoksorange.bindings
      • ewoksorange.bindings.bindings
        • ewoksorange.bindings.bindings.convert_graph
        • ewoksorange.bindings.bindings.execute_graph
        • ewoksorange.bindings.bindings.load_graph
        • ewoksorange.bindings.bindings.ows_file_context
        • ewoksorange.bindings.bindings.save_graph
      • ewoksorange.bindings.events
        • ewoksorange.bindings.events.scheme_ewoks_events
      • ewoksorange.bindings.invalid_data
        • ewoksorange.bindings.invalid_data.as_invalidation
        • ewoksorange.bindings.invalid_data.as_missing
        • ewoksorange.bindings.invalid_data.is_invalid_data
      • ewoksorange.bindings.owsconvert
        • ewoksorange.bindings.owsconvert.ewoks_to_ows
        • ewoksorange.bindings.owsconvert.graph_is_supported
        • ewoksorange.bindings.owsconvert.node_data_to_default_inputs
        • ewoksorange.bindings.owsconvert.ows_to_ewoks
        • ewoksorange.bindings.owsconvert.read_ows
        • ewoksorange.bindings.owsconvert.task_to_widget
        • ewoksorange.bindings.owsconvert.task_to_widgets
        • ewoksorange.bindings.owsconvert.widget_to_task
        • ewoksorange.bindings.owsconvert.write_ows
        • ewoksorange.bindings.owsconvert.OwsNodeWrapper
        • ewoksorange.bindings.owsconvert.OwsSchemeWrapper
      • ewoksorange.bindings.owsettings
        • ewoksorange.bindings.owsettings.get_settings
        • ewoksorange.bindings.owsettings.is_setting
      • ewoksorange.bindings.owsignal_manager
        • ewoksorange.bindings.owsignal_manager.can_enable_dynamic_patch
        • ewoksorange.bindings.owsignal_manager.patch_signal_manager
        • ewoksorange.bindings.owsignal_manager.set_input_value
        • ewoksorange.bindings.owsignal_manager.SignalManagerWithOutputTracking
        • ewoksorange.bindings.owsignal_manager.SignalManagerWithScheme
        • ewoksorange.bindings.owsignal_manager.SignalManagerWithoutScheme
      • ewoksorange.bindings.owsignals
        • ewoksorange.bindings.owsignals.get_ewoks_to_orange_mapping
        • ewoksorange.bindings.owsignals.get_input_names
        • ewoksorange.bindings.owsignals.get_orange_to_ewoks_mapping
        • ewoksorange.bindings.owsignals.get_output_names
        • ewoksorange.bindings.owsignals.get_signal_container
        • ewoksorange.bindings.owsignals.get_signals
        • ewoksorange.bindings.owsignals.is_signal
        • ewoksorange.bindings.owsignals.receive_dynamic_input
        • ewoksorange.bindings.owsignals.signal_ewoks_to_orange_name
        • ewoksorange.bindings.owsignals.signal_orange_to_ewoks_name
        • ewoksorange.bindings.owsignals.validate_inputs
        • ewoksorange.bindings.owsignals.validate_outputs
      • ewoksorange.bindings.owwidgets
        • ewoksorange.bindings.owwidgets.is_ewoks_widget
        • ewoksorange.bindings.owwidgets.is_ewoks_widget_class
        • ewoksorange.bindings.owwidgets.is_native_widget
        • ewoksorange.bindings.owwidgets.is_native_widget_class
        • ewoksorange.bindings.owwidgets.is_orange_widget
        • ewoksorange.bindings.owwidgets.is_orange_widget_class
        • ewoksorange.bindings.owwidgets.prepare_OWEwoksWidgetclass
        • ewoksorange.bindings.owwidgets.summarize_object
        • ewoksorange.bindings.owwidgets.summarize_variable
        • ewoksorange.bindings.owwidgets.OWEwoksBaseWidget
        • ewoksorange.bindings.owwidgets.OWEwoksWidgetNoThread
        • ewoksorange.bindings.owwidgets.OWEwoksWidgetOneThread
        • ewoksorange.bindings.owwidgets.OWEwoksWidgetOneThreadPerRun
        • ewoksorange.bindings.owwidgets.OWEwoksWidgetWithTaskStack
      • ewoksorange.bindings.progress
        • ewoksorange.bindings.progress.QProgress
      • ewoksorange.bindings.qtapp
        • ewoksorange.bindings.qtapp.absorb_nonbase_exception
        • ewoksorange.bindings.qtapp.close_qtapp
        • ewoksorange.bindings.qtapp.ensure_qtapp
        • ewoksorange.bindings.qtapp.get_all_qtwidgets
        • ewoksorange.bindings.qtapp.get_qtapp
        • ewoksorange.bindings.qtapp.process_qtapp_events
        • ewoksorange.bindings.qtapp.qt_message_handler
        • ewoksorange.bindings.qtapp.qtapp_context
        • ewoksorange.bindings.qtapp.QtEvent
      • ewoksorange.bindings.taskexecutor
        • ewoksorange.bindings.taskexecutor.TaskExecutor
        • ewoksorange.bindings.taskexecutor.ThreadedTaskExecutor
      • ewoksorange.bindings.taskexecutor_queue
        • ewoksorange.bindings.taskexecutor_queue.TaskExecutorQueue
      • ewoksorange.bindings.taskwrapper
        • ewoksorange.bindings.taskwrapper.execute_ewoks_owwidget
        • ewoksorange.bindings.taskwrapper.execute_native_owwidget
        • ewoksorange.bindings.taskwrapper.instantiate_owwidget
        • ewoksorange.bindings.taskwrapper.owwidget_task_wrapper
    • ewoksorange.canvas
      • ewoksorange.canvas.config
        • ewoksorange.canvas.config.widgets_entry_points
        • ewoksorange.canvas.config.Config
      • ewoksorange.canvas.handler
        • ewoksorange.canvas.handler.OrangeCanvasHandler
      • ewoksorange.canvas.main
        • ewoksorange.canvas.main.main
        • ewoksorange.canvas.main.temporary_log_handlers
      • ewoksorange.canvas.utils
        • ewoksorange.canvas.utils.get_orange_canvas
    • ewoksorange.discovery
      • ewoksorange.discovery.widget_discovery
    • ewoksorange.engine
      • ewoksorange.engine.OrangeWorkflowEngine
    • ewoksorange.gui
      • ewoksorange.gui.data_viewer
        • ewoksorange.gui.data_viewer.DataViewer
      • ewoksorange.gui.orange_imports
      • ewoksorange.gui.parameterform
        • ewoksorange.gui.parameterform.default_deserialize
        • ewoksorange.gui.parameterform.default_serialize
        • ewoksorange.gui.parameterform.ParameterForm
      • ewoksorange.gui.qtsignals
        • ewoksorange.gui.qtsignals.block_signals
      • ewoksorange.gui.simpletypesmixin
        • ewoksorange.gui.simpletypesmixin.IntegerAdderMixin
        • ewoksorange.gui.simpletypesmixin.SimpleTypesWidgetMixin
    • ewoksorange.oasys_patch
    • ewoksorange.orange_version
    • ewoksorange.pkg_meta
      • ewoksorange.pkg_meta.get_distribution
      • ewoksorange.pkg_meta.get_distribution_name
    • ewoksorange.registration
      • ewoksorange.registration.get_owwidget_descriptions
      • ewoksorange.registration.register_owwidget
      • ewoksorange.registration.widget_discovery
    • ewoksorange.tests
      • ewoksorange.tests.conftest
        • ewoksorange.tests.conftest.collect_garbage
        • ewoksorange.tests.conftest.ewoks_orange_canvas
        • ewoksorange.tests.conftest.global_cleanup_orange
        • ewoksorange.tests.conftest.global_cleanup_pytest
        • ewoksorange.tests.conftest.qtapp
        • ewoksorange.tests.conftest.raw_ewoks_orange_canvas
        • ewoksorange.tests.conftest.safe_session_fixture
        • ewoksorange.tests.conftest.warn_qtwidgets_alive
      • ewoksorange.tests.examples
        • ewoksorange.tests.examples.tasks
        • ewoksorange.tests.examples.widgets
      • ewoksorange.tests.test_OneThreadPerRun
        • ewoksorange.tests.test_OneThreadPerRun.test_OWEwoksWidgetOneThreadPerRun
        • ewoksorange.tests.test_OneThreadPerRun.DummyTask
        • ewoksorange.tests.test_OneThreadPerRun.MyObject
        • ewoksorange.tests.test_OneThreadPerRun.OWEwoksWidgetOneThreadPerRun
      • ewoksorange.tests.test_default_widget
        • ewoksorange.tests.test_default_widget.test_default_widgets
        • ewoksorange.tests.test_default_widget.Dummy
      • ewoksorange.tests.test_dynamic_link
        • ewoksorange.tests.test_dynamic_link.test_dynamic_link
        • ewoksorange.tests.test_dynamic_link.EwoksOrangeWidget
        • ewoksorange.tests.test_dynamic_link.EwoksTask
        • ewoksorange.tests.test_dynamic_link.Mother
        • ewoksorange.tests.test_dynamic_link.NativeWidget
        • ewoksorange.tests.test_dynamic_link.SubClass
      • ewoksorange.tests.test_examples
        • ewoksorange.tests.test_examples.test_convert_graph
        • ewoksorange.tests.test_examples.test_execute_graph
      • ewoksorange.tests.test_execute_task
        • ewoksorange.tests.test_execute_task.test_failure_with_output_changed_failure
        • ewoksorange.tests.test_execute_task.test_failure_with_propagation_and_output_changed_failure
        • ewoksorange.tests.test_execute_task.test_failure_with_propagation_failure
        • ewoksorange.tests.test_execute_task.test_success_with_output_changed_failure
        • ewoksorange.tests.test_execute_task.test_success_with_propagation_and_output_changed_failure
        • ewoksorange.tests.test_execute_task.test_success_with_propagation_failure
        • ewoksorange.tests.test_execute_task.test_task_init_failure
        • ewoksorange.tests.test_execute_task.test_task_run_failure
        • ewoksorange.tests.test_execute_task.test_task_success
        • ewoksorange.tests.test_execute_task.NoThreadTestWidget
        • ewoksorange.tests.test_execute_task.OneThreadPerRunTestWidget
        • ewoksorange.tests.test_execute_task.OneThreadTestWidget
        • ewoksorange.tests.test_execute_task.PatchCalls
        • ewoksorange.tests.test_execute_task.TaskForTesting
        • ewoksorange.tests.test_execute_task.TaskStackTestWidget
      • ewoksorange.tests.test_listoperations
        • ewoksorange.tests.test_listoperations.test_listgenerator
        • ewoksorange.tests.test_listoperations.test_printsum
        • ewoksorange.tests.test_listoperations.test_sumlist
      • ewoksorange.tests.test_ows_conversion
        • ewoksorange.tests.test_ows_conversion.test_ewoks_to_ows
        • ewoksorange.tests.test_ows_conversion.test_ows_to_ewoks_sumlist_tutorial
        • ewoksorange.tests.test_ows_conversion.test_ows_to_ewoks_sumtask_tutorial
      • ewoksorange.tests.test_parameterform
        • ewoksorange.tests.test_parameterform.test_parameterform
      • ewoksorange.tests.test_sumtask
        • ewoksorange.tests.test_sumtask.test_sumtask
        • ewoksorange.tests.test_sumtask.test_sumtask_missing_inputs
        • ewoksorange.tests.test_sumtask.test_sumtask_task_generator
      • ewoksorange.tests.test_task_executor
        • ewoksorange.tests.test_task_executor.test_cancel_current_task_in_task_executor_queue
        • ewoksorange.tests.test_task_executor.test_task_executor
        • ewoksorange.tests.test_task_executor.test_threaded_task_executor
        • ewoksorange.tests.test_task_executor.test_threaded_task_executor_queue
      • ewoksorange.tests.test_tasks
        • ewoksorange.tests.test_tasks.test_sumtask_task
        • ewoksorange.tests.test_tasks.test_sumtask_widget
      • ewoksorange.tests.test_tutorials
        • ewoksorange.tests.test_tutorials.assert_mixed_tutorial_with_qt
        • ewoksorange.tests.test_tutorials.assert_mixed_tutorial_without_qt
        • ewoksorange.tests.test_tutorials.assert_sumlist_tutorial_with_qt
        • ewoksorange.tests.test_tutorials.assert_sumlist_tutorial_without_qt
        • ewoksorange.tests.test_tutorials.assert_sumtask_tutorial_with_qt
        • ewoksorange.tests.test_tutorials.assert_sumtask_tutorial_without_qt
        • ewoksorange.tests.test_tutorials.test_list_operations_with_qt
        • ewoksorange.tests.test_tutorials.test_list_operations_without_qt
        • ewoksorange.tests.test_tutorials.test_mixed_tutorial_with_qt
        • ewoksorange.tests.test_tutorials.test_mixed_tutorial_without_qt
        • ewoksorange.tests.test_tutorials.test_sumtask_tutorial_with_qt
        • ewoksorange.tests.test_tutorials.test_sumtask_tutorial_without_qt
      • ewoksorange.tests.test_workflow_events
        • ewoksorange.tests.test_workflow_events.assert_failed_workfow_events
        • ewoksorange.tests.test_workflow_events.assert_succesfull_workfow_events
        • ewoksorange.tests.test_workflow_events.execute_graph
        • ewoksorange.tests.test_workflow_events.test_failed_workfow
        • ewoksorange.tests.test_workflow_events.test_succesfull_workfow
      • ewoksorange.tests.utils
        • ewoksorange.tests.utils.execute_task
  • ewoks orange API
  • 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[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

  • registry_name

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_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_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

This Page

  • Show Source

© Copyright 2021-2025, ESRF.

ewoksorange 2.0.1