Add preditor.plug.loggerwindow plugin support

Standardize the names of the LoggerWindow's sub-menus for ease of use in plugin development.

Author: MHendricks

README.md

@@ -165,6 +165,11 @@ added in [setup.cfg](setup.cfg).
 implementing a workbox. See [workbox_mixin.py](preditor/gui/workbox_mixin.py)
 for the full interface to implement all features of an editor.
 
+* `preditor.plug.loggerwindow`: Used to customize the LoggerWindow instance when
+the LoggerWindow is created. For example, this can be used to create extra Toolbars
+or add menu items. When using this plugin, make sure to use the
+`preditor.gui.logger_window_plugin.LoggerWindowPlugin` class for your base class.
+
 * `preditor.plug.logging_handlers`: Used to add custom python logging handlers
 to the LoggingLevelButton's handlers sub-menus. This allows you to install a
 handler instance on a specific logging object.

preditor/gui/logger_window_plugin.py

@@ -0,0 +1,32 @@
+class LoggerWindowPlugin:
+    """Base class for LoggerWindow plugins.
+
+    These plugins are loaded using the `preditor.plug.loggerwindow` entry point.
+    This entry point is loaded when `LoggerWindow` is initialized. For each entry
+    point defined a single instance of the plugin is created per instance of
+    a LoggerWindow.
+
+    To save preferences override `record_prefs` and `restore_prefs` methods. These
+    are used to save and load preferences any time the PrEditor save/loads prefs.
+    """
+
+    def __init__(self, parent):
+        self.parent = parent
+
+    def record_prefs(self, name):
+        """Returns any prefs to save with the PrEditor's preferences.
+
+        Returns:
+            dict: A dictionary that will be saved using json or None.
+        """
+
+    def restore_prefs(self, name, prefs):
+        """Restore the preferences saved from a previous launch.
+
+        Args:
+            name(str): The name specified by the `preditor.plug.loggerwindow`
+                entry point.
+            prefs(dict or None): The prefs returned by a previous call to
+                `record_prefs()` from the last preference save. None is passed
+                if no prefs were recorded.
+        """

preditor/gui/loggerwindow.py

@@ -287,6 +287,12 @@ def __init__(self, parent, name=None, run_workbox=False, standalone=False):
         self.addAction(self.uiClearLogACT)
 
         self.dont_ask_again = []
+
+        # Load any plugins that modify the LoggerWindow
+        self.plugins = {}
+        for name, plugin in plugins.loggerwindow():
+            self.plugins[name] = plugin(self)
+
         self.restorePrefs()
 
         # add stylesheet menu options.
@@ -823,6 +829,13 @@ def recordPrefs(self, manual=False):
 
         pref['editor_cls'] = self.editor_cls_name
 
+        # Allow any plugins to add their own preferences dictionary
+        pref["plugins"] = {}
+        for name, plugin in self.plugins.items():
+            plugin_pref = plugin.record_prefs(name)
+            if plugin_pref:
+                pref["plugins"][name] = plugin_pref
+
         self.save_prefs(pref)
 
     def load_prefs(self):
@@ -973,6 +986,10 @@ def restorePrefs(self):
 
         self.dont_ask_again = pref.get('dont_ask_again', [])
 
+        # Allow any plugins to restore their own preferences
+        for name, plugin in self.plugins.items():
+            plugin.restore_prefs(name, pref.get("plugins", {}).get(name))
+
     def restoreToolbars(self, pref=None):
         if pref is None:
             pref = self.load_prefs()

preditor/gui/ui/loggerwindow.ui

@@ -92,7 +92,7 @@
      <x>0</x>
      <y>0</y>
      <width>796</width>
-     <height>29</height>
+     <height>21</height>
     </rect>
    </property>
    <widget class="QMenu" name="uiDebugMENU">
@@ -105,7 +105,7 @@
     <addaction name="uiLogToFileACT"/>
     <addaction name="uiLogToFileClearACT"/>
    </widget>
-   <widget class="QMenu" name="uiScriptingMENU">
+   <widget class="QMenu" name="uiFileMENU">
     <property name="title">
      <string comment="File Menu">&amp;File</string>
     </property>
@@ -120,19 +120,19 @@
     <property name="title">
      <string>Help</string>
     </property>
-    <widget class="QMenu" name="menuPreferences">
+    <widget class="QMenu" name="uiPreferencesMENU">
      <property name="title">
       <string>Preferences</string>
      </property>
      <addaction name="uiBrowsePreferencesACT"/>
      <addaction name="uiBackupPreferencesACT"/>
     </widget>
-    <addaction name="menuPreferences"/>
+    <addaction name="uiPreferencesMENU"/>
     <addaction name="uiEnvironmentVarsACT"/>
     <addaction name="separator"/>
     <addaction name="uiAboutPreditorACT"/>
    </widget>
-   <widget class="QMenu" name="menu_Run">
+   <widget class="QMenu" name="uiRunMENU">
     <property name="title">
      <string>Run</string>
     </property>
@@ -144,7 +144,7 @@
     <addaction name="uiClearToLastPromptACT"/>
     <addaction name="uiSelectTextACT"/>
    </widget>
-   <widget class="QMenu" name="uiFileMENU">
+   <widget class="QMenu" name="uiOptionsMENU">
     <property name="title">
      <string>&amp;Options</string>
     </property>
@@ -196,11 +196,11 @@
     <addaction name="uiSetPreferredTextEditorPathACT"/>
     <addaction name="uiSetWorkboxEditorACT"/>
    </widget>
-   <widget class="QMenu" name="menuEdit">
+   <widget class="QMenu" name="uiEditMENU">
     <property name="title">
      <string>Edit</string>
     </property>
-    <widget class="QMenu" name="menuFocus_to_Group">
+    <widget class="QMenu" name="uiFocus_to_GroupMENU">
      <property name="title">
       <string>Focus to Group</string>
      </property>
@@ -215,7 +215,7 @@
      <addaction name="separator"/>
      <addaction name="uiGroupLastACT"/>
     </widget>
-    <widget class="QMenu" name="menuFocus_to_Tab">
+    <widget class="QMenu" name="uiFocus_to_TabMENU">
      <property name="title">
       <string>Focus to Tab</string>
      </property>
@@ -315,17 +315,17 @@
     <addaction name="uiNextTabACT"/>
     <addaction name="uiPrevTabACT"/>
     <addaction name="separator"/>
-    <addaction name="menuFocus_to_Group"/>
-    <addaction name="menuFocus_to_Tab"/>
+    <addaction name="uiFocus_to_GroupMENU"/>
+    <addaction name="uiFocus_to_TabMENU"/>
     <addaction name="separator"/>
     <addaction name="uiFindInWorkboxesACT"/>
     <addaction name="uiFocusNameACT"/>
    </widget>
-   <addaction name="uiScriptingMENU"/>
-   <addaction name="menuEdit"/>
-   <addaction name="uiDebugMENU"/>
-   <addaction name="menu_Run"/>
    <addaction name="uiFileMENU"/>
+   <addaction name="uiEditMENU"/>
+   <addaction name="uiDebugMENU"/>
+   <addaction name="uiRunMENU"/>
+   <addaction name="uiOptionsMENU"/>
    <addaction name="uiHelpMENU"/>
   </widget>
   <widget class="QToolBar" name="uiConsoleTOOLBAR">

preditor/plugins.py

@@ -88,6 +88,20 @@ def initialize(self, name=None):
         for ep in self.iterator(group="preditor.plug.initialize"):
             yield ep.load()
 
+    def loggerwindow(self, name=None):
+        """Returns instances of "preditor.plug.loggerwindow" plugins.
+
+        These plugins are used by the LoggerWindow to extend its interface. For
+        example it can be used to add a toolbar or update the menus.
+
+        When using this plugin, make sure the returned class is a subclass of
+        `preditor.gui.logger_window_plugin.LoggerWindowPlugin`.
+        """
+        for ep in self.iterator(group="preditor.plug.loggerwindow"):
+            if name and ep.name != name:
+                continue
+            yield ep.name, ep.load()
+
     def logging_handlers(self, name=None):
         for ep in self.iterator(group="preditor.plug.logging_handlers"):
             yield ep.name, ep.load()