WorkflowException

exception openff.evaluator.workflow.WorkflowException(message=None, protocol_id=None)[source]

An exception which was raised while executing a workflow protocol.

classmethod from_exception(exception)

Initialize this class from an existing exception.

Parameters

exception (Exception) – The existing exception

Returns

The initialized exception object.

Return type

cls

classmethod from_json(file_path)

Create this object from a JSON file.

Parameters

file_path (str) – The path to load the JSON from.

Returns

The parsed class.

Return type

cls

json(file_path=None, format=False)

Creates a JSON representation of this class.

Parameters

  • file_path (str, optional) – The (optional) file path to save the JSON file to.

  • format (bool) – Whether to format the JSON or not.

Returns

The JSON representation of this class.

Return type

str

classmethod parse_json(string_contents)

Parses a typed json string into the corresponding class structure.

Parameters

string_contents (str or bytes) – The typed json string.

Returns

The parsed class.

Return type

Any

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.