avid.common.workflow.Session

class avid.common.workflow.Session(name=None, root_path=None, auto_save=False, interim_session_save=False, interim_save_interval=1, debug=False, auto_error_report=False, auto_warning_report=False)

Bases: object

__init__(name=None, root_path=None, auto_save=False, interim_session_save=False, interim_save_interval=1, debug=False, auto_error_report=False, auto_warning_report=False)

Methods

`__init__`([name, root_path, auto_save, ...])
`addProcessedActionInstance`(action)	Adds an action to the session instance as processed action
`add_artefact`(artefact_entry)	This method adds an arbitrary artefact entry to the artefact collection.
`getFailedActions`()	Returns all actions of the session that have failed.
`getNumberOfPatientsDecorator`(patNoFunc)
`getSkippedActions`()	Returns all actions of the session that have been skipped.
`getSuccessfulActions`()	Returns all actions of the session that have been successful.
`getSuccessfulActionsWithWarnings`()	Returns all actions of the session that have been successful but with warnings.
`hasFailedActions`()	An project is defined as failed, if at least on action the project depends on has failed.
`hasStructurePattern`(name)
`print`(args, *nargs)
`print_session_info`()
`registerBatchAction`(batch_action)
`run_batches`([from_action, up_to_action])	Method runs all registred batch actions of a session.
`setWorkflowActionTool`(actionID, entry)	adds a action entry to a dictionary and returns it overrides existing entry!

Attributes

`contentPath`	Path that is the root for all content/artefacts generated by the session.
`definedStructures`
`lastStoredLocationPath`	Path where the session last was stored to.
`rootPath`

addProcessedActionInstance(action): Adds an action to the session instance as processed action

add_artefact(artefact_entry): This method adds an arbitrary artefact entry to the artefact collection.

property contentPath: Path that is the root for all content/artefacts generated by the session.

getFailedActions(): Returns all actions of the session that have failed.

getSkippedActions(): Returns all actions of the session that have been skipped.

getSuccessfulActions(): Returns all actions of the session that have been successful.

getSuccessfulActionsWithWarnings(): Returns all actions of the session that have been successful but with warnings.

hasFailedActions(): An project is defined as failed, if at least on action the project depends on has failed. Retruns true if the project is assumed as failed. Returns true if all actions were successful or skipped

property lastStoredLocationPath: Path where the session last was stored to.

run_batches(from_action=None, up_to_action=None): Method runs all registred batch actions of a session. :param from_action: Controls from which batch action on the processing is started. None always starts at the first action. :param up_to_action: Controls up to which batch action the processing is conducted. The defined action will not be processed. The processing will stop directly before the action. None will start a processing up to, including the last batch action.

setWorkflowActionTool(actionID, entry): adds a action entry to a dictionary and returns it overrides existing entry!