spug.util.StdError
index
/home/mmuller/w/spug/util/StdError.py

Standard error classes and utilities.

 
Modules
       
string
traceback

 
Classes
       
exceptions.Exception(exceptions.BaseException)
util.StdError.BadParmError
util.StdError.FileParseError
util.StdError.ImplementedBySubclassError
util.StdError.AdditionalText

 
class AdditionalText
    Mix-in for exception classes that allow text to be added at several levels
of exception handling.
 
  Methods defined here:
__init__(self, text=None)
addText(self, newText)
Adds /newText/ to the exception text list.
getText(self)
Returns the complete exception text as a single string, with individual
exception items seperated by newlines.

 
class BadParmError(exceptions.Exception)
    This should be raised by a function when a parameter value is not what
it expected.
 
XXX obsolete - didn't know about ValueError.
 
 
Method resolution order:
BadParmError
exceptions.Exception
exceptions.BaseException
__builtin__.object

Data descriptors defined here:
__weakref__
list of weak references to the object (if defined)

Methods inherited from exceptions.Exception:
__init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Data and other attributes inherited from exceptions.Exception:
__new__ = <built-in method __new__ of type object at 0x8140ce0>
T.__new__(S, ...) -> a new object with type S, a subtype of T

Methods inherited from exceptions.BaseException:
__delattr__(...)
x.__delattr__('name') <==> del x.name
__getattribute__(...)
x.__getattribute__('name') <==> x.name
__getitem__(...)
x.__getitem__(y) <==> x[y]
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
 
Use of negative indices is not supported.
__reduce__(...)
__repr__(...)
x.__repr__() <==> repr(x)
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
__setstate__(...)
__str__(...)
x.__str__() <==> str(x)

Data descriptors inherited from exceptions.BaseException:
__dict__
args
message
exception message

 
class FileParseError(exceptions.Exception)
    Raised when a parse error is encountered while reading a text file.
If the file is a LineReader, source location information is available.
 
 
Method resolution order:
FileParseError
exceptions.Exception
exceptions.BaseException
__builtin__.object

Methods defined here:
__init__(self, file, text, lineNum=None)
Constructs a FileFormatError from a file object and a message text
string. 
 
If a line number is explicitly provided or a LineReader
object is used for /file/, the line number of the error is made
available.
__str__(self)
Creates a string containing source information
getLineNum(self)
Returns the line number of the source file in which the error
occurred. Returns *None* if the file object was not a lineReader.
getSourceName(self)
Returns the name of the source file.

Data descriptors defined here:
__weakref__
list of weak references to the object (if defined)

Data and other attributes inherited from exceptions.Exception:
__new__ = <built-in method __new__ of type object at 0x8140ce0>
T.__new__(S, ...) -> a new object with type S, a subtype of T

Methods inherited from exceptions.BaseException:
__delattr__(...)
x.__delattr__('name') <==> del x.name
__getattribute__(...)
x.__getattribute__('name') <==> x.name
__getitem__(...)
x.__getitem__(y) <==> x[y]
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
 
Use of negative indices is not supported.
__reduce__(...)
__repr__(...)
x.__repr__() <==> repr(x)
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
__setstate__(...)

Data descriptors inherited from exceptions.BaseException:
__dict__
args
message
exception message

 
class ImplementedBySubclassError(exceptions.Exception)
    This should be raised by a functions that exist in base classes that
should be overriden by a subclass.
 
XXX this class is obsolete - I didn't understand that *NotImplemented*
is used for this.
 
 
Method resolution order:
ImplementedBySubclassError
exceptions.Exception
exceptions.BaseException
__builtin__.object

Methods defined here:
__init__(self, txt='')

Data descriptors defined here:
__weakref__
list of weak references to the object (if defined)

Data and other attributes inherited from exceptions.Exception:
__new__ = <built-in method __new__ of type object at 0x8140ce0>
T.__new__(S, ...) -> a new object with type S, a subtype of T

Methods inherited from exceptions.BaseException:
__delattr__(...)
x.__delattr__('name') <==> del x.name
__getattribute__(...)
x.__getattribute__('name') <==> x.name
__getitem__(...)
x.__getitem__(y) <==> x[y]
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
 
Use of negative indices is not supported.
__reduce__(...)
__repr__(...)
x.__repr__() <==> repr(x)
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
__setstate__(...)
__str__(...)
x.__str__() <==> str(x)

Data descriptors inherited from exceptions.BaseException:
__dict__
args
message
exception message

 
Functions
       
errorText(ex)
Returns the complete error text for the exception, just as the python
interpreter would have formatted it, as a multi line string.
 
This must be called from an exception handler.
 
This function isn't really very different from 
`traceback.format_exception()` - except that it can be used in 1.5.1
and I'm not sure if `format_exception` can.
exlocstr(exinfo=None)
Creates a stack trace from the given exception info (should be the
returned from `sys.exc_info()`, the value of the current exception info
is used if none is supplied).
   
Returns the stack trace represented as a multi-line string.
 
Deprecated.  Use errorText() instead.