pts.utils.error.UserError Class Reference

An instance of this class should be raised by PTS scripts when a fatal problem is most likely caused by a user error as opposed to a programming error. More...

Public Member Functions
def	__init__ (self, message)
	The constructor accepts the error message (a string) that will be reported to the user. More...

Public Attributes
	message

Detailed Description

An instance of this class should be raised by PTS scripts when a fatal problem is most likely caused by a user error as opposed to a programming error.

This allows top-level code (such as the code supporting the execution of PTS scripts from the command line) to catch these errors and report them in a user-friendly manner (for example, show usage help instead of a stack trace).

Constructor & Destructor Documentation

__init__()

def pts.utils.error.UserError.__init__	(		self,
			message
	)

The constructor accepts the error message (a string) that will be reported to the user.

---

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

• error.py