PrEditor 1.0.0__py3-none-any.whl → 1.2.0__py3-none-any.whl

preditor/gui/loggerwindow.py

@@ -2,6 +2,7 @@ from __future__ import absolute_import, print_function
 
 import itertools
 import json
+import logging
 import os
 import re
 import sys
@@ -11,15 +12,17 @@ from datetime import datetime, timedelta
 from functools import partial
 
 import __main__
+import Qt as Qt_py
 from Qt import QtCompat, QtCore, QtWidgets
 from Qt.QtCore import QByteArray, Qt, QTimer, Signal, Slot
-from Qt.QtGui import QCursor, QFont, QIcon, QTextCursor
+from Qt.QtGui import QCursor, QFont, QIcon, QKeySequence, QTextCursor
 from Qt.QtWidgets import (
     QApplication,
     QFontDialog,
     QInputDialog,
     QMessageBox,
     QTextBrowser,
+    QTextEdit,
     QToolTip,
     QVBoxLayout,
 )
@@ -27,7 +30,7 @@ from Qt.QtWidgets import (
 from .. import (
     DEFAULT_CORE_NAME,
     about_preditor,
-    core,
+    config,
     debug,
     get_core_name,
     osystem,
@@ -46,6 +49,8 @@ from .level_buttons import LoggingLevelButton
 from .set_text_editor_path_dialog import SetTextEditorPathDialog
 from .status_label import StatusLabel
 
+logger = logging.getLogger(__name__)
+
 
 class WorkboxPages:
     """Nice names for the uiWorkboxSTACK indexes."""
@@ -195,7 +200,7 @@ class LoggerWindow(Window):
         self.uiCompleterModeMENU.addSeparator()
         action = self.uiCompleterModeMENU.addAction('Cycle mode')
         action.setObjectName('uiCycleModeACT')
-        action.setShortcut(Qt.CTRL | Qt.Key_M)
+        action.setShortcut(QKeySequence(Qt.Modifier.CTRL | Qt.Key.Key_M))
         action.triggered.connect(self.cycleCompleterMode)
         self.uiCompleterModeMENU.hovered.connect(self.handleMenuHovered)
 
@@ -487,7 +492,7 @@ class LoggerWindow(Window):
 
     def openSetPreferredTextEditorDialog(self):
         dlg = SetTextEditorPathDialog(parent=self)
-        dlg.exec_()
+        dlg.exec()
 
     def focusToConsole(self):
         """Move focus to the console"""
@@ -526,7 +531,7 @@ class LoggerWindow(Window):
 
         cursor = console.textCursor()
         if not cursor.hasSelection():
-            cursor.select(QTextCursor.LineUnderCursor)
+            cursor.select(QTextCursor.SelectionType.LineUnderCursor)
         text = cursor.selectedText()
         prompt = console.prompt()
         if text.startswith(prompt):
@@ -562,7 +567,7 @@ class LoggerWindow(Window):
 
     def wheelEvent(self, event):
         """adjust font size on ctrl+scrollWheel"""
-        if event.modifiers() == Qt.ControlModifier:
+        if event.modifiers() == Qt.KeyboardModifier.ControlModifier:
             # WheelEvents can be emitted in a cluster, but we only want one at a time
             # (ie to change font size by 1, rather than 2 or 3). Let's bail if previous
             # font-resize wheel event was within a certain threshhold.
@@ -602,7 +607,10 @@ class LoggerWindow(Window):
         else:
             text = action.toolTip()
 
-        menu = action.parentWidget()
+        if Qt_py.IsPyQt4:
+            menu = action.parentWidget()
+        else:
+            menu = action.parent()
         QToolTip.showText(QCursor.pos(), text, menu)
 
     def selectFont(self, monospace=False, proportional=False):
@@ -617,13 +625,16 @@ class LoggerWindow(Window):
         curFontFamily = origFont.family()
 
         if monospace and proportional:
-            options = QFontDialog.MonospacedFonts | QFontDialog.ProportionalFonts
+            options = (
+                QFontDialog.FontDialogOption.MonospacedFonts
+                | QFontDialog.FontDialogOption.ProportionalFonts
+            )
             kind = "monospace or proportional "
         elif monospace:
-            options = QFontDialog.MonospacedFonts
+            options = QFontDialog.FontDialogOption.MonospacedFonts
             kind = "monospace "
         elif proportional:
-            options = QFontDialog.ProportionalFonts
+            options = QFontDialog.FontDialogOption.ProportionalFonts
             kind = "proportional "
 
         # Present a QFontDialog for user to choose a font
@@ -683,9 +694,9 @@ class LoggerWindow(Window):
 
     def adjustWorkboxOrientation(self, state):
         if state:
-            self.uiSplitterSPLIT.setOrientation(Qt.Horizontal)
+            self.uiSplitterSPLIT.setOrientation(Qt.Orientation.Horizontal)
         else:
-            self.uiSplitterSPLIT.setOrientation(Qt.Vertical)
+            self.uiSplitterSPLIT.setOrientation(Qt.Orientation.Vertical)
 
     def backupPreferences(self):
         """Saves a copy of the current preferences to a zip archive."""
@@ -754,7 +765,11 @@ class LoggerWindow(Window):
 
     def keyPressEvent(self, event):
         # Fix 'Maya : Qt tools lose focus' https://redmine.blur.com/issues/34430
-        if event.modifiers() & (Qt.AltModifier | Qt.ControlModifier | Qt.ShiftModifier):
+        if event.modifiers() & (
+            Qt.KeyboardModifier.AltModifier
+            | Qt.KeyboardModifier.ControlModifier
+            | Qt.KeyboardModifier.ShiftModifier
+        ):
             pass
         else:
             super(LoggerWindow, self).keyPressEvent(event)
@@ -778,7 +793,7 @@ class LoggerWindow(Window):
         pref.update(
             {
                 'loggergeom': [geo.x(), geo.y(), geo.width(), geo.height()],
-                'windowState': int(self.windowState()),
+                'windowState': QtCompat.enumValue(self.windowState()),
                 'SplitterVertical': self.uiEditorVerticalACT.isChecked(),
                 'SplitterSize': self.uiSplitterSPLIT.sizes(),
                 'tabIndent': self.uiIndentationsTabsACT.isChecked(),
@@ -860,7 +875,7 @@ class LoggerWindow(Window):
         if dialog.objectName() in self.dont_ask_again:
             return
 
-        dialog.exec_()
+        dialog.exec()
 
     def restartLogger(self):
         """Closes this PrEditor instance and starts a new process with the same
@@ -908,7 +923,7 @@ class LoggerWindow(Window):
         sizes = pref.get('SplitterSize')
         if sizes:
             self.uiSplitterSPLIT.setSizes(sizes)
-        self.setWindowState(Qt.WindowStates(pref.get('windowState', 0)))
+        self.setWindowState(Qt.WindowState(pref.get('windowState', 0)))
         self.uiIndentationsTabsACT.setChecked(pref.get('tabIndent', True))
         self.uiCopyTabsToSpacesACT.setChecked(pref.get('copyIndentsAsSpaces', False))
 
@@ -980,7 +995,7 @@ class LoggerWindow(Window):
         _font = pref.get('consoleFont', None)
         if _font:
             font = QFont()
-            if font.fromString(_font):
+            if QtCompat.QFont.fromString(font, _font):
                 self.console().setConsoleFont(font)
 
         self.dont_ask_again = pref.get('dont_ask_again', [])
@@ -1163,9 +1178,9 @@ class LoggerWindow(Window):
 
     def setWordWrap(self, state):
         if state:
-            self.uiConsoleTXT.setLineWrapMode(self.uiConsoleTXT.WidgetWidth)
+            self.uiConsoleTXT.setLineWrapMode(QTextEdit.LineWrapMode.WidgetWidth)
         else:
-            self.uiConsoleTXT.setLineWrapMode(self.uiConsoleTXT.NoWrap)
+            self.uiConsoleTXT.setLineWrapMode(QTextEdit.LineWrapMode.NoWrap)
 
     def show_about(self):
         """Shows `preditor.about_preditor()`'s output in a message box."""
@@ -1245,7 +1260,7 @@ class LoggerWindow(Window):
 
         # if this is the global instance, then allow it to be deleted on close
         if self == LoggerWindow._instance:
-            self.setAttribute(Qt.WA_DeleteOnClose, True)
+            self.setAttribute(Qt.WidgetAttribute.WA_DeleteOnClose, True)
             LoggerWindow._instance = None
 
         # clear out the system
@@ -1335,18 +1350,16 @@ class LoggerWindow(Window):
                 parent, name=name, run_workbox=run_workbox, standalone=standalone
             )
 
-            # RV has a Unique window structure. It makes more sense to not parent a
-            # singleton window than to parent it to a specific top level window.
-            if core.objectName() == 'rv':
-                inst.setParent(None)
-                inst.setAttribute(Qt.WA_QuitOnClose, False)
-
             # protect the memory
-            inst.setAttribute(Qt.WA_DeleteOnClose, False)
+            inst.setAttribute(Qt.WidgetAttribute.WA_DeleteOnClose, False)
 
             # cache the instance
             LoggerWindow._instance = inst
 
+            # Allow customization when the instance is first created.
+            if config.on_create_callback:
+                config.on_create_callback(inst)
+
         return LoggerWindow._instance
 
     def installLogToFile(self):
@@ -1380,6 +1393,16 @@ class LoggerWindow(Window):
             bool: If a shutdown was required
         """
         if cls._instance:
-            cls._instance.shutdown()
+            try:
+                cls._instance.shutdown()
+            except RuntimeError as error:
+                # If called after the host Qt application has been closed then
+                # the instance has been deleted and we can't save preferences
+                # without getting a RuntimeError about C/C++ being deleted.
+                logger.warning(
+                    f"instance_shutdown failed PrEditor prefs likely not saved: {error}"
+                )
+                return False
+
             return True
         return False

preditor/gui/set_text_editor_path_dialog.py

@@ -56,4 +56,6 @@ class SetTextEditorPathDialog(QDialog):
         else:
             msg = "That path doesn't exists or isn't an executable file."
             label = 'Incorrect Path'
-            QMessageBox.warning(self.window(), label, msg, QMessageBox.Ok)
+            QMessageBox.warning(
+                self.window(), label, msg, QMessageBox.StandardButton.Ok
+            )

preditor/gui/window.py

@@ -25,7 +25,7 @@ class Window(QMainWindow):
         if not cls._instance:
             cls._instance = cls(parent=parent)
             # protect the memory
-            cls._instance.setAttribute(Qt.WA_DeleteOnClose, False)
+            cls._instance.setAttribute(Qt.WidgetAttribute.WA_DeleteOnClose, False)
         return cls._instance
 
     def __init__(self, parent=None, flags=0):
@@ -67,7 +67,7 @@ class Window(QMainWindow):
         # dead dialogs
 
         # set the delete attribute to clean up the window once it is closed
-        self.setAttribute(Qt.WA_DeleteOnClose, True)
+        self.setAttribute(Qt.WidgetAttribute.WA_DeleteOnClose, True)
         # If this value is set to False calling setGeometry on this window will not
         # adjust the geometry to ensure the window is on a valid screen.
         self.checkScreenGeo = True
@@ -103,7 +103,7 @@ class Window(QMainWindow):
     def closeEvent(self, event):
         # ensure this object gets deleted
         wwidget = None
-        if self.testAttribute(Qt.WA_DeleteOnClose):
+        if self.testAttribute(Qt.WidgetAttribute.WA_DeleteOnClose):
             # collect the win widget to uncache it
             if self.parent() and self.parent().inherits('QWinWidget'):
                 wwidget = self.parent()
@@ -141,7 +141,7 @@ class Window(QMainWindow):
         # allow the global instance to be cleared
         if this == cls._instance:
             cls._instance = None
-            this.setAttribute(Qt.WA_DeleteOnClose, True)
+            this.setAttribute(Qt.WidgetAttribute.WA_DeleteOnClose, True)
         try:
             this.close()
         except RuntimeError:

preditor/gui/workbox_mixin.py

@@ -1,9 +1,11 @@
 from __future__ import absolute_import, print_function
 
+import io
 import os
 import tempfile
 import textwrap
 
+import chardet
 from Qt.QtCore import Qt
 from Qt.QtWidgets import QStackedWidget
 
@@ -317,14 +319,37 @@ class WorkboxMixin(object):
             os.remove(tempfile)
 
     @classmethod
-    def __open_file__(cls, filename):
-        with open(filename) as fle:
-            return fle.read()
-        return ""
+    def __open_file__(cls, filename, strict=True):
+        """Open a file and try to detect the text encoding it was saved as.
+
+        Returns:
+            encoding(str): The detected encoding, Defaults to "utf-8" if unable
+                to detect encoding.
+            text(str): The contents of the file decoded to a str.
+        """
+        with open(filename, "rb") as f:
+            text_bytes = f.read()
+
+        # Open file, detect source encoding and convert to utf-8
+        encoding = chardet.detect(text_bytes)['encoding'] or 'utf-8'
+        try:
+            text = text_bytes.decode(encoding)
+        except UnicodeDecodeError as e:
+            if strict:
+                raise UnicodeDecodeError(  # noqa: B904
+                    e.encoding,
+                    e.object,
+                    e.start,
+                    e.end,
+                    f"{e.reason}, Filename: {filename}",
+                )
+            encoding = 'utf-8'
+            text = text_bytes.decode(encoding, errors="ignore")
+        return encoding, text
 
     @classmethod
-    def __write_file__(cls, filename, txt):
-        with open(filename, 'w') as fle:
+    def __write_file__(cls, filename, txt, encoding=None):
+        with io.open(filename, 'w', newline='\n', encoding=encoding) as fle:
             fle.write(txt)
 
     def __show__(self):
@@ -335,7 +360,7 @@ class WorkboxMixin(object):
         if self._filename_pref:
             self.__load__(self._filename_pref)
         elif self._tempfile:
-            txt = self.__open_file__(self.__tempfile__())
+            _, txt = self.__open_file__(self.__tempfile__(), strict=False)
             self.__set_text__(txt)
 
     def process_shortcut(self, event, run=True):
@@ -365,10 +390,14 @@ class WorkboxMixin(object):
             modifiers = event.modifiers()
 
             # Determine which relevant combos are pressed
-            ret = key == Qt.Key_Return
-            enter = key == Qt.Key_Enter
-            shift = modifiers == Qt.ShiftModifier
-            ctrlShift = modifiers == Qt.ControlModifier | Qt.ShiftModifier
+            ret = key == Qt.Key.Key_Return
+            enter = key == Qt.Key.Key_Enter
+            shift = modifiers == Qt.KeyboardModifier.ShiftModifier
+            ctrlShift = (
+                modifiers
+                == Qt.KeyboardModifier.ControlModifier
+                | Qt.KeyboardModifier.ShiftModifier
+            )
 
             # Determine which actions to take
             evalTrunc = enter or (ret and shift)

preditor/gui/workbox_text_edit.py

@@ -27,6 +27,7 @@ class WorkboxTextEdit(WorkboxMixin, QTextEdit):
     ):
         super(WorkboxTextEdit, self).__init__(parent=parent, core_name=core_name)
         self._filename = None
+        self._encoding = None
         self.__set_console__(console)
         highlight = CodeHighlighter(self)
         highlight.setLanguage('Python')
@@ -64,7 +65,7 @@ class WorkboxTextEdit(WorkboxMixin, QTextEdit):
 
     def __set_font__(self, font):
         metrics = QFontMetrics(font)
-        self.setTabStopDistance(metrics.width(" ") * 4)
+        self.setTabStopDistance(metrics.horizontalAdvance(" ") * 4)
         super(WorkboxTextEdit, self).setFont(font)
 
     def __goto_line__(self, line):
@@ -79,7 +80,8 @@ class WorkboxTextEdit(WorkboxMixin, QTextEdit):
 
     def __load__(self, filename):
         self._filename = filename
-        txt = self.__open_file__(self._filename)
+        enc, txt = self.__open_file__(self._filename)
+        self._encoding = enc
         self.__set_text__(txt)
 
     def __margins_font__(self):
@@ -114,7 +116,7 @@ class WorkboxTextEdit(WorkboxMixin, QTextEdit):
 
             selectText = self.window().uiSelectTextACT.isChecked() or selectText
             if selectText:
-                cursor.select(QTextCursor.LineUnderCursor)
+                cursor.select(QTextCursor.SelectionType.LineUnderCursor)
                 self.setTextCursor(cursor)
 
             return text, line

preditor/gui/workboxwidget.py

@@ -1,6 +1,5 @@
 from __future__ import absolute_import, print_function
 
-import io
 import re
 import time
 
@@ -10,6 +9,7 @@ from Qt.QtWidgets import QAction
 
 from .. import core, resourcePath
 from ..gui.workbox_mixin import WorkboxMixin
+from ..scintilla import QsciScintilla
 from ..scintilla.documenteditor import DocumentEditor, SearchOptions
 from ..scintilla.finddialog import FindDialog
 
@@ -36,15 +36,19 @@ class WorkboxWidget(WorkboxMixin, DocumentEditor):
         self.initShortcuts()
         self.setLanguage('Python')
         # Default to unix newlines
-        self.setEolMode(self.EolUnix)
+        self.setEolMode(QsciScintilla.EolMode.EolUnix)
         if hasattr(self.window(), "setWorkboxFontBasedOnConsole"):
             self.window().setWorkboxFontBasedOnConsole()
 
     def __auto_complete_enabled__(self):
-        return self.autoCompletionSource() == self.AcsAll
+        return self.autoCompletionSource() == QsciScintilla.AutoCompletionSource.AcsAll
 
     def __set_auto_complete_enabled__(self, state):
-        state = self.AcsAll if state else self.AcsNone
+        state = (
+            QsciScintilla.AutoCompletionSource.AcsAll
+            if state
+            else QsciScintilla.AutoCompletionSource.AcsNone
+        )
         self.setAutoCompletionSource(state)
 
     def __clear__(self):
@@ -120,7 +124,7 @@ class WorkboxWidget(WorkboxMixin, DocumentEditor):
         try:
             marker = self._marker
         except AttributeError:
-            self._marker = self.markerDefine(self.Circle)
+            self._marker = self.markerDefine(QsciScintilla.MarkerSymbol.Circle)
             marker = self._marker
         self.markerAdd(line, marker)
 
@@ -197,10 +201,10 @@ class WorkboxWidget(WorkboxMixin, DocumentEditor):
         self.setText(txt)
 
     @classmethod
-    def __write_file__(cls, filename, txt):
-        with io.open(filename, 'w', newline='\n') as fle:
-            # Save unix newlines for simplicity
-            fle.write(cls.__unix_end_lines__(txt))
+    def __write_file__(cls, filename, txt, encoding=None):
+        # Save unix newlines for simplicity
+        txt = cls.__unix_end_lines__(txt)
+        super(WorkboxWidget, cls).__write_file__(filename, txt, encoding=encoding)
 
     def keyPressEvent(self, event):
         """Check for certain keyboard shortcuts, and handle them as needed,
@@ -216,13 +220,13 @@ class WorkboxWidget(WorkboxMixin, DocumentEditor):
         when Return is pressed), so this combination is not detectable.
         """
         if self._software == 'softimage':
-            DocumentEditor.keyPressEvent(self, event)
+            super(WorkboxWidget, self).keyPressEvent(event)
         else:
             if self.process_shortcut(event):
                 return
             else:
                 # Send regular keystroke
-                DocumentEditor.keyPressEvent(self, event)
+                super(WorkboxWidget, self).keyPressEvent(event)
 
     def initShortcuts(self):
         """Use this to set up shortcuts when the DocumentEditor"""
@@ -248,7 +252,7 @@ class WorkboxWidget(WorkboxMixin, DocumentEditor):
 
         # create the search dialog and connect actions
         self._searchDialog = FindDialog(self)
-        self._searchDialog.setAttribute(Qt.WA_DeleteOnClose, False)
+        self._searchDialog.setAttribute(Qt.WidgetAttribute.WA_DeleteOnClose, False)
         self.uiFindACT.triggered.connect(
             lambda: self._searchDialog.search(self.searchText())
         )

preditor/logging_config.py

@@ -9,9 +9,12 @@ from .prefs import prefs_path
 
 
 class LoggingConfig(object):
-    def __init__(self, core_name, version=1):
+    def __init__(self, core_name, version=1, disable_existing_loggers=False):
         self._filename = None
-        self.cfg = {'version': version}
+        self.cfg = {
+            'version': version,
+            'disable_existing_loggers': disable_existing_loggers,
+        }
         self.core_name = core_name
 
     def add_logger(self, name, logger):

preditor/scintilla/__init__.py

@@ -1,5 +1,23 @@
 from __future__ import absolute_import
 
+__all__ = ["delayables", "FindState", "Qsci", "QsciScintilla"]
+
+import Qt
+
+if Qt.IsPyQt6:
+    from PyQt6 import Qsci
+    from PyQt6.Qsci import QsciScintilla
+elif Qt.IsPyQt5:
+    from PyQt5 import Qsci
+    from PyQt5.Qsci import QsciScintilla
+elif Qt.IsPyQt4:
+    from PyQt4 import Qsci
+    from PyQt4.Qsci import QsciScintilla
+else:
+    raise ImportError(
+        "QScintilla library is not supported by {}".format(Qt.__binding__)
+    )
+
 
 class FindState(object):
     """
@@ -19,4 +37,4 @@ class FindState(object):
         self.end_pos = None
 
 
-from . import delayables  # noqa: F401, E402
+from . import delayables  # noqa: E402

preditor/scintilla/delayables/smart_highlight.py

@@ -1,17 +1,17 @@
 from __future__ import absolute_import, print_function
 
-from PyQt5.Qsci import QsciScintilla
+import Qt
 from Qt.QtCore import QSignalMapper
 from Qt.QtWidgets import QWidget
 
 from ...delayable_engine.delayables import SearchDelayable
-from .. import FindState
+from .. import FindState, QsciScintilla
 
 
 class SmartHighlight(SearchDelayable):
     key = 'smart_highlight'
     indicator_number = 30
-    indicator_style = QsciScintilla.StraightBoxIndicator
+    indicator_style = QsciScintilla.IndicatorStyle.StraightBoxIndicator
     border_alpha = 255
 
     def __init__(self, engine):
@@ -36,7 +36,10 @@ class SmartHighlight(SearchDelayable):
         )
 
         self.signal_mapper.setMapping(document, document)
-        self.signal_mapper.mapped[QWidget].connect(self.update_highlighter)
+        if Qt.IsPyQt4:
+            self.signal_mapper.mapped[QWidget].connect(self.update_highlighter)
+        else:
+            self.signal_mapper.mappedObject.connect(self.update_highlighter)
         document.selectionChanged.connect(self.signal_mapper.map)
 
     def clear_markings(self, document):

preditor/scintilla/delayables/spell_check.py

@@ -4,12 +4,11 @@ import logging
 import re
 import string
 
-from PyQt5.Qsci import QsciScintilla
 from Qt.QtCore import Qt
 from Qt.QtGui import QColor
 
 from ...delayable_engine.delayables import RangeDelayable
-from .. import lang
+from .. import QsciScintilla, lang
 
 logger = logging.getLogger(__name__)
 
@@ -49,12 +48,14 @@ else:
             # https://www.scintilla.org/ScintillaDox.html#SCI_INDICSETSTYLE
             # https://qscintilla.com/#clickable_text/indicators
             document.indicatorDefine(
-                QsciScintilla.SquiggleLowIndicator, self.indicator_number
+                QsciScintilla.IndicatorStyle.SquiggleLowIndicator, self.indicator_number
             )
             document.SendScintilla(
                 QsciScintilla.SCI_SETINDICATORCURRENT, self.indicator_number
             )
-            document.setIndicatorForegroundColor(QColor(Qt.red), self.indicator_number)
+            document.setIndicatorForegroundColor(
+                QColor(Qt.GlobalColor.red), self.indicator_number
+            )
 
             document.SCN_MODIFIED.connect(document.onTextModified)