The exceptions module

The exceptions module contains definitions of common Exception classes which are used throughout the pyamp project to indicate errors to the programmer.

The FinalFunctionError class

class pyamp.exceptions.FinalFunctionError(classObj, functionName)

The FinalFunctionError class provides an Exception which is raised in the event that a class attempts to override a final function.

• classObj – The classObj (class, instance, or a string)
• functionName – The name of final function

The InvalidPropertyValueError class

class pyamp.exceptions.InvalidPropertyValueError(classObj, propName, value, expected)

The InvalidPropertyValueError is raised in the event that a class property has an unexpected, or invalid, value.

• classObj – The class obj (class, instance, or string name)
• propName – The name of the invalid property
• value – The invalid property value
• expected – The expected value for the property

The UndefinedFunctionError class

class pyamp.exceptions.UndefinedFunctionError(obj, functionName)

A class or object is missing a required function.

• obj – The class or object
• functionName – The name of the required function

The UndefinedPropertyError class

class pyamp.exceptions.UndefinedPropertyError(obj, propertyName)

A class or object is missing a required property.

• obj – The class or object
• propertyName – The name of the property that is required