EvaluatorException

class openff.evaluator.utils.exceptions.EvaluatorException(message=None)

A serializable wrapper around an Exception.

__init__(message=None)

Constructs a new EvaluatorException object.

Parameters

message (str or list of str) – Information about the raised exception.

Methods

__init__([message])	Constructs a new EvaluatorException object.
from_exception(exception)	Initialize this class from an existing exception.
from_json(file_path)	Create this object from a JSON file.
json([file_path, format])	Creates a JSON representation of this class.
parse_json(string_contents[, encoding])	Parses a typed json string into the corresponding class structure.

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, encoding='utf8')

Parses a typed json string into the corresponding class structure.

Parameters

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

• encoding (str) – The encoding of the string_contents.

Returns

The parsed class.

Return type

Any