robot.api.exceptions.Failure Class Reference

Exceptions that libraries can use for communicating failures and other events. More...

Inheritance diagram for robot.api.exceptions.Failure:

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

Static Public Attributes
bool	ROBOT_SUPPRESS_NAME = True

Detailed Description

Exceptions that libraries can use for communicating failures and other events.

These exceptions can be imported also via the top level :mod:robot.api package like from robot.api import SkipExecution.

This module and all exceptions are new in Robot Framework 4.0.

Report failed validation.

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

Definition at line 31 of file exceptions.py.

Constructor & Destructor Documentation

__init__()

def robot.api.exceptions.Failure.__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 38 of file exceptions.py.

Member Data Documentation

ROBOT_SUPPRESS_NAME

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

static

Definition at line 32 of file exceptions.py.

---

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

• src/robot/api/exceptions.py