Minor refactoring and linting (#2536)

Author: vkbo

.github/workflows/test_mac.yml

@@ -12,7 +12,7 @@ on:
 
 jobs:
   testMac:
-    runs-on: macos-13
+    runs-on: macos-latest
     steps:
       - name: Python Setup
         uses: actions/setup-python@v5

novelWriter.py

@@ -7,8 +7,8 @@
 import sys
 
 try:
-    import PyQt6.QtCore
-    import PyQt6.QtGui
+    import PyQt6.QtCore  # noqa: F401
+    import PyQt6.QtGui  # noqa: F401
     import PyQt6.QtWidgets  # noqa: F401
 except Exception:
     print("ERROR: Failed to load dependency PyQt6")

novelwriter/core/status.py

@@ -183,7 +183,7 @@ def fromRaw(self, data: list[str]) -> StatusEntry | None:
             icon = NWStatus.createIcon(self._height, color, shape)
             return StatusEntry(simplified(data[2]), color, theme, shape, icon)
         except Exception:
-            logger.error("Could not parse entry %s", str(data))
+            logger.error("Could not parse entry %s", data)
         return None
 
     def refreshIcons(self) -> None:

novelwriter/core/tree.py

@@ -89,7 +89,7 @@ def __getitem__(self, tHandle: str | None) -> NWItem | None:
         """
         if tHandle and tHandle in self._items:
             return self._items[tHandle]
-        logger.error("No tree item with handle '%s'", str(tHandle))
+        logger.error("No tree item with handle '%s'", tHandle)
         return None
 
     def __contains__(self, tHandle: str) -> bool:

novelwriter/error.py

@@ -171,7 +171,7 @@ def exceptionHandler(exType: type, exValue: BaseException, exTrace: TracebackTyp
 
     from PyQt6.QtWidgets import QApplication
 
-    logger.critical("%s: %s", exType.__name__, str(exValue))
+    logger.critical("%s: %s", exType.__name__, exValue)
     print_tb(exTrace)
 
     try:

novelwriter/gui/doceditor.py

@@ -77,7 +77,8 @@
     QtAlignCenterTop, QtAlignJustify, QtAlignLeft, QtAlignLeftTop,
     QtAlignRight, QtImCursorRectangle, QtKeepAnchor, QtModCtrl, QtModNone,
     QtModShift, QtMouseLeft, QtMoveAnchor, QtMoveLeft, QtMoveRight,
-    QtScrollAlwaysOff, QtScrollAsNeeded, QtTransparent
+    QtScrollAlwaysOff, QtScrollAsNeeded, QtSelectBlock, QtSelectDocument,
+    QtSelectWord, QtTransparent
 )
 
 logger = logging.getLogger(__name__)
@@ -672,7 +673,7 @@ def toggleSpellCheck(self, state: bool | None) -> None:
         self.spellCheckStateChanged.emit(state)
         self.spellCheckDocument()
 
-        logger.debug("Spell check is set to '%s'", str(state))
+        logger.debug("Spell check is set to '%s'", state)
 
     def spellCheckDocument(self) -> None:
         """Rerun the highlighter to update spell checking status of the
@@ -731,9 +732,9 @@ def docAction(self, action: nwDocAction) -> bool:
         elif action == nwDocAction.D_QUOTE:
             self._wrapSelection(CONFIG.fmtDQuoteOpen, CONFIG.fmtDQuoteClose)
         elif action == nwDocAction.SEL_ALL:
-            self._makeSelection(QTextCursor.SelectionType.Document)
+            self._makeSelection(QtSelectDocument)
         elif action == nwDocAction.SEL_PARA:
-            self._makeSelection(QTextCursor.SelectionType.BlockUnderCursor)
+            self._makeSelection(QtSelectBlock)
         elif action == nwDocAction.BLOCK_H1:
             self._formatBlock(nwDocAction.BLOCK_H1)
         elif action == nwDocAction.BLOCK_H2:
@@ -785,7 +786,7 @@ def docAction(self, action: nwDocAction) -> bool:
         elif action == nwDocAction.SC_SUB:
             self._wrapSelection(nwShortcode.SUB_O, nwShortcode.SUB_C)
         else:
-            logger.debug("Unknown or unsupported document action '%s'", str(action))
+            logger.debug("Unknown or unsupported document action '%s'", action)
             self._allowAutoReplace(True)
             return False
 
@@ -1174,13 +1175,9 @@ def _openContextMenu(self, pos: QPoint) -> None:
         action = qtAddAction(ctxMenu, self.tr("Select All"))
         action.triggered.connect(qtLambda(self.docAction, nwDocAction.SEL_ALL))
         action = qtAddAction(ctxMenu, self.tr("Select Word"))
-        action.triggered.connect(qtLambda(
-            self._makePosSelection, QTextCursor.SelectionType.WordUnderCursor, pos,
-        ))
+        action.triggered.connect(qtLambda(self._makePosSelection, QtSelectWord, pos))
         action = qtAddAction(ctxMenu, self.tr("Select Paragraph"))
-        action.triggered.connect(qtLambda(
-            self._makePosSelection, QTextCursor.SelectionType.BlockUnderCursor, pos
-        ))
+        action.triggered.connect(qtLambda(self._makePosSelection, QtSelectBlock, pos))
 
         # Spell Checking
         if SHARED.project.data.spellCheck:
@@ -1750,7 +1747,7 @@ def _processBlockFormat(
         elif action == nwDocAction.BLOCK_TXT:
             text = temp
         else:
-            logger.error("Unknown or unsupported block format requested: '%s'", str(action))
+            logger.error("Unknown or unsupported block format requested: '%s'", action)
             return nwDocAction.NO_ACTION, "", 0
 
         return action, text, offset
@@ -1760,7 +1757,7 @@ def _formatBlock(self, action: nwDocAction) -> bool:
         cursor = self.textCursor()
         block = cursor.block()
         if not block.isValid():
-            logger.debug("Invalid block selected for action '%s'", str(action))
+            logger.debug("Invalid block selected for action '%s'", action)
             return False
 
         action, text, offset = self._processBlockFormat(action, block.text())
@@ -1770,7 +1767,7 @@ def _formatBlock(self, action: nwDocAction) -> bool:
         pos = cursor.position()
 
         cursor.beginEditBlock()
-        self._makeSelection(QTextCursor.SelectionType.BlockUnderCursor, cursor)
+        self._makeSelection(QtSelectBlock, cursor)
         cursor.insertText(text)
         cursor.endEditBlock()
 
@@ -1798,7 +1795,7 @@ def _iterFormatBlocks(self, action: nwDocAction) -> bool:
             if pAction != nwDocAction.NO_ACTION and blockText.strip():
                 action = pAction  # First block decides further actions
                 cursor.setPosition(block.position())
-                self._makeSelection(QTextCursor.SelectionType.BlockUnderCursor, cursor)
+                self._makeSelection(QtSelectBlock, cursor)
                 cursor.insertText(text)
                 toggle = False
 
@@ -1818,7 +1815,7 @@ def _removeInParLineBreaks(self) -> None:
         """Strip line breaks within paragraphs in the selected text."""
         cursor = self.textCursor()
         if not cursor.hasSelection():
-            cursor.select(QTextCursor.SelectionType.Document)
+            cursor.select(QtSelectDocument)
 
         rS = 0
         rE = self._qDocument.characterCount()
@@ -2035,10 +2032,10 @@ def _makeSelection(
         cursor.clearSelection()
         cursor.select(mode)
 
-        if mode == QTextCursor.SelectionType.WordUnderCursor:
+        if mode == QtSelectWord:
             cursor = self._autoSelect()
 
-        elif mode == QTextCursor.SelectionType.BlockUnderCursor:
+        elif mode == QtSelectBlock:
             # This selection mode also selects the preceding paragraph
             # separator, which we want to avoid.
             posS = cursor.selectionStart()

novelwriter/gui/docviewer.py

@@ -53,7 +53,8 @@
 from novelwriter.gui.theme import STYLES_MIN_TOOLBUTTON
 from novelwriter.types import (
     QtAlignCenterTop, QtKeepAnchor, QtMouseLeft, QtMoveAnchor,
-    QtScrollAlwaysOff, QtScrollAsNeeded
+    QtScrollAlwaysOff, QtScrollAsNeeded, QtSelectBlock, QtSelectDocument,
+    QtSelectWord
 )
 
 logger = logging.getLogger(__name__)
@@ -287,11 +288,11 @@ def docAction(self, action: nwDocAction) -> bool:
         elif action == nwDocAction.COPY:
             self.copy()
         elif action == nwDocAction.SEL_ALL:
-            self._makeSelection(QTextCursor.SelectionType.Document)
+            self._makeSelection(QtSelectDocument)
         elif action == nwDocAction.SEL_PARA:
-            self._makeSelection(QTextCursor.SelectionType.BlockUnderCursor)
+            self._makeSelection(QtSelectBlock)
         else:
-            logger.debug("Unknown or unsupported document action '%s'", str(action))
+            logger.debug("Unknown or unsupported document action '%s'", action)
             return False
         return True
 
@@ -400,14 +401,10 @@ def _openContextMenu(self, point: QPoint) -> None:
         action.triggered.connect(qtLambda(self.docAction, nwDocAction.SEL_ALL))
 
         action = qtAddAction(ctxMenu, self.tr("Select Word"))
-        action.triggered.connect(qtLambda(
-            self._makePosSelection, QTextCursor.SelectionType.WordUnderCursor, point
-        ))
+        action.triggered.connect(qtLambda(self._makePosSelection, QtSelectWord, point))
 
         action = qtAddAction(ctxMenu, self.tr("Select Paragraph"))
-        action.triggered.connect(qtLambda(
-            self._makePosSelection, QTextCursor.SelectionType.BlockUnderCursor, point
-        ))
+        action.triggered.connect(qtLambda(self._makePosSelection, QtSelectBlock, point))
 
         # Open the context menu
         if viewport := self.viewport():
@@ -466,7 +463,7 @@ def _makeSelection(self, selType: QTextCursor.SelectionType) -> None:
         cursor.clearSelection()
         cursor.select(selType)
 
-        if selType == QTextCursor.SelectionType.BlockUnderCursor:
+        if selType == QtSelectBlock:
             # This selection mode also selects the preceding paragraph
             # separator, which we want to avoid.
             posS = cursor.selectionStart()

novelwriter/gui/outline.py

@@ -586,7 +586,7 @@ def _loadHeaderState(self) -> None:
         try:
             for name, (hidden, width) in colState.items():
                 if name not in nwOutline.__members__:
-                    logger.warning("Ignored unknown outline column '%s'", str(name))
+                    logger.warning("Ignored unknown outline column '%s'", name)
                     continue
                 tmpOrder.append(nwOutline[name])
                 tmpHidden[nwOutline[name]] = hidden

novelwriter/types.py

@@ -109,9 +109,14 @@
 
 QtKeepAnchor = QTextCursor.MoveMode.KeepAnchor
 QtMoveAnchor = QTextCursor.MoveMode.MoveAnchor
+
 QtMoveLeft = QTextCursor.MoveOperation.Left
 QtMoveRight = QTextCursor.MoveOperation.Right
 
+QtSelectWord = QTextCursor.SelectionType.WordUnderCursor
+QtSelectBlock = QTextCursor.SelectionType.BlockUnderCursor
+QtSelectDocument = QTextCursor.SelectionType.Document
+
 QtImCursorRectangle = Qt.InputMethodQuery.ImCursorRectangle
 
 # Size Policy

tests/test_gui/test_gui_doceditor.py

@@ -42,7 +42,8 @@
 from novelwriter.text.counting import standardCounter
 from novelwriter.types import (
     QtAlignJustify, QtAlignLeft, QtKeepAnchor, QtModCtrl, QtModNone,
-    QtMouseLeft, QtMoveAnchor, QtMoveRight, QtScrollAlwaysOff, QtScrollAsNeeded
+    QtMouseLeft, QtMoveAnchor, QtMoveRight, QtScrollAlwaysOff,
+    QtScrollAsNeeded, QtSelectDocument, QtSelectWord
 )
 
 from tests.mocked import causeOSError
@@ -58,7 +59,7 @@ def getMenuForPos(editor: GuiDocEditor, pos: int, select: bool = False) -> QMenu
     cursor = editor.textCursor()
     cursor.setPosition(pos)
     if select:
-        cursor.select(QTextCursor.SelectionType.WordUnderCursor)
+        cursor.select(QtSelectWord)
     editor.setTextCursor(cursor)
     editor._openContextFromCursor()
     for obj in editor.children():
@@ -1239,7 +1240,7 @@ def testGuiEditor_TextManipulation(qtbot, nwGUI, projPath, ipsumText, mockRnd):
     docEditor.setCursorPosition(45)
     assert len(docEditor._selectedBlocks(cursor)) == 0
 
-    cursor.select(QTextCursor.SelectionType.Document)
+    cursor.select(QtSelectDocument)
     assert len(docEditor._selectedBlocks(cursor)) == 15
 
     # Remove All
@@ -2093,7 +2094,7 @@ def testGuiEditor_Search(qtbot, monkeypatch, nwGUI, prjLipsum):
 
     # Select the Word "est"
     docEditor.setCursorPosition(663)
-    docEditor._makeSelection(QTextCursor.SelectionType.WordUnderCursor)
+    docEditor._makeSelection(QtSelectWord)
     cursor = docEditor.textCursor()
     assert cursor.selectedText() == "est"
 
@@ -2223,7 +2224,7 @@ def testGuiEditor_Search(qtbot, monkeypatch, nwGUI, prjLipsum):
     # Close search and select "est" again
     docSearch.cancelSearch.activate(QAction.ActionEvent.Trigger)
     docEditor.setCursorPosition(663)
-    docEditor._makeSelection(QTextCursor.SelectionType.WordUnderCursor)
+    docEditor._makeSelection(QtSelectWord)
     cursor = docEditor.textCursor()
     assert cursor.selectedText() == "est"