Class BaseArgError

The base class for all the argument related RelaxErrors.

Instance Methods

__init__(self, name, value, size=None, dim=None, rank=None, can_be_none=False)
A default initialisation and error message formatting method.

Inherited from BaseError: __str__

Inherited from exceptions.Exception: __new__

Inherited from exceptions.BaseException: __delattr__, __getattribute__, __getitem__, __getslice__, __reduce__, __repr__, __setattr__, __setstate__, __unicode__

Inherited from object: __format__, __hash__, __reduce_ex__, __sizeof__, __subclasshook__

Class Variables

simple_types = []

list_types = []

Properties

Inherited from exceptions.BaseException: args, message

Inherited from object: __class__

Method Details

__init__(self, name, value, size=None, dim=None, rank=None, can_be_none=False)
(Constructor)

A default initialisation and error message formatting method.

Parameters:

• name (str) - The name of the argument.
• value (anything) - The argument's value.
• size (int or None) - The fixed size for list types.
• dim (tuple of (int or None)) - The expected dimensionality of the argument.
• rank (int or None) - The rank for list or array types.
• can_be_none (bool) - A flag specifying if the argument can be None. This will tag the text ', or None' to the end of the RelaxError.

Overrides: object.__init__