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

novelwriter/core/buildsettings.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
@@ -211,7 +211,7 @@ class FilterMode(Enum):
 
 
 class BuildSettings:
-    """Core: Build Settings Class
+    """Core: Build Settings Class.
 
     This class manages the build settings for a Manuscript build job.
     The settings can be packed/unpacked to/from a dictionary for JSON.
@@ -229,7 +229,6 @@ class BuildSettings:
         self._included = set()
         self._settings = {k: v[1] for k, v in SETTINGS_TEMPLATE.items()}
         self._changed = False
-        return
 
     @classmethod
     def fromDict(cls, data: dict) -> BuildSettings:
@@ -315,7 +314,6 @@ class BuildSettings:
     def setName(self, name: str) -> None:
         """Set the build setting display name."""
         self._name = str(name)
-        return
 
     def setBuildID(self, value: str | uuid.UUID) -> None:
         """Set a UUID build ID."""
@@ -324,13 +322,11 @@ class BuildSettings:
             self._uuid = str(uuid.uuid4())
         elif value != self._uuid:
             self._uuid = value
-        return
 
     def setOrder(self, value: int) -> None:
         """Set the build order."""
         if isinstance(value, int):
             self._order = value
-        return
 
     def setLastBuildPath(self, path: Path | str | None) -> None:
         """Set the last used build path."""
@@ -341,41 +337,35 @@ class BuildSettings:
         else:
             self._path = CONFIG.homePath()
         self._changed = True
-        return
 
     def setLastBuildName(self, name: str) -> None:
         """Set the last used build name."""
         self._build = str(name).strip()
         self._changed = True
-        return
 
     def setLastFormat(self, value: nwBuildFmt) -> None:
         """Set the last used build format."""
         if isinstance(value, nwBuildFmt):
             self._format = value
             self._changed = True
-        return
 
     def setFiltered(self, tHandle: str) -> None:
         """Set an item as filtered."""
         self._excluded.discard(tHandle)
         self._included.discard(tHandle)
         self._changed = True
-        return
 
     def setIncluded(self, tHandle: str) -> None:
         """Set an item as explicitly included."""
         self._excluded.discard(tHandle)
         self._included.add(tHandle)
         self._changed = True
-        return
 
     def setExcluded(self, tHandle: str) -> None:
         """Set an item as explicitly excluded."""
         self._excluded.add(tHandle)
         self._included.discard(tHandle)
         self._changed = True
-        return
 
     def setAllowRoot(self, tHandle: str, state: bool) -> None:
         """Set a specific root folder as allowed or not."""
@@ -385,14 +375,12 @@ class BuildSettings:
         elif state is False:
             self._skipRoot.add(tHandle)
             self._changed = True
-        return
 
     def setValue(self, key: str, value: T_BuildValue) -> None:
         """Set a specific value for a build setting."""
         if (d := SETTINGS_TEMPLATE.get(key)) and len(d) == 2 and isinstance(value, d[0]):
             self._changed |= (value != self._settings[key])
             self._settings[key] = value
-        return
 
     ##
     #  Methods
@@ -463,7 +451,6 @@ class BuildSettings:
         called when the changes have been safely saved or passed on.
         """
         self._changed = False
-        return
 
     def pack(self) -> dict:
         """Pack all content into a JSON compatible dictionary."""
@@ -516,8 +503,6 @@ class BuildSettings:
 
         self._changed = False
 
-        return
-
     @classmethod
     def duplicate(cls, source: BuildSettings) -> BuildSettings:
         """Make a copy of another build."""
@@ -529,7 +514,7 @@ class BuildSettings:
 
 
 class BuildCollection:
-    """Core: Build Collection Class
+    """Core: Build Collection Class.
 
     This object holds all the build setting objects defined by the given
     project. The build settings are saved as a single JSON file in the
@@ -542,7 +527,6 @@ class BuildCollection:
         self._defaultBuild = ""
         self._builds: dict[str, BuildSettings] = {}
         self._loadCollection()
-        return
 
     def __len__(self) -> int:
         """Return the number of builds."""
@@ -581,21 +565,18 @@ class BuildCollection:
                 build.setOrder(i)
         self._lastBuild = lastBuild
         self._saveCollection()
-        return
 
     def setDefaultBuild(self, buildID: str) -> None:
         """Set the default build id."""
         if buildID != self._defaultBuild:
             self._defaultBuild = buildID
             self._saveCollection()
-        return
 
     def setBuild(self, build: BuildSettings) -> None:
         """Set build settings data in the collection."""
         if isinstance(build, BuildSettings):
             self._builds[build.buildID] = build
             self._saveCollection()
-        return
 
     ##
     #  Methods
@@ -605,7 +586,6 @@ class BuildCollection:
         """Remove a build from the collection."""
         self._builds.pop(buildID, None)
         self._saveCollection()
-        return
 
     def builds(self) -> Iterable[tuple[str, str]]:
         """Iterate over all available builds."""

novelwriter/core/coretools.py

@@ -23,7 +23,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
@@ -52,7 +52,9 @@ logger = logging.getLogger(__name__)
 
 
 class DocMerger:
-    """Document tool for merging a set of documents into a single new
+    """Tool: Merge Documents.
+
+    Document tool for merging a set of documents into a single new
     document. The parameters are defined by the user using the
     GuiDocMerge dialog.
     """
@@ -62,7 +64,6 @@ class DocMerger:
         self._error = ""
         self._target = None
         self._text = []
-        return
 
     @property
     def targetHandle(self) -> str | None:
@@ -85,7 +86,6 @@ class DocMerger:
         """
         self._target = self._project.tree[tHandle]
         self._text = []
-        return
 
     def newTargetDoc(self, sHandle: str, label: str) -> None:
         """Create a brand new target document based on a source handle
@@ -101,7 +101,6 @@ class DocMerger:
                 nwItem.notifyToRefresh()
                 self._target = nwItem
                 self._text = []
-        return
 
     def appendText(self, sHandle: str, addComment: bool, cmtPrefix: str) -> None:
         """Append text from an existing document to the text buffer."""
@@ -112,7 +111,6 @@ class DocMerger:
                 status, _ = item.getImportStatus()
                 text = f"% {cmtPrefix} {info}: {item.itemName} [{status}]\n\n{text}"
             self._text.append(text)
-        return
 
     def writeTargetDoc(self) -> bool:
         """Write the accumulated text into the designated target
@@ -158,7 +156,8 @@ class DocSplitter:
             self._srcHandle = sHandle
             self._srcItem = srcItem
 
-        return
+    def __len__(self) -> int:
+        return len(self._rawData)
 
     ##
     #  Methods
@@ -174,7 +173,6 @@ class DocSplitter:
         """
         self._parHandle = pHandle
         self._inFolder = False
-        return
 
     def newParentFolder(self, pHandle: str, folderLabel: str) -> None:
         """Create a new folder that will be the top level parent item
@@ -188,7 +186,6 @@ class DocSplitter:
                 nwItem.notifyToRefresh()
             self._parHandle = nHandle
             self._inFolder = True
-        return
 
     def splitDocument(self, splitData: list, splitText: list[str]) -> None:
         """Loop through the split data record and perform the split job
@@ -200,12 +197,9 @@ class DocSplitter:
             chunk = buffer[lineNo:]
             buffer = buffer[:lineNo]
             self._rawData.insert(0, (chunk, hLevel, hLabel))
-        return
 
     def writeDocuments(self, docHierarchy: bool) -> Iterable[bool]:
-        """An iterator that will write each document in the buffer, and
-        return its new handle, parent handle, and sibling handle.
-        """
+        """Write each document in the buffer and yield if successful."""
         if self._srcHandle and self._srcItem and self._parHandle:
             pHandle = self._parHandle
             hHandle = [self._parHandle, None, None, None, None]
@@ -256,7 +250,6 @@ class DocDuplicator:
 
     def __init__(self, project: NWProject) -> None:
         self._project = project
-        return
 
     ##
     #  Methods
@@ -270,7 +263,9 @@ class DocDuplicator:
         after = True
         if items:
             hMap: dict[str, str | None] = {t: None for t in items}
+            SHARED.initMainProgress(len(items))
             for tHandle in items:
+                SHARED.incMainProgress()
                 if oldItem := self._project.tree[tHandle]:
                     pHandle = hMap.get(oldItem.itemParent or "") or oldItem.itemParent
                     if newItem := self._project.tree.duplicate(tHandle, pHandle, after):
@@ -282,17 +277,21 @@ class DocDuplicator:
                     after = False
                 else:
                     break
+            SHARED.clearMainProgress()
         return result
 
 
 class DocSearch:
+    """Tool: Search Documents.
+
+    A global document search class.
+    """
 
     def __init__(self) -> None:
         self._regEx = re.compile(r"")
-        self._opts = re.UNICODE | re.IGNORECASE
+        self._opts = re.IGNORECASE
         self._words = False
         self._escape = True
-        return
 
     ##
     #  Methods
@@ -300,32 +299,30 @@ class DocSearch:
 
     def setCaseSensitive(self, state: bool) -> None:
         """Set the case sensitive search flag."""
-        self._opts = re.UNICODE
-        if not state:
-            self._opts |= re.IGNORECASE
-        return
+        self._opts = 0 if state else re.IGNORECASE
 
     def setWholeWords(self, state: bool) -> None:
         """Set the whole words search flag."""
         self._words = state
-        return
 
     def setUserRegEx(self, state: bool) -> None:
         """Set the escape flag to the opposite state."""
         self._escape = not state
-        return
 
     def iterSearch(
         self, project: NWProject, search: str
     ) -> Iterable[tuple[NWItem, list[tuple[int, int, str]], bool]]:
-        """Iteratively search through documents in a project."""
+        """Iterate through documents in a project and apply search."""
         self._regEx = re.compile(self._buildPattern(search), self._opts)
         logger.debug("Searching with pattern '%s'", self._regEx.pattern)
         storage = project.storage
+        SHARED.initMainProgress(len(project.tree))
         for item in project.tree:
+            SHARED.incMainProgress()
             if item.isFileType():
                 results, capped = self.searchText(storage.getDocumentText(item.itemHandle))
                 yield item, results, capped
+        SHARED.clearMainProgress()
         return
 
     def searchText(self, text: str) -> tuple[list[tuple[int, int, str]], bool]:
@@ -368,7 +365,6 @@ class ProjectBuilder:
     def __init__(self) -> None:
         self._path = None
         self.tr = partial(QCoreApplication.translate, "ProjectBuilder")
-        return
 
     @property
     def projPath(self) -> Path | None:
@@ -609,6 +605,6 @@ class ProjectBuilder:
         project.data.setSaveCount(0)
         project.data.setAutoCount(0)
         project.data.setEditTime(0)
+        project.index.rebuild()
         project.saveProject()
         project.closeProject()
-        return

novelwriter/core/docbuild.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
@@ -53,7 +53,7 @@ logger = logging.getLogger(__name__)
 
 
 class NWBuildDocument:
-    """Core: Manuscript Document Build Class
+    """Core: Manuscript Document Build Class.
 
     This is the core tool that assembles a project and outputs a
     manuscript, based on a build definition object (BuildSettings).
@@ -72,7 +72,6 @@ class NWBuildDocument:
         self._cache = None
         self._count = False
         self._outline = False
-        return
 
     ##
     #  Properties
@@ -106,7 +105,6 @@ class NWBuildDocument:
     def addDocument(self, tHandle: str) -> None:
         """Add a document to the build queue manually."""
         self._queue.append(tHandle)
-        return
 
     def queueAll(self) -> None:
         """Queue all document as defined by the build settings."""
@@ -115,7 +113,6 @@ class NWBuildDocument:
         for item in self._project.tree:
             if filtered.get(item.itemHandle, False):
                 self._queue.append(item.itemHandle)
-        return
 
     def iterBuildPreview(self, newPage: bool) -> Iterable[tuple[int, bool]]:
         """Build a preview QTextDocument."""
@@ -131,7 +128,7 @@ class NWBuildDocument:
         return
 
     def iterBuildDocument(self, path: Path, bFormat: nwBuildFmt) -> Iterable[tuple[int, bool]]:
-        """Wrapper for builders based on format."""
+        """Select a builder based on format."""
         self._error = None
         self._cache = None
 
@@ -341,12 +338,10 @@ class NWBuildDocument:
                 scale*self._build.getFloat("format.rightMargin"),
             )
 
-        filtered = self._build.buildItemFilter(
+        return self._build.buildItemFilter(
             self._project, withRoots=self._build.getBool("text.addNoteHeadings")
         )
 
-        return filtered
-
     def _doBuild(self, bldObj: Tokenizer, tHandle: str, convert: bool = True) -> bool:
         """Build a single document and add it to the build object."""
         tItem = self._project.tree[tHandle]

novelwriter/core/document.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 hashlib
@@ -42,7 +42,7 @@ logger = logging.getLogger(__name__)
 
 
 class NWDocument:
-    """Core: Document Class
+    """Core: Document Class.
 
     A Class wrapping a single novelWriter document file. It represents
     a project item of nwItemType FILE. The file is not guaranteed to
@@ -68,8 +68,6 @@ class NWDocument:
         if self._handle is not None:
             self._item = self._project.tree[tHandle]
 
-        return
-
     def __repr__(self) -> str:
         return f"<NWDocument handle={self._handle}>"
 
@@ -357,5 +355,3 @@ class NWDocument:
 
         else:
             logger.debug("Unknown meta data: '%s'", metaLine.strip())
-
-        return