6.72. umbra.reporter

reporter.py

Platform:
Windows, Linux, Mac Os X.
Description:
Defines the Reporter class and various others exceptions handling related objects.

Others:

6.72.1. Module Attributes

umbra.reporter.LOGGER
umbra.reporter.UI_FILE

6.72.2. Functions

umbra.reporter.baseExceptionHandler(*args)[source]

Provides a base exception handler.

Parameters:*args (*) – Arguments.
Returns:Definition success.
Return type:bool
umbra.reporter.systemExitExceptionHandler(*args)[source]

Provides a system exit exception handler.

Parameters:*args (*) – Arguments.
Returns:Definition success.
Return type:bool
umbra.reporter.criticalExceptionHandler(object)[source]

Marks an object that would system exit in case of critical exception.

Parameters:object (object) – Object to decorate.
Returns:Object.
Return type:object
umbra.reporter.installExceptionReporter(report=True)[source]

Installs the exceptions reporter.

Parameters:report (bool) – Report to Crittercism.
Returns:Reporter instance.
Return type:Reporter
umbra.reporter.uninstallExceptionReporter()[source]

Uninstalls the exceptions reporter.

Returns:Definition success.
Return type:bool
umbra.reporter.enableExceptionReporter()[source]

Enables the exceptions reporter.

Returns:Definition success.
Return type:bool
umbra.reporter.disableExceptionReporter()[source]

Disables the exceptions reporter.

Returns:Definition success.
Return type:bool

6.72.3. Classes

class umbra.reporter.Reporter(parent=None, report=True, enabled=True, *args, **kwargs)[source]

Bases: foundations.ui.common.QWidget

Defines an exception reporting Widget.

Initializes the class.

Parameters:
  • parent (QObject) – Object parent.
  • report (bool) – Report to Crittercism.
  • enabled (bool) – Is reporter enabled.
  • *args (*) – Arguments.
  • **kwargs (**) – Keywords arguments.
report[source]

Property for self.__report attribute.

Returns:self.__report.
Return type:bool
enabled[source]

Property for self.__enabled attribute.

Returns:self.__enabled.
Return type:bool
show()[source]

Reimplements the QWidget.show() method.

handleException(*args)[source]

Handles given exception.

Parameters:*args (*) – Arguments.
formatHtmlException(*args)[source]

Formats given exception as an html text.

Parameters:*args (*) – Arguments.
Returns:Exception html text.
Return type:unicode
formatTextException(*args)[source]

Formats given exception as a text.

Parameters:*args (*) – Arguments.
Returns:Exception text.
Return type:unicode
reportExceptionToCrittercism(*args)[source]

Reports given exception to Crittercism.

Parameters:*args (*) – Arguments.
Returns:Method success.
Return type:bool