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

novelwriter/core/projectdata.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
@@ -41,7 +41,7 @@ logger = logging.getLogger(__name__)
 
 
 class NWProjectData:
-    """Core: Project Data Class
+    """Core: Project Data Class.
 
     The class holds all project data from the main XML file, aside from
     the list of project items.
@@ -86,8 +86,6 @@ class NWProjectData:
         self._status = NWStatus(NWStatus.STATUS)
         self._import = NWStatus(NWStatus.IMPORT)
 
-        return
-
     ##
     #  Properties
     ##
@@ -191,13 +189,11 @@ class NWProjectData:
         """Increment the save count by one."""
         self._saveCount += 1
         self._project.setProjectChanged(True)
-        return
 
     def incAutoCount(self) -> None:
         """Increment the auto save count by one."""
         self._autoCount += 1
         self._project.setProjectChanged(True)
-        return
 
     ##
     #  Getters
@@ -219,67 +215,57 @@ class NWProjectData:
         elif value != self._uuid:
             self._uuid = value
             self._project.setProjectChanged(True)
-        return
 
     def setName(self, value: str | None) -> None:
         """Set a new project name."""
         if value != self._name:
             self._name = simplified(str(value or ""))
             self._project.setProjectChanged(True)
-        return
 
     def setAuthor(self, value: str | None) -> None:
         """Set the author value."""
         if value != self._author:
             self._author = simplified(str(value or ""))
             self._project.setProjectChanged(True)
-        return
 
     def setSaveCount(self, value: Any) -> None:
         """Set the save count from last session."""
         self._saveCount = checkInt(value, 0)
         self._project.setProjectChanged(True)
-        return
 
     def setAutoCount(self, value: Any) -> None:
         """Set the auto save count from last session."""
         self._autoCount = checkInt(value, 0)
         self._project.setProjectChanged(True)
-        return
 
     def setEditTime(self, value: Any) -> None:
         """Set the edit time from last session."""
         self._editTime = checkInt(value, 0)
         self._project.setProjectChanged(True)
-        return
 
     def setDoBackup(self, value: Any) -> None:
         """Set the do write backup flag."""
         if value != self._doBackup:
             self._doBackup = checkBool(value, False)
             self._project.setProjectChanged(True)
-        return
 
     def setLanguage(self, value: str | None) -> None:
         """Set the project language."""
         if value != self._language:
             self._language = checkStringNone(value, None)
             self._project.setProjectChanged(True)
-        return
 
     def setSpellCheck(self, value: Any) -> None:
         """Set the spell check flag."""
         if value != self._spellCheck:
             self._spellCheck = checkBool(value, False)
             self._project.setProjectChanged(True)
-        return
 
     def setSpellLang(self, value: str | None) -> None:
         """Set the spell check language."""
         if value != self._spellLang:
             self._spellLang = checkStringNone(value, None)
             self._project.setProjectChanged(True)
-        return
 
     def setLastHandle(self, value: str | None, component: str) -> None:
         """Set a last used handle into the handle registry for a given
@@ -288,7 +274,6 @@ class NWProjectData:
         if isinstance(component, str):
             self._lastHandle[component] = checkStringNone(value, None)
             self._project.setProjectChanged(True)
-        return
 
     def setLastHandles(self, value: dict) -> None:
         """Set the full last handles dictionary to a new set of values.
@@ -299,7 +284,6 @@ class NWProjectData:
                 if key in self._lastHandle:
                     self._lastHandle[key] = str(entry) if isHandle(entry) else None
             self._project.setProjectChanged(True)
-        return
 
     def setInitCounts(
         self, wNovel: Any = None, wNotes: Any = None, cNovel: Any = None, cNotes: Any = None
@@ -321,7 +305,6 @@ class NWProjectData:
             count = checkInt(cNotes, 0)
             self._initCounts[3] = count
             self._currCounts[3] = count
-        return
 
     def setCurrCounts(
         self, wNovel: Any = None, wNotes: Any = None, cNovel: Any = None, cNotes: Any = None
@@ -335,7 +318,6 @@ class NWProjectData:
             self._currCounts[2] = checkInt(cNovel, 0)
         if cNotes is not None:
             self._currCounts[3] = checkInt(cNotes, 0)
-        return
 
     def setAutoReplace(self, value: dict) -> None:
         """Set the auto-replace dictionary."""
@@ -345,4 +327,3 @@ class NWProjectData:
                 if isinstance(entry, str):
                     self._autoReplace[key] = simplified(entry)
             self._project.setProjectChanged(True)
-        return

novelwriter/core/projectxml.py

@@ -22,7 +22,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
@@ -46,7 +46,7 @@ if TYPE_CHECKING:
 logger = logging.getLogger(__name__)
 
 FILE_VERSION = "1.5"  # The current project file format version
-FILE_REVISION = "5"   # The current project file format revision
+FILE_REVISION = "6"   # The current project file format revision
 HEX_VERSION = 0x0105
 
 NUM_VERSION = {
@@ -72,7 +72,7 @@ class XMLReadState(Enum):
 
 
 class ProjectXMLReader:
-    """Core: Project XML Reader
+    """Core: Project XML Reader.
 
     All data is read into a NWProjectData instance, which must be
     provided.
@@ -111,6 +111,8 @@ class ProjectXMLReader:
                nodes. 2.5.
         Rev 5: Added novelChars and notesChars attributes to content
                node. 2.7 RC 1.
+        Rev 6: Replaced red, green and blue attributes with a single
+               color attribute. 2.8 Beta 1.
     """
 
     def __init__(self, path: str | Path) -> None:
@@ -122,7 +124,6 @@ class ProjectXMLReader:
         self._appVersion = ""
         self._hexVersion = 0x0
         self._timeStamp = ""
-        return
 
     ##
     #  Properties
@@ -252,8 +253,6 @@ class ProjectXMLReader:
                 elif xItem.tag == "editTime":  # Moved to attribute in 1.5
                     data.setEditTime(xItem.text)
 
-        return
-
     def _parseProjectSettings(self, xSection: ET.Element, data: NWProjectData) -> None:
         """Parse the settings section of the XML file."""
         logger.debug("Parsing <settings> section")
@@ -292,8 +291,6 @@ class ProjectXMLReader:
                 elif xItem.tag == "notesWordCount":  # Moved to content attribute in 1.5
                     data.setInitCounts(wNotes=xItem.text)
 
-        return
-
     def _parseProjectContent(
         self, xSection: ET.Element, data: NWProjectData, content: list
     ) -> None:
@@ -354,8 +351,6 @@ class ProjectXMLReader:
                 "nameAttr": name,
             })
 
-        return
-
     def _parseProjectContentLegacy(
         self, xSection: ET.Element, data: NWProjectData, content: list
     ) -> None:
@@ -432,20 +427,20 @@ class ProjectXMLReader:
                 "nameAttr": name,
             })
 
-        return
-
     def _parseStatusImport(self, xItem: ET.Element, sObject: NWStatus) -> None:
         """Parse a status or importance entry."""
         for xEntry in xItem:
             if xEntry.tag == "entry":
                 key   = xEntry.attrib.get("key", None)
-                red   = checkInt(xEntry.attrib.get("red", 0), 0)
-                green = checkInt(xEntry.attrib.get("green", 0), 0)
-                blue  = checkInt(xEntry.attrib.get("blue", 0), 0)
+                red   = checkInt(xEntry.attrib.get("red", 0), 0)    # Removed in 1.5 R6
+                green = checkInt(xEntry.attrib.get("green", 0), 0)  # Removed in 1.5 R6
+                blue  = checkInt(xEntry.attrib.get("blue", 0), 0)   # Removed in 1.5 R6
+                color = xEntry.attrib.get("color")  # Added in 1.5 R6
                 count = checkInt(xEntry.attrib.get("count", 0), 0)
                 shape = xEntry.attrib.get("shape", "")
-                sObject.add(key, xEntry.text or "", (red, green, blue), shape, count)
-        return
+                if color is None:
+                    color = f"{red}, {green}, {blue}"
+                sObject.add(key, xEntry.text or "", color, shape, count)
 
     def _parseDictKeyText(self, xItem: ET.Element) -> dict:
         """Parse a dictionary stored with key as an attribute and the
@@ -465,7 +460,7 @@ class ProjectXMLReader:
 
 
 class ProjectXMLWriter:
-    """Core: Project XML Writer
+    """Core: Project XML Writer.
 
     The project writer class will only write a file according to the
     very latest spec.
@@ -474,7 +469,6 @@ class ProjectXMLWriter:
     def __init__(self, path: str | Path) -> None:
         self._path = Path(path)
         self._error = None
-        return
 
     ##
     #  Properties
@@ -575,7 +569,6 @@ class ProjectXMLWriter:
         """Pack a single value into an XML element."""
         xItem = ET.SubElement(xParent, name, attrib=attrib or {})
         xItem.text = str(value) or ""
-        return
 
     def _packDictKeyValue(self, xParent: ET.Element, name: str, data: dict) -> None:
         """Pack the entries of a dictionary into an XML element."""
@@ -584,4 +577,3 @@ class ProjectXMLWriter:
             if len(key) > 0:
                 xEntry = ET.SubElement(xItem, "entry", attrib={"key": key})
                 xEntry.text = str(value) or ""
-        return

novelwriter/core/sessions.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 json
@@ -43,7 +43,7 @@ logger = logging.getLogger(__name__)
 
 
 class NWSessionLog:
-    """Core: Session JSON Lines Log File
+    """Core: Session JSON Lines Log File.
 
     The class that wraps the session log file, which is in JSON Lines
     format. That is, one JSON object per line.
@@ -52,7 +52,6 @@ class NWSessionLog:
     def __init__(self, project: NWProject) -> None:
         self._project = project
         self._start = 0.0
-        return
 
     ##
     #  Properties
@@ -70,7 +69,6 @@ class NWSessionLog:
     def startSession(self) -> None:
         """Start the writing session."""
         self._start = time()
-        return
 
     def appendSession(self, idleTime: float) -> bool:
         """Append session statistics to the sessions log file."""

novelwriter/core/spellcheck.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
 
 import json
@@ -44,7 +44,7 @@ logger = logging.getLogger(__name__)
 
 
 class NWSpellEnchant:
-    """Core: Enchant Spell Checking Wrapper
+    """Core: Enchant Spell Checking Wrapper.
 
     This is a rapper class for Enchant to keep the API consistent
     between spell check tools.
@@ -57,11 +57,9 @@ class NWSpellEnchant:
         self._language = None
         self._broker = None
         logger.debug("Ready: NWSpellEnchant")
-        return
 
     def __del__(self) -> None:  # pragma: no cover
         logger.debug("Delete: NWSpellEnchant")
-        return
 
     ##
     #  Properties
@@ -106,21 +104,19 @@ class NWSpellEnchant:
             for word in self._userDict:
                 self._enchant.add_to_session(word)
 
-        return
-
     ##
     #  Methods
     ##
 
     def checkWord(self, word: str) -> bool:
-        """Wrapper function for pyenchant."""
+        """Forward check to pyenchant."""
         try:
             return bool(self._enchant.check(word))
         except Exception:
             return True
 
     def suggestWords(self, word: str) -> list[str]:
-        """Wrapper function for pyenchant."""
+        """Ask pyenchant for suggestions."""
         try:
             return self._enchant.suggest(word)
         except Exception:
@@ -172,24 +168,29 @@ class FakeEnchant:
         self.tag = ""
         self.provider = FakeProvider()
 
-        return
-
     def check(self, word: str) -> bool:
+        """Return True for all words."""
         return True
 
     def suggest(self, word: str) -> list[str]:
+        """Return an empty suggestion list."""
         return []
 
     def add_to_session(self, word: str) -> None:
+        """Do nothing."""
         return
 
 
 class UserDictionary:
+    """Core: User Word Dictionary.
+
+    This class holds all the user's own words for spell checking
+    purposes. The dictionary is per-project.
+    """
 
     def __init__(self, project: NWProject) -> None:
         self._project = project
         self._words = set()
-        return
 
     def __contains__(self, word: str) -> bool:
         return word in self._words
@@ -219,7 +220,6 @@ class UserDictionary:
             except Exception:
                 logger.error("Failed to load user dictionary")
                 logException()
-        return
 
     def save(self) -> None:
         """Save the user's dictionary."""
@@ -232,4 +232,3 @@ class UserDictionary:
             except Exception:
                 logger.error("Failed to save user dictionary")
                 logException()
-        return

novelwriter/core/status.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
 
 import dataclasses
@@ -35,6 +35,7 @@ from PyQt6.QtGui import QColor, QIcon, QPainter, QPainterPath, QPixmap, QPolygon
 
 from novelwriter import SHARED
 from novelwriter.common import simplified
+from novelwriter.constants import nwLabels
 from novelwriter.enum import nwStatusShape
 from novelwriter.types import QtPaintAntiAlias, QtTransparent
 
@@ -43,12 +44,16 @@ if TYPE_CHECKING:
 
 logger = logging.getLogger(__name__)
 
+CUSTOM_COL = "custom"
+
 
 @dataclasses.dataclass
 class StatusEntry:
+    """DataClass: Status Label Values."""
 
     name: str
     color: QColor
+    theme: str
     shape: nwStatusShape
     icon: QIcon
     count: int = 0
@@ -62,13 +67,14 @@ class StatusEntry:
         return status
 
 
-NO_ENTRY = StatusEntry("", QColor(0, 0, 0), nwStatusShape.SQUARE, QIcon(), 0)
+NO_ENTRY = StatusEntry("", QColor(0, 0, 0), CUSTOM_COL, nwStatusShape.SQUARE, QIcon(), 0)
 
 T_UpdateEntry = list[tuple[str | None, StatusEntry]]
 T_StatusKind = Literal["s", "i"]
 
 
 class NWStatus:
+    """Core: Status/Importance Label Class."""
 
     STATUS = "s"
     IMPORT = "i"
@@ -80,7 +86,6 @@ class NWStatus:
         self._default = None
         self._prefix = prefix[:1]
         self._height = SHARED.theme.baseIconHeight
-        return
 
     def __len__(self) -> int:
         return len(self._store)
@@ -97,15 +102,12 @@ class NWStatus:
     #  Methods
     ##
 
-    def add(self, key: str | None, name: str, color: tuple[int, int, int],
-            shape: str, count: int) -> str:
+    def add(self, key: str | None, name: str, color: str, shape: str, count: int) -> str:
         """Add or update a status entry. If the key is invalid, a new
         key is generated.
         """
-        if isinstance(color, tuple) and len(color) == 3:
-            qColor = QColor(*color)
-        else:
-            qColor = QColor(100, 100, 100)
+        qColor = SHARED.theme.parseColor(color)
+        theme = color if color in nwLabels.THEME_COLORS else CUSTOM_COL
 
         try:
             iShape = nwStatusShape[shape]
@@ -115,7 +117,7 @@ class NWStatus:
         key = self._checkKey(key)
         name = simplified(name)
         icon = self.createIcon(self._height, qColor, iShape)
-        self._store[key] = StatusEntry(name, qColor, iShape, icon, count)
+        self._store[key] = StatusEntry(name, qColor, theme, iShape, icon, count)
 
         if self._default is None:
             self._default = key
@@ -132,8 +134,6 @@ class NWStatus:
         if self._default not in self._store:
             self._default = next(iter(self._store)) if self._store else None
 
-        return
-
     def check(self, value: str) -> str:
         """Check the key against the stored status names."""
         if self._isKey(value) and value in self._store:
@@ -146,23 +146,23 @@ class NWStatus:
         """Clear the counts of references to the status entries."""
         for entry in self._store.values():
             entry.count = 0
-        return
 
     def increment(self, key: str | None) -> None:
         """Increment the counter for a given entry."""
         if key and key in self._store:
             self._store[key].count += 1
-        return
 
     def pack(self) -> Iterable[tuple[str, dict]]:
         """Pack the status entries into a dictionary."""
         for key, entry in self._store.items():
+            if entry.theme == CUSTOM_COL:
+                color = entry.color.name(QColor.NameFormat.HexRgb)
+            else:
+                color = entry.theme
             yield (entry.name, {
                 "key":   key,
                 "count": str(entry.count),
-                "red":   str(entry.color.red()),
-                "green": str(entry.color.green()),
-                "blue":  str(entry.color.blue()),
+                "color": color,
                 "shape": entry.shape.name,
             })
         return
@@ -179,12 +179,20 @@ class NWStatus:
         try:
             shape = nwStatusShape[str(data[0])]
             color = QColor(str(data[1]))
+            theme = CUSTOM_COL if data[1].startswith("#") else data[1]
             icon = NWStatus.createIcon(self._height, color, shape)
-            return StatusEntry(simplified(data[2]), color, shape, icon)
+            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:
+        """Refresh all icons."""
+        for entry in self._store.values():
+            if entry.theme != CUSTOM_COL:
+                entry.color = SHARED.theme.parseColor(entry.theme)
+            entry.icon = NWStatus.createIcon(self._height, entry.color, entry.shape)
+
     @staticmethod
     def createIcon(height: int, color: QColor, shape: nwStatusShape) -> QIcon:
         """Generate an icon for a status label."""
@@ -240,7 +248,6 @@ class _ShapeCache:
 
     def __init__(self) -> None:
         self._cache: dict[nwStatusShape, QPainterPath] = {}
-        return
 
     def getShape(self, shape: nwStatusShape) -> QPainterPath:
         """Return a painter shape for an icon."""

novelwriter/core/storage.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 json
@@ -47,6 +47,7 @@ logger = logging.getLogger(__name__)
 
 
 class NWStorageOpen(Enum):
+    """The status of a storage location."""
 
     UNKOWN    = 0
     NOT_FOUND = 1
@@ -56,6 +57,7 @@ class NWStorageOpen(Enum):
 
 
 class NWStorageCreate(Enum):
+    """The status of a new storage location."""
 
     NOT_EMPTY = 0
     OS_ERROR  = 1
@@ -63,7 +65,7 @@ class NWStorageCreate(Enum):
 
 
 class NWStorage:
-    """Core: Project Storage Class
+    """Core: Project Storage Class.
 
     The class that handles all paths related to the project storage.
     """
@@ -81,7 +83,6 @@ class NWStorage:
         self._openMode = self.MODE_INACTIVE
         self._ready = False
         self._exception = None
-        return
 
     def clear(self) -> None:
         """Reset internal variables."""
@@ -90,7 +91,6 @@ class NWStorage:
         self._lockFilePath = None
         self._openMode = self.MODE_INACTIVE
         self._ready = False
-        return
 
     ##
     #  Properties
@@ -252,13 +252,11 @@ class NWStorage:
         """Lock the session when the project is successfully opened."""
         if self._ready:
             self._writeLockFile()
-        return
 
     def closeSession(self) -> None:
         """Run tasks related to closing the session."""
         self._clearLockFile()
         self.clear()
-        return
 
     ##
     #  Content Access Methods
@@ -394,7 +392,7 @@ class NWStorage:
 
 
 class _LegacyStorage:
-    """Core: Legacy Storage Converter Utils
+    """Core: Legacy Storage Converter Utils.
 
     A class with various functions to convert old file formats and
     file/folder layouts to the current project format.
@@ -402,7 +400,6 @@ class _LegacyStorage:
 
     def __init__(self, project: NWProject) -> None:
         self._project = project
-        return
 
     def legacyDataFolder(self, path: Path, child: Path) -> None:
         """Handle the content of a legacy data folder from a version 1.0
@@ -484,8 +481,6 @@ class _LegacyStorage:
                 except Exception as exc:
                     logger.warning("Failed to delete: %s", item, exc_info=exc)
 
-        return
-
     ##
     #  Internal Functions
     ##