hwm.command.command.CommandError Class Reference

A general purpose exception thrown in the event that a command fails. More...

Inheritance diagram for hwm.command.command.CommandError:

Public Member Functions
def	__init__
	Sets up the command error. More...
def	__str__

Public Attributes
	message
	error_parameters

Detailed Description

A general purpose exception thrown in the event that a command fails.

It allows command handlers to embed additional metadata with the failure in the form of a dictionary passed to the exception.

Constructor & Destructor Documentation

def hwm.command.command.CommandError.__init__	(		self,
			command_error_message,
			error_data = None
	)

Sets up the command error.

Parameters

command_error_message	A string summarizing the failure.
error_data	A simple dictionary containing additional fields to be passed with the error response.

---

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

• hwm/command/command.py