novelWriter 2.7.4__py3-none-any.whl → 2.8b1__py3-none-any.whl

novelwriter/enum.py

@@ -20,12 +20,13 @@ General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 along with this program. If not, see <https://www.gnu.org/licenses/>.
-"""
+"""  # noqa
 
 from enum import Enum
 
 
 class nwItemType(Enum):
+    """Enum: Project Item Types."""
 
     NO_TYPE = 0
     ROOT    = 1
@@ -34,6 +35,7 @@ class nwItemType(Enum):
 
 
 class nwItemClass(Enum):
+    """Enum: Project Item Classes."""
 
     NO_CLASS  = 0
     NOVEL     = 1
@@ -50,6 +52,7 @@ class nwItemClass(Enum):
 
 
 class nwItemLayout(Enum):
+    """A project item's layout."""
 
     NO_LAYOUT = 0
     DOCUMENT  = 1
@@ -57,6 +60,7 @@ class nwItemLayout(Enum):
 
 
 class nwComment(Enum):
+    """Types of text comments."""
 
     PLAIN    = 0
     IGNORE   = 1
@@ -69,6 +73,7 @@ class nwComment(Enum):
 
 
 class nwChange(Enum):
+    """Change request modes."""
 
     CREATE = 0
     UPDATE = 1
@@ -76,12 +81,14 @@ class nwChange(Enum):
 
 
 class nwDocMode(Enum):
+    """Document open modes."""
 
     VIEW = 0
     EDIT = 1
 
 
 class nwDocAction(Enum):
+    """Document actions."""
 
     NO_ACTION = 0
     UNDO      = 1
@@ -92,38 +99,40 @@ class nwDocAction(Enum):
     MD_ITALIC = 6
     MD_BOLD   = 7
     MD_STRIKE = 8
-    S_QUOTE   = 9
-    D_QUOTE   = 10
-    SEL_ALL   = 11
-    SEL_PARA  = 12
-    BLOCK_H1  = 13
-    BLOCK_H2  = 14
-    BLOCK_H3  = 15
-    BLOCK_H4  = 16
-    BLOCK_COM = 17
-    BLOCK_IGN = 18
-    BLOCK_TXT = 19
-    BLOCK_TTL = 20
-    BLOCK_UNN = 21
-    BLOCK_HSC = 22
-    REPL_SNG  = 23
-    REPL_DBL  = 24
-    RM_BREAKS = 25
-    ALIGN_L   = 26
-    ALIGN_C   = 27
-    ALIGN_R   = 28
-    INDENT_L  = 29
-    INDENT_R  = 30
-    SC_ITALIC = 31
-    SC_BOLD   = 32
-    SC_STRIKE = 33
-    SC_ULINE  = 34
-    SC_MARK   = 35
-    SC_SUP    = 36
-    SC_SUB    = 37
+    MD_MARK   = 9
+    S_QUOTE   = 10
+    D_QUOTE   = 11
+    SEL_ALL   = 12
+    SEL_PARA  = 13
+    BLOCK_H1  = 14
+    BLOCK_H2  = 15
+    BLOCK_H3  = 16
+    BLOCK_H4  = 17
+    BLOCK_COM = 18
+    BLOCK_IGN = 19
+    BLOCK_TXT = 20
+    BLOCK_TTL = 21
+    BLOCK_UNN = 22
+    BLOCK_HSC = 23
+    REPL_SNG  = 24
+    REPL_DBL  = 25
+    RM_BREAKS = 26
+    ALIGN_L   = 27
+    ALIGN_C   = 28
+    ALIGN_R   = 29
+    INDENT_L  = 30
+    INDENT_R  = 31
+    SC_ITALIC = 32
+    SC_BOLD   = 33
+    SC_STRIKE = 34
+    SC_ULINE  = 35
+    SC_MARK   = 36
+    SC_SUP    = 37
+    SC_SUB    = 38
 
 
 class nwDocInsert(Enum):
+    """Document insert actions."""
 
     NO_INSERT = 0
     QUOTE_LS  = 1
@@ -141,6 +150,7 @@ class nwDocInsert(Enum):
 
 
 class nwView(Enum):
+    """Main GUI view modes."""
 
     EDITOR  = 0
     PROJECT = 1
@@ -150,13 +160,23 @@ class nwView(Enum):
 
 
 class nwFocus(Enum):
+    """Main GUI panel focus."""
 
     TREE     = 1
     DOCUMENT = 2
     OUTLINE  = 3
 
 
+class nwTheme(Enum):
+    """GUI theme colour modes."""
+
+    AUTO  = 0
+    LIGHT = 1
+    DARK  = 2
+
+
 class nwOutline(Enum):
+    """Enum: Project Outline Columns."""
 
     TITLE   = 0
     LEVEL   = 1
@@ -181,6 +201,7 @@ class nwOutline(Enum):
 
 
 class nwNovelExtra(Enum):
+    """Enum: Novel View Extra Columns."""
 
     HIDDEN = 0
     POV    = 1
@@ -189,6 +210,7 @@ class nwNovelExtra(Enum):
 
 
 class nwBuildFmt(Enum):
+    """Enum: Manuscript Document Formats."""
 
     ODT    = 0
     FODT   = 1
@@ -203,6 +225,7 @@ class nwBuildFmt(Enum):
 
 
 class nwStatusShape(Enum):
+    """Enum: Status/Importance Icon Shapes."""
 
     SQUARE   = 0
     TRIANGLE = 1
@@ -224,3 +247,25 @@ class nwStatusShape(Enum):
     BLOCK_2  = 17
     BLOCK_3  = 18
     BLOCK_4  = 19
+
+
+class nwStandardButton(Enum):
+    """Enum: Standard Dialog Buttons."""
+
+    OK      = 0
+    CANCEL  = 1
+    YES     = 2
+    NO      = 3
+    OPEN    = 4
+    CLOSE   = 5
+    SAVE    = 6
+    BROWSE  = 7
+    LIST    = 8
+    NEW     = 9
+    CREATE  = 10
+    RESET   = 11
+    INSERT  = 12
+    APPLY   = 13
+    BUILD   = 14
+    PRINT   = 15
+    PREVIEW = 16

novelwriter/error.py

@@ -20,7 +20,7 @@ General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 along with this program. If not, see <https://www.gnu.org/licenses/>.
-"""
+"""  # noqa
 from __future__ import annotations
 
 import logging
@@ -47,7 +47,6 @@ def logException() -> None:
     exType, exValue, _ = sys.exc_info()
     if exType is not None:
         logger.error(f"{exType.__name__}: {exValue!s}", stacklevel=2)
-    return
 
 
 def formatException(exc: BaseException) -> str:
@@ -58,6 +57,7 @@ def formatException(exc: BaseException) -> str:
 
 
 class NWErrorMessage(QDialog):
+    """GUI: Error Dialog."""
 
     def __init__(self, parent: QWidget) -> None:
         super().__init__(parent=parent)
@@ -110,8 +110,6 @@ class NWErrorMessage(QDialog):
         self.setSizeGripEnabled(True)
         self.resize(800, 400)
 
-        return
-
     def setMessage(self, exType: type, exValue: BaseException, exTrace: TracebackType) -> None:
         """Generate a message and append session data, error info and
         error traceback.
@@ -143,7 +141,7 @@ class NWErrorMessage(QDialog):
             enchantVersion = "Unknown"
 
         try:
-            txtTrace = "\n".join(format_tb(exTrace))
+            trace = "\n".join(format_tb(exTrace))
             self.msgBody.setPlainText(
                 "Environment:\n"
                 f"novelWriter Version: {__version__}\n"
@@ -152,13 +150,11 @@ class NWErrorMessage(QDialog):
                 f"Qt: {QT_VERSION_STR}, PyQt: {PYQT_VERSION_STR}\n"
                 f"enchant: {enchantVersion}\n\n"
                 f"{exType.__name__}:\n{exValue!s}\n\n"
-                f"Traceback:\n{txtTrace}\n"
+                f"Traceback:\n{trace}\n"
             )
         except Exception:
             self.msgBody.setPlainText("Failed to generate error report ...")
 
-        return
-
     ##
     #  Slots
     ##
@@ -167,16 +163,15 @@ class NWErrorMessage(QDialog):
     def _doClose(self) -> None:
         """Close the dialog."""
         self.close()
-        return
 
 
 def exceptionHandler(exType: type, exValue: BaseException, exTrace: TracebackType) -> None:
-    """Function to catch unhandled global exceptions."""
+    """Catch unhandled global exceptions."""
     from traceback import print_tb
 
     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/extensions/configlayout.py

@@ -24,10 +24,10 @@ General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 along with this program. If not, see <https://www.gnu.org/licenses/>.
-"""
+"""  # noqa
 from __future__ import annotations
 
-from PyQt6.QtGui import QColor, QFont, QPalette, QPixmap
+from PyQt6.QtGui import QColor, QFont, QPalette
 from PyQt6.QtWidgets import (
     QAbstractButton, QFrame, QHBoxLayout, QLabel, QLayout, QScrollArea,
     QVBoxLayout, QWidget
@@ -39,7 +39,7 @@ DEFAULT_SCALE = 0.9
 
 
 class NFixedPage(QFrame):
-    """Extension: Fixed Page Widget
+    """Extension: Fixed Page Widget.
 
     A custom widget that holds a layout. This is just a wrapper around a
     QFrame that sets the same frame style as the other Page widgets.
@@ -49,23 +49,20 @@ class NFixedPage(QFrame):
         super().__init__(parent=parent)
         self.setFrameShadow(QFrame.Shadow.Sunken)
         self.setFrameShape(QFrame.Shape.StyledPanel)
-        return
 
     def setCentralLayout(self, layout: QLayout) -> None:
         """Set a layout as the central object."""
         self.setLayout(layout)
-        return
 
     def setCentralWidget(self, widget: QWidget) -> None:
         """Set a layout as the central object."""
         layout = QHBoxLayout()
         layout.addWidget(widget)
         self.setLayout(layout)
-        return
 
 
 class NScrollablePage(QScrollArea):
-    """Extension: Scrollable Page Widget
+    """Extension: Scrollable Page Widget.
 
     A custom widget that holds a layout within a scrollable area.
     """
@@ -79,16 +76,14 @@ class NScrollablePage(QScrollArea):
         self.setVerticalScrollBarPolicy(QtScrollAsNeeded)
         self.setFrameShadow(QFrame.Shadow.Sunken)
         self.setFrameShape(QFrame.Shape.StyledPanel)
-        return
 
     def setCentralLayout(self, layout: QLayout) -> None:
         """Set the central layout of the scroll page."""
         self._widget.setLayout(layout)
-        return
 
 
 class NScrollableForm(QScrollArea):
-    """Extension: Scrollable Form Widget
+    """Extension: Scrollable Form Widget.
 
     A custom widget that creates a form within a scrollable area.
     """
@@ -117,8 +112,6 @@ class NScrollableForm(QScrollArea):
         self.setFrameShadow(QFrame.Shadow.Sunken)
         self.setFrameShape(QFrame.Shape.StyledPanel)
 
-        return
-
     ##
     #  Properties
     ##
@@ -135,18 +128,15 @@ class NScrollableForm(QScrollArea):
         """Set the text color for the help text."""
         self._helpCol = color
         self._fontScale = scale
-        return
 
     def setHelpText(self, key: str, text: str) -> None:
         """Set the text for the help label."""
         if qHelp := self._editable.get(key):
             qHelp.setText(text)
-        return
 
     def setRowIndent(self, indent: int) -> None:
         """Set the indentation of each row."""
         self._indent = max(indent, 0)
-        return
 
     ##
     #  Methods
@@ -158,7 +148,6 @@ class NScrollableForm(QScrollArea):
             yPos = self._sections[identifier].pos().y() - 8
             if vBar := self.verticalScrollBar():
                 vBar.setValue(yPos)
-        return
 
     def scrollToLabel(self, label: str) -> None:
         """Scroll to the requested label."""
@@ -166,7 +155,6 @@ class NScrollableForm(QScrollArea):
             yPos = self._index[label].pos().y() - 8
             if vBar := self.verticalScrollBar():
                 vBar.setValue(yPos)
-        return
 
     def addGroupLabel(self, label: str, identifier: int | None = None) -> None:
         """Add a text label to separate groups of settings."""
@@ -178,12 +166,11 @@ class NScrollableForm(QScrollArea):
         self._first = False
         if identifier is not None:
             self._sections[identifier] = qLabel
-        return
 
     def addRow(
         self,
         label: str | None,
-        widget: QWidget | list[QWidget | QPixmap | int],
+        widget: QWidget | list[QWidget | int],
         helpText: str = "",
         unit: str | None = None,
         button: QWidget | None = None,
@@ -200,10 +187,6 @@ class NScrollableForm(QScrollArea):
             for item in widget:
                 if isinstance(item, QWidget):
                     wBox.addWidget(item)
-                elif isinstance(item, QPixmap):
-                    icon = QLabel(self)
-                    icon.setPixmap(item)
-                    wBox.addWidget(icon)
                 elif isinstance(item, int):
                     wBox.addSpacing(item)
             qWidget = QWidget(self)
@@ -252,17 +235,14 @@ class NScrollableForm(QScrollArea):
             self._index[label.strip()] = qWidget
         qLabel.setAccessibleName(text)
 
-        return
-
     def finalise(self) -> None:
         """Finalise the layout when the form is built."""
         self._layout.addSpacing(20)
         self._layout.addStretch(1)
-        return
 
 
 class NColorLabel(QLabel):
-    """Extension: A Coloured Label
+    """Extension: A Coloured Label.
 
     A custom widget that draws a label in a specific colour, and
     optionally at a specific size, and word wrapped.
@@ -298,21 +278,17 @@ class NColorLabel(QLabel):
         self.setWordWrap(wrap)
         self.setColorState(True)
 
-        return
-
     def setTextColors(self, *, color: QColor | None = None, faded: QColor | None = None) -> None:
         """Set or update the text colours."""
         self._color = color or self._color
         self._faded = faded or self._faded
         self._refeshTextColor()
-        return
 
     def setColorState(self, state: bool) -> None:
         """Change the colour state."""
         if self._state is not state:
             self._state = state
             self._refeshTextColor()
-        return
 
     def _refeshTextColor(self) -> None:
         """Refresh the colour of the text on the label."""
@@ -322,11 +298,10 @@ class NColorLabel(QLabel):
             self._color if self._state else self._faded,
         )
         self.setPalette(palette)
-        return
 
 
 class NWrappedWidgetBox(QHBoxLayout):
-    """Extension: A Text-Wrapped Widget Box
+    """Extension: A Text-Wrapped Widget Box.
 
     A custom layout box where a widget is wrapped in text labels on
     either side within a layout box. The widget is inserted at the {0}
@@ -341,4 +316,3 @@ class NWrappedWidgetBox(QHBoxLayout):
         self.addWidget(widget)
         if after:
             self.addWidget(QLabel(after.lstrip()))
-        return

novelwriter/extensions/eventfilters.py

@@ -21,7 +21,7 @@ General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 along with this program. If not, see <https://www.gnu.org/licenses/>.
-"""
+"""  # noqa
 from __future__ import annotations
 
 from typing import TYPE_CHECKING
@@ -34,7 +34,7 @@ if TYPE_CHECKING:
 
 
 class WheelEventFilter(QObject):
-    """Extensions: Wheel Event Filter
+    """Extensions: Wheel Event Filter.
 
     An event filter that filters mouse wheel events for a widget and
     forward them to the root widget. This solves the lack of mouse wheel
@@ -50,7 +50,6 @@ class WheelEventFilter(QObject):
         super().__init__(parent=parent)
         self._parent = parent
         self._locked = False
-        return
 
     def eventFilter(self, obj: QObject, event: QEvent) -> bool:
         """Filter events of type QWheelEvent and forward them to the
@@ -69,6 +68,7 @@ class WheelEventFilter(QObject):
 
 
 class StatusTipFilter(QObject):
+    """Filter: Remove StatusBar ToolTips."""
 
     def eventFilter(self, obj: QObject, event: QEvent) -> bool:
         """Filter out status tip events on menus."""