workflow Package

modules Module

Modules used in building workflows

exception galaxy.workflow.modules.CancelWorkflowEvaluation

Bases: exceptions.Exception

exception galaxy.workflow.modules.DelayedWorkflowEvaluation

Bases: exceptions.Exception

class galaxy.workflow.modules.InputDataCollectionModule(trans)

Bases: galaxy.workflow.modules.InputModule

collection_type = 'list'

default_collection_type = 'list'

default_name = 'Input Dataset Collection'

classmethod default_state(Class)

get_data_outputs()

get_runtime_inputs(filter_set=['data'])

name = 'Input dataset collection'

state_fields = ['name', 'collection_type']

type = 'data_collection_input'

class galaxy.workflow.modules.InputDataModule(trans)

Bases: galaxy.workflow.modules.InputModule

default_name = 'Input Dataset'

classmethod default_state(Class)

get_data_outputs()

get_runtime_inputs(filter_set=['data'])

name = 'Input dataset'

state_fields = ['name']

type = 'data_input'

class galaxy.workflow.modules.InputModule(trans)

Bases: galaxy.workflow.modules.SimpleWorkflowModule

execute(trans, progress, invocation, step)

get_data_inputs()

get_runtime_input_dicts(step_annotation)

get_runtime_state()

recover_mapping(step, step_invocations, progress)

exception galaxy.workflow.modules.MissingToolException

Bases: exceptions.Exception

WorkflowModuleInjector will raise this if the tool corresponding to the module is missing.

class galaxy.workflow.modules.PauseModule(trans)

Bases: galaxy.workflow.modules.SimpleWorkflowModule

Initially this module will unconditionally pause a workflow - will aim to allow conditional pausing later on.

default_name = 'Pause for Dataset Review'

classmethod default_state(Class)

do_invocation_step_action(step, action)

Update or set the workflow invocation state action - generic extension point meant to allows users to interact with interactive workflow modules. The action object returned from this method will be attached to the WorkflowInvocationStep and be available the next time the workflow scheduler visits the workflow.

execute(trans, progress, invocation, step)

get_data_inputs()

get_data_outputs()

get_runtime_input_dicts(step_annotation)

get_runtime_inputs(**kwds)

get_runtime_state()

name = 'Pause for dataset review'

recover_mapping(step, step_invocations, progress)

state_fields = ['name']

type = 'pause'

class galaxy.workflow.modules.SimpleWorkflowModule(trans)

Bases: galaxy.workflow.modules.WorkflowModule

compute_runtime_state(trans, step_updates=None, source='html')

decode_runtime_state(trans, string)

classmethod default_state(Class)

This method should return a dictionary describing each configuration property and its default value.

encode_runtime_state(trans, state)

classmethod from_dict(Class, trans, d, secure=True)

classmethod from_workflow_step(Class, trans, step)

get_config_form()

get_state(secure=True)

classmethod new(Class, trans, tool_id=None)

normalize_runtime_state(runtime_state)

recover_runtime_state(runtime_state)

Take secure runtime state from persisted invocation and convert it into a DefaultToolState object for use during workflow invocation.

recover_state(state, **kwds)

Recover state dict from simple dictionary describing configuration state (potentially from persisted step state).

Sub-classes should supply default_state method and state_fields attribute which are used to build up the state dict.

save_to_step(step)

update_runtime_state(trans, state, values)

update_state(incoming)

class galaxy.workflow.modules.ToolModule(trans, tool_id, tool_version=None)

Bases: galaxy.workflow.modules.WorkflowModule

add_dummy_datasets(connections=None)

check_and_update_state()

compute_runtime_state(trans, step_updates=None, source='html')

encode_runtime_state(trans, state)

execute(trans, progress, invocation, step)

classmethod from_dict(Class, trans, d, secure=True)

classmethod from_workflow_step(Class, trans, step)

get_config_form()

get_data_inputs()

get_data_outputs()

get_errors()

get_name()

get_post_job_actions(incoming=None)

get_runtime_input_dicts(step_annotation)

get_state(secure=True)

get_tool_id()

get_tool_version()

get_tooltip(static_path='')

classmethod new(Class, trans, tool_id=None)

normalize_runtime_state(runtime_state)

recover_mapping(step, step_invocations, progress)

recover_runtime_state(runtime_state)

Take secure runtime state from persisted invocation and convert it into a DefaultToolState object for use during workflow invocation.

recover_state(state, **kwds)

Recover module configuration state property (a DefaultToolState object) using the tool’s params_from_strings method.

save_to_step(step)

type = 'tool'

update_state(incoming)

class galaxy.workflow.modules.WorkflowModule(trans)

Bases: object

add_dummy_datasets(connections=None)

check_and_update_state()

If the state is not in sync with the current implementation of the module, try to update. Returns a list of messages to be displayed

compute_runtime_state(trans, step_updates=None, source='html')

Determine the runtime state (potentially different from self.state which describes configuration state). This (again unlike self.state) is currently always a DefaultToolState object.

If step_updates is None, this is likely for rendering the run form for instance and no runtime properties are available and state must be solely determined by the default runtime state described by the step.

If step_updates are available they describe the runtime properties supplied by the workflow runner (potentially including a tool_state parameter which is the serialized default encoding state created with encode_runtime_state above).

do_invocation_step_action(step, action)

Update or set the workflow invocation state action - generic extension point meant to allows users to interact with interactive workflow modules. The action object returned from this method will be attached to the WorkflowInvocationStep and be available the next time the workflow scheduler visits the workflow.

encode_runtime_state(trans, state)

Encode the default runtime state at return as a simple str for use in a hidden parameter on the workflow run submission form.

This default runtime state will be combined with user supplied parameters in compute_runtime_state below at workflow invocation time to actually describe how each step will be executed.

execute(trans, progress, invocation, step)

Execute the given workflow step in the given workflow invocation. Use the supplied workflow progress object to track outputs, find inputs, etc...

classmethod from_dict(Class, trans, d)

Create a new instance of the module initialized from values in the dictionary d.

classmethod from_workflow_step(Class, trans, step)

get_config_form()

Render form that is embedded in workflow editor for modifying the step state of a node.

get_data_inputs()

Get configure time data input descriptions.

get_data_outputs()

get_errors()

It seems like this is effectively just used as boolean - some places in the tool shed self.errors is set to boolean, other places ‘unavailable’, likewise in Galaxy it stores a list containing a string with an unrecognized tool id error message.

get_name()

get_runtime_input_dicts(step_annotation)

Get runtime inputs (inputs and parameters) as simple dictionary.

get_runtime_inputs()

Used internally by modules and when displaying inputs in workflow editor and run workflow templates.

Note: The ToolModule doesn’t implement this and these templates contain specialized logic for dealing with the tool and state directly in the case of ToolModules.

get_state()

Return a serializable representation of the persistable state of the step - for tools it DefaultToolState.encode returns a string and for simpler module types a json description is dumped out.

get_tool_id()

get_tooltip(static_path='')

get_type()

classmethod new(Class, trans, tool_id=None)

Create a new instance of the module with default state

recover_mapping(step, step_invocations, progress)

Re-populate progress object with information about connections from previously executed steps recorded via step_invocations.

save_to_step(step)

update_state(incoming)

Update the current state of the module against the user supplied parameters in the dict-like object incoming.

class galaxy.workflow.modules.WorkflowModuleFactory(module_types)

Bases: object

from_dict(trans, d, **kwargs)

Return module initialized from the data in dictionary d.

from_workflow_step(trans, step)

Return module initializd from the WorkflowStep object step.

new(trans, type, tool_id=None)

Return module for type and (optional) tool_id intialized with new / default state.

class galaxy.workflow.modules.WorkflowModuleInjector(trans)

Bases: object

Injects workflow step objects from the ORM with appropriate module and module generated/influenced state.

inject(step, step_args=None, source='html')

Pre-condition: step is an ORM object coming from the database, if supplied step_args is the representation of the inputs for that step supplied via web form.

Post-condition: The supplied step has new non-persistent attributes useful during workflow invocation. These include ‘upgrade_messages’, ‘state’, ‘input_connections_by_name’, and ‘module’.

If step_args is provided from a web form this is applied to generate ‘state’ else it is just obtained from the database.

galaxy.workflow.modules.is_tool_module_type(module_type)

galaxy.workflow.modules.load_module_sections(trans)

Get abstract description of the workflow modules this Galaxy instance is configured with.

galaxy.workflow.modules.populate_module_and_state(trans, workflow, param_map)

Used by API but not web controller, walks through a workflow’s steps and populates transient module and state attributes on each.