Action documentation

Package containing all actions and their abstract base.

Abstract action

Module for executing actions

class sequence.action.abstract.AbstractAction(name, module, iteration, tick, parameters)

Class providing a basis for action creation and execution

all_ok()

Return True if everything went good

critical(msg)

Logging method with critical level

debug(msg)

Logging method with debug level

error(msg)

Logging method with error level

execute(stop_thread, log_dict)

Execute action and log it with the stop mecanism and logging dictionary

info(msg)

Logging method with info level

post_run()

Post-run execution

pre_run()

Pre-run execution

pre_run_ok()

Return True if pre-run went good

run()

Run execution

classmethod set_default_parameters(params)

Class method to update default parameters

warning(msg)

Logging method with warning level

exception sequence.action.abstract.ActionCreationError(strerror)

Custom error raised when an action creation error is detected

class sequence.action.abstract.BaseEnum

Base class for enumerations in action parameters

sequence.action.abstract.cast_parameters(xml_block, default_parameters)

Cast parameters of an xml block with the default parameters

sequence.action.abstract.create_action(xml_block)

Create an action from an xml block

sequence.action.abstract.enum_type(*args)

Create an enumeration from string arguments

sequence.action.abstract.get_action_from_module(module)

Import a module to get the action class.

sequence.action.abstract.get_action_list()

Get the list of available actions

sequence.action.abstract.parse_default_parameters(parameters)

Return a dictionnary from the default parameters string

sequence.action.abstract.patch_action_package(arg)

Patch the actions with a path or a list of path.

sequence.action.abstract.process_module(module_name, with_parameters=True)

Process a module to get the action class and default parameters

Debug actions

Package containing the debug actions.

User actions

Package containing the user-defined actions.

Use the sequence.patch_action_package function to append paths of other user-defined actions directories.

Tango actions

Package containing the Tango actions.