robot.api.exceptions.Error Class Reference

Report error in execution. More...

Inheritance diagram for robot.api.exceptions.Error:

Public Member Functions
def	__init__ (self, message, html=False)
	:param message: Exception message. More...

Static Public Attributes
bool	ROBOT_SUPPRESS_NAME = True

Detailed Description

Report error in execution.

Failures related to the system not behaving as expected should typically be
reported using the :class:`Failure` exception or the standard ``AssertionError``.
This exception can be used, for example, if the keyword is used incorrectly.

There is no practical difference in using this exception compared to using
the standard ``RuntimeError``. The main benefits are HTML support and that
the name of this exception is consistent with other exceptions in this module.

Definition at line 57 of file exceptions.py.

Constructor & Destructor Documentation

__init__()

def robot.api.exceptions.Error.__init__	(		self,
			message,
			html = False
	)

:param message: Exception message.

:param html: When True, message is considered to be HTML and not escaped.

Definition at line 64 of file exceptions.py.

Member Data Documentation

ROBOT_SUPPRESS_NAME

bool robot.api.exceptions.Error.ROBOT_SUPPRESS_NAME = True

static

Definition at line 58 of file exceptions.py.

---

The documentation for this class was generated from the following file:

• src/robot/api/exceptions.py