Refactor to support WorkboxTextEdit and overall cleaner structure

Author: macevhicz

preditor/gui/console.py

@@ -287,7 +287,7 @@ def errorHyperlink(self):
             cmdTempl = window.textEditorCmdTempl
 
         # Bail if not setup properly
-        if workboxName is None:
+        if not workboxName:
             msg = (
                 "Cannot use traceback hyperlink (Correct the path with Options "
                 "> Set Preferred Text Editor Path).\n"
@@ -334,7 +334,7 @@ def errorHyperlink(self):
                 )
                 subprocess.Popen(command)
             except (ValueError, OSError):
-                msg = "The provided text editor command template is not valid:\n    {}"
+                msg = "The provided text editor command is not valid:\n    {}"
                 msg = msg.format(cmdTempl)
                 print(msg)
         elif workboxName is not None:
@@ -427,9 +427,11 @@ def getWorkboxLine(self, name, lineNum):
         workbox = self.window().workbox_for_name(name)
         if not workbox:
             return None
-        if lineNum > workbox.lines():
+
+        num_lines = workbox.__num_lines__()
+        if lineNum > num_lines:
             return None
-        txt = workbox.text(lineNum).strip() + "\n"
+        txt = workbox.__text_line__(lineNum=lineNum).strip() + "\n"
         return txt
 
     def executeString(

preditor/gui/drag_tab_bar.py

@@ -107,8 +107,8 @@ def get_color_and_tooltip(self, index):
             widget = self.parent().widget(index)
 
             filename = None
-            if hasattr(widget, "text"):
-                filename = widget.__filename__() or widget._filename_pref
+            if hasattr(widget, "__filename__"):
+                filename = widget.__filename__()
 
             if widget.__changed_by_instance__():
                 if filename:
@@ -145,13 +145,12 @@ def get_color_and_tooltip(self, index):
                 else:
                     state = TabStates.Dirty
                     toolTip = "Workbox has unsaved changes, or it's name has changed."
-            elif filename:
-                if Path(filename).is_file():
-                    state = TabStates.Linked
-                    toolTip = "Linked to file on disk"
-                else:
-                    state = TabStates.MissingLinked
-                    toolTip = "Linked file is missing"
+            elif widget.__is_missing_linked_file__():
+                state = TabStates.MissingLinked
+                toolTip = "Linked file is missing"
+            elif hasattr(widget, "__filename__") and widget.__filename__():
+                state = TabStates.Linked
+                toolTip = "Linked to file on disk"
 
             if hasattr(widget, "__workbox_id__"):
                 workbox_id = widget.__workbox_id__()
@@ -347,8 +346,8 @@ def tab_menu(self, pos, popup=True):
 
         # Show File-related actions depending if filename already set. Don't include
         # Rename if the workbox is linked to a file.
-        if hasattr(workbox, 'filename'):
-            if not workbox.filename():
+        if hasattr(workbox, '__filename__'):
+            if not workbox.__filename__():
                 act = menu.addAction('Rename')
                 act.triggered.connect(self.rename_tab)
 
@@ -358,7 +357,7 @@ def tab_menu(self, pos, popup=True):
                 act = menu.addAction('Save and Link File')
                 act.triggered.connect(partial(self.save_and_link_file, workbox))
             else:
-                if Path(workbox.filename()).is_file():
+                if Path(workbox.__filename__()).is_file():
                     act = menu.addAction('Explore File')
                     act.triggered.connect(partial(self.explore_file, workbox))
 
@@ -397,14 +396,21 @@ def link_file(self, workbox):
         Args:
             workbox (WorkboxMixin): The workbox contained in the clicked tab
         """
-        filename = workbox.filename()
+        filename = workbox.__filename__()
+        workbox.__set_file_monitoring_enabled__(False)
+        workbox.__set_filename__("")
         filename, _other = QFileDialog.getOpenFileName(directory=filename)
         if filename and Path(filename).is_file():
+
+            # First, save any unsaved text
+            workbox.__save_prefs__()
+
+            # Now, load file
             workbox.__load__(filename)
-            workbox._filename_pref = filename
-            workbox._filename = filename
-            name = Path(filename).name
+            workbox.__set_filename__(filename)
+            workbox.__set_file_monitoring_enabled__(True)
 
+            name = Path(filename).name
             self.setTabText(self._context_menu_tab, name)
             self.update()
             self.window().setWorkboxFontBasedOnConsole(workbox=workbox)
@@ -417,29 +423,32 @@ def save_and_link_file(self, workbox):
         Args:
             workbox (WorkboxMixin): The workbox contained in the clicked tab
         """
-        filename = workbox.filename()
+        filename = workbox.__filename__()
+        if filename and Path(filename).is_file():
+            workbox.__set_file_monitoring_enabled__(False)
         directory = six.text_type(Path(filename).parent) if filename else ""
-        success = workbox.saveAs(directory=directory)
+        success = workbox.__save_as__(directory=directory)
         if not success:
             return
 
-        filename = workbox.filename()
-        workbox._filename_pref = filename
-        workbox._filename = filename
-        workbox.__set_last_workbox_name__(workbox.__workbox_name__())
+        # Workbox
+        filename = workbox.__filename__()
+        workbox.__set_last_saved_text__(workbox.__text__())
+        workbox.__set_file_monitoring_enabled__(True)
         name = Path(filename).name
 
         self.setTabText(self._context_menu_tab, name)
         self.update()
         self.window().setWorkboxFontBasedOnConsole(workbox=workbox)
+        workbox.__set_last_workbox_name__(workbox.__workbox_name__())
 
     def explore_file(self, workbox):
         """Open a system file explorer at the path of the linked file.
 
         Args:
             workbox (WorkboxMixin): The workbox contained in the clicked tab
         """
-        path = Path(workbox._filename_pref)
+        path = Path(workbox.__filename__())
         if path.exists():
             osystem.explore(str(path))
         elif path.parent.exists():
@@ -451,9 +460,8 @@ def unlink_file(self, workbox):
         Args:
             workbox (WorkboxMixin): The workbox contained in the clicked tab
         """
-        workbox.updateFilename("")
-        workbox._filename_pref = ""
-
+        workbox.__set_file_monitoring_enabled__(False)
+        workbox.__set_filename__("")
         name = self.parent().default_title
         self.setTabText(self._context_menu_tab, name)
 

preditor/gui/group_tab_widget/__init__.py

@@ -97,7 +97,7 @@ def add_new_tab(self, group, title=None, prefs=None):
             WorkboxMixin: The new text editor.
         """
         if not group:
-            group = self.get_next_available_tab_name(self.default_title)
+            group = self.get_next_available_tab_name()
         elif group is True:
             group = self.currentIndex()
 
@@ -172,6 +172,20 @@ def default_tab(self, title=None, prefs=None):
         )
         return widget, title
 
+    def get_next_available_tab_name(self, name=None):
+        """Get the next available tab name, providing a default if needed.
+
+        Args:
+            name (str, optional): The name for which to get the next available
+                name.
+
+        Returns:
+            str: The determined next available tab name
+        """
+        if name is None:
+            name = self.default_title
+        return super().get_next_available_tab_name(name)
+
     def append_orphan_workboxes_to_prefs(self, prefs, existing_by_group):
         """If prefs are saved in a different PrEditor instance (in this same core)
         there may be a workbox which is either:
@@ -343,9 +357,9 @@ def restore_prefs(self, prefs):
                 # Support legacy arg for emergency backwards compatibility
                 tempfile = tab.get('tempfile', None)
                 # Get various possible saved filepaths.
-                filename_pref = tab.get('filename', "")
-                if filename_pref:
-                    if Path(filename_pref).is_file():
+                filename = tab.get('filename', "")
+                if filename:
+                    if Path(filename).is_file():
                         loadable = True
 
                 # See if there are any  workbox backups available
@@ -361,7 +375,7 @@ def restore_prefs(self, prefs):
                 # tab if it hasn't already been created.
                 prefs = dict(
                     workbox_id=workbox_id,
-                    filename=filename_pref,
+                    filename=filename,
                     backup_file=backup_file,
                     existing_editor_info=existing_by_id.pop(workbox_id, None),
                     orphaned_by_instance=orphaned_by_instance,

preditor/gui/group_tab_widget/grouped_tab_widget.py

@@ -79,6 +79,22 @@ def __is_dirty__(self):
                 break
         return is_dirty
 
+    def __is_missing_linked_file__(self):
+        """Determine if any of the workboxes are linked to file which is missing
+        on disk.
+
+        Returns:
+            bool: Whether any of this group's workboxes define a linked file
+                which is missing on disk.
+        """
+        is_missing_linked_file = False
+        for workbox_idx in range(self.count()):
+            workbox = self.widget(workbox_idx)
+            if workbox.__is_missing_linked_file__():
+                is_missing_linked_file = True
+                break
+        return is_missing_linked_file
+
     def add_new_editor(self, title=None, prefs=None):
         title = title or self.default_title
 
@@ -120,6 +136,7 @@ def close_tab(self, index):
             # Keep track of deleted tabs, make re-openable
             # Maybe also move workbox dir to a 'removed workboxes' dir
 
+            _editor.__set_file_monitoring_enabled__(False)
             super(GroupedTabWidget, self).close_tab(index)
 
     def default_tab(self, title=None, prefs=None):
@@ -138,7 +155,6 @@ def default_tab(self, title=None, prefs=None):
         if editor:
             editor.__load_workbox_version_text__(VersionTypes.Last)
 
-            editor.__set_tab_widget__(self)
             editor.__set_last_saved_text__(editor.text())
             editor.__set_last_workbox_name__(editor.__workbox_name__())
 
@@ -154,12 +170,27 @@ def default_tab(self, title=None, prefs=None):
         editor.__set_orphaned_by_instance__(orphaned_by_instance)
         return editor, title
 
+    def get_next_available_tab_name(self, name=None):
+        """Get the next available tab name, providing a default if needed.
+
+        Args:
+            name (str, optional): The name for which to get the next available
+                name.
+
+        Returns:
+            str: The determined next available tab name
+        """
+        if name is None:
+            name = self.default_title
+        return super().get_next_available_tab_name(name)
+
     def showEvent(self, event):  # noqa: N802
         super(GroupedTabWidget, self).showEvent(event)
         self.tab_shown(self.currentIndex())
 
     def tab_shown(self, index):
         editor = self.widget(index)
+        editor.__set_tab_widget__(self)
         if editor and editor.isVisible():
             editor.__show__()
 

preditor/gui/loggerwindow.py

@@ -372,7 +372,7 @@ def apply_options(self):
             self.editor_cls_name = editor_cls_name
             self.uiWorkboxTAB.editor_cls = editor_cls
             # We need to change the editor, save all prefs
-            self.recordPrefs(manual=True)
+            self.recordPrefs(manual=True, disableFileMonitoring=True)
             # Clear the uiWorkboxTAB
             self.uiWorkboxTAB.clear()
             # Restore prefs to populate the tabs
@@ -1103,13 +1103,15 @@ def linkedFileChanged(self, filename):
             self.restorePrefs(skip_geom=True)
         else:
             for info in self.uiWorkboxTAB.all_widgets():
-                editor, _, _, group_idx, editor_idx = info
-                if not editor.filename():
+                editor, _, _, _, _ = info
+                if not editor or not editor.__filename__():
                     continue
-                if Path(editor.filename()).as_posix() == Path(filename).as_posix():
+                if Path(editor.__filename__()) == Path(filename):
+                    editor.__set_file_monitoring_enabled__(False)
                     editor.__save_prefs__(saveLinkedFile=False)
                     editor.__reload_file__()
                     editor.__save_prefs__(saveLinkedFile=False, force=True)
+                    editor.__set_file_monitoring_enabled__(True)
 
     def closeEvent(self, event):
         self.recordPrefs()
@@ -1166,10 +1168,15 @@ def reportExecutionTime(self, seconds):
         self.uiStatusLBL.showSeconds(seconds)
         self.uiMenuBar.adjustSize()
 
-    def recordPrefs(self, manual=False):
+    def recordPrefs(self, manual=False, disableFileMonitoring=False):
         if not manual and not self.autoSaveEnabled():
             return
 
+        if disableFileMonitoring:
+            for editor_info in self.uiWorkboxTAB.all_widgets():
+                editor = editor_info[0]
+                editor.__set_file_monitoring_enabled__(False)
+
         origPref = self.load_prefs()
         pref = copy.deepcopy(origPref)
         geo = self.geometry()