exopy.app.log.plugin module¶
Log plugin definition.
-
class
exopy.app.log.plugin.
LogPlugin
[source]¶ Bases:
enaml.workbench.plugin.Plugin
Plugin managing the application logging.
-
handler_ids
¶ List of installed handlers.
-
filter_ids
¶ List of installed filters.
-
gui_model
¶ Model which can be used to display the log in the GUI. It is associated to a handler attached to the root logger.
-
add_handler
(id, handler=None, logger='', mode=None)[source]¶ Add a handler to the specified logger.
- Parameters
id (unicode) – Id of the new handler. This id should be unique.
handler (logging.Handler, optional) – Handler to add.
logger (unicode, optional) – Name of the logger to which the handler should be added. By default the handler is added to the root logger.
mode ({'ui', }, optional) – Conveninence to add a simple logger. If this argument is specified, handler will be ignored and the command will return useful references (the model to which can be connected a ui for the ‘ui’ mode).
- Returns
refs – List of useful reference, empty if no mode is selected.
- Return type
-
remove_handler
(id)[source]¶ Remove the specified handler.
- Parameters
id (unicode) – Id of the handler to remove.
-
add_filter
(id, filter, handler_id)[source]¶ Add a filter to the specified handler.
- Parameters
id (unicode) – Id of the filter to add.
filter (object) – Filter to add to the specified handler (object implemeting a filter method).
handler_id (unicode) – Id of the handler to which this filter should be added
-