novelWriter 2.6.2__py3-none-any.whl → 2.7__py3-none-any.whl

novelwriter/core/coretools.py

@@ -30,20 +30,24 @@ import logging
 import re
 import shutil
 
-from collections.abc import Iterable
 from functools import partial
 from pathlib import Path
+from typing import TYPE_CHECKING
 from zipfile import ZipFile, is_zipfile
 
-from PyQt5.QtCore import QCoreApplication
+from PyQt6.QtCore import QCoreApplication
 
 from novelwriter import CONFIG, SHARED
 from novelwriter.common import isHandle, minmax, simplified
 from novelwriter.constants import nwConst, nwFiles, nwItemClass, nwStats
-from novelwriter.core.item import NWItem
 from novelwriter.core.project import NWProject
 from novelwriter.core.storage import NWStorageCreate
 
+if TYPE_CHECKING:
+    from collections.abc import Iterable
+
+    from novelwriter.core.item import NWItem
+
 logger = logging.getLogger(__name__)
 
 
@@ -284,7 +288,7 @@ class DocDuplicator:
 class DocSearch:
 
     def __init__(self) -> None:
-        self._regEx = re.compile("")
+        self._regEx = re.compile(r"")
         self._opts = re.UNICODE | re.IGNORECASE
         self._words = False
         self._escape = True
@@ -379,10 +383,12 @@ class ProjectBuilder:
         """Build or copy a project from a data dictionary."""
         if isinstance(data, dict):
             path = data.get("path", None) or None
-            if isinstance(path, (str, Path)):
+            if author := data.get("author"):
+                CONFIG.setLastAuthor(author)
+            if isinstance(path, str | Path):
                 self._path = Path(path).resolve()
-                if data.get("sample", False):
-                    return self._extractSampleProject(self._path)
+                if data.get("sample"):
+                    return self._extractSampleProject(self._path, data)
                 elif data.get("template"):
                     return self._copyProject(self._path, data)
                 else:
@@ -412,20 +418,21 @@ class ProjectBuilder:
 
         self._path = project.storage.storagePath
 
-        lblNewProject = self.tr("New Project")
-        lblTitlePage  = self.tr("Title Page")
+        trName = self.tr("New Project")
+        trAuthor = self.tr("Author Name")
+        trTitlePage = self.tr("Title Page")
 
         # Settings
         project.data.setUuid(None)
-        project.data.setName(data.get("name", lblNewProject))
-        project.data.setAuthor(data.get("author", ""))
+        project.data.setName(data.get("name", trName))
+        project.data.setAuthor(data.get("author", trAuthor))
         project.data.setLanguage(CONFIG.guiLocale)
         project.setDefaultStatusImport()
         project.session.startSession()
 
         # Add Root Folders
         hNovelRoot = project.newRoot(nwItemClass.NOVEL)
-        hTitlePage = project.newFile(lblTitlePage, hNovelRoot)
+        hTitlePage = project.newFile(trTitlePage, hNovelRoot)
 
         # Generate Title Page
         aDoc = project.storage.getDocument(hTitlePage)
@@ -442,25 +449,21 @@ class ProjectBuilder:
             "\n"
             ">> {count}: [field:{field}] <<\n"
         ).format(
-            author=project.data.author or "None",
-            address=self.tr("Address"),
-            title=project.data.name or "None",
+            author=project.data.author or trAuthor,
+            address=self.tr("Address Line"),
+            title=project.data.name or trName,
             by=self.tr("By"),
             count=self.tr("Word Count"),
             field=nwStats.WORDS_TEXT,
         ))
 
-        # Create a project structure based on selected root folders
-        # and a number of chapters and scenes selected in the
-        # wizard's custom page.
-
         # Create chapters and scenes
         numChapters = data.get("chapters", 0)
         numScenes = data.get("scenes", 0)
 
-        chSynop = self.tr("Summary of the chapter.")
-        scSynop = self.tr("Summary of the scene.")
-        bfNote = self.tr("A short description.")
+        trChSynop = self.tr("Summary of the chapter.")
+        trScSynop = self.tr("Summary of the scene.")
+        trNoteDesc = self.tr("A short description.")
 
         # Create chapters
         if numChapters > 0:
@@ -468,7 +471,7 @@ class ProjectBuilder:
                 chTitle = self.tr("Chapter {0}").format(f"{ch+1:d}")
                 cHandle = project.newFile(chTitle, hNovelRoot)
                 aDoc = project.storage.getDocument(cHandle)
-                aDoc.writeDocument(f"## {chTitle}\n\n%Synopsis: {chSynop}\n\n")
+                aDoc.writeDocument(f"## {chTitle}\n\n%Synopsis: {trChSynop}\n\n")
 
                 # Create chapter scenes
                 if numScenes > 0 and cHandle:
@@ -476,7 +479,7 @@ class ProjectBuilder:
                         scTitle = self.tr("Scene {0}").format(f"{ch+1:d}.{sc+1:d}")
                         sHandle = project.newFile(scTitle, cHandle)
                         aDoc = project.storage.getDocument(sHandle)
-                        aDoc.writeDocument(f"### {scTitle}\n\n%Synopsis: {scSynop}\n\n")
+                        aDoc.writeDocument(f"### {scTitle}\n\n%Synopsis: {trScSynop}\n\n")
 
         # Create scenes (no chapters)
         elif numScenes > 0:
@@ -484,7 +487,7 @@ class ProjectBuilder:
                 scTitle = self.tr("Scene {0}").format(f"{sc+1:d}")
                 sHandle = project.newFile(scTitle, hNovelRoot)
                 aDoc = project.storage.getDocument(sHandle)
-                aDoc.writeDocument(f"### {scTitle}\n\n%Synopsis: {scSynop}\n\n")
+                aDoc.writeDocument(f"### {scTitle}\n\n%Synopsis: {trScSynop}\n\n")
 
         # Create notes folders
         noteTitles = {
@@ -504,12 +507,12 @@ class ProjectBuilder:
                     aDoc.writeDocument(
                         f"# {noteTitles[newRoot]}\n\n"
                         f"@tag: {ntTag}\n\n"
-                        f"%Short: {bfNote}\n\n"
+                        f"%Short: {trNoteDesc}\n\n"
                     )
 
         # Also add the archive and trash folders
         project.newRoot(nwItemClass.ARCHIVE)
-        project.tree.trash  # Triggers the creation of Trash
+        _ = project.tree.trash  # Triggers the creation of Trash
 
         project.saveProject()
         project.closeProject()
@@ -559,23 +562,11 @@ class ProjectBuilder:
             return False
 
         # Open the copied project and update settings
-        project = NWProject()
-        project.openProject(dstPath)
-        project.data.setUuid("")  # Creates a fresh uuid
-        project.data.setName(data.get("name", "None"))
-        project.data.setAuthor(data.get("author", ""))
-        project.data.setSpellCheck(True)
-        project.data.setSpellLang(None)
-        project.data.setDoBackup(True)
-        project.data.setSaveCount(0)
-        project.data.setAutoCount(0)
-        project.data.setEditTime(0)
-        project.saveProject()
-        project.closeProject()
+        self._resetProject(dstPath, data)
 
         return True
 
-    def _extractSampleProject(self, path: Path) -> bool:
+    def _extractSampleProject(self, path: Path, data: dict) -> bool:
         """Make a copy of the sample project by extracting the
         sample.zip file to the new path.
         """
@@ -589,6 +580,7 @@ class ProjectBuilder:
         if (sample := CONFIG.assetPath("sample.zip")).is_file():
             try:
                 shutil.unpack_archive(sample, path)
+                self._resetProject(path, data)
             except Exception as exc:
                 SHARED.error(self.tr("Failed to create a new example project."), exc=exc)
                 return False
@@ -601,3 +593,22 @@ class ProjectBuilder:
             return False
 
         return True
+
+    def _resetProject(self, path: Path, data: dict) -> None:
+        """Open a project and reset/update its settings."""
+        project = NWProject()
+        project.openProject(path)
+        project.data.setUuid("")  # Creates a fresh uuid
+        if name := data.get("name", ""):
+            project.data.setName(name)
+        if author := data.get("author", ""):
+            project.data.setAuthor(author)
+        project.data.setSpellCheck(True)
+        project.data.setSpellLang(None)
+        project.data.setDoBackup(True)
+        project.data.setSaveCount(0)
+        project.data.setAutoCount(0)
+        project.data.setEditTime(0)
+        project.saveProject()
+        project.closeProject()
+        return

novelwriter/core/docbuild.py

@@ -25,26 +25,30 @@ from __future__ import annotations
 
 import logging
 
-from collections.abc import Iterable
-from pathlib import Path
+from typing import TYPE_CHECKING
 
-from PyQt5.QtGui import QFont
+from PyQt6.QtGui import QFont
 
 from novelwriter import CONFIG
 from novelwriter.constants import nwLabels
-from novelwriter.core.buildsettings import BuildSettings
 from novelwriter.core.item import NWItem
-from novelwriter.core.project import NWProject
-from novelwriter.enum import nwBuildFmt
+from novelwriter.enum import nwBuildFmt, nwComment
 from novelwriter.error import formatException, logException
 from novelwriter.formats.todocx import ToDocX
 from novelwriter.formats.tohtml import ToHtml
-from novelwriter.formats.tokenizer import Tokenizer
 from novelwriter.formats.tomarkdown import ToMarkdown
 from novelwriter.formats.toodt import ToOdt
 from novelwriter.formats.toqdoc import ToQTextDocument
 from novelwriter.formats.toraw import ToRaw
 
+if TYPE_CHECKING:
+    from collections.abc import Iterable
+    from pathlib import Path
+
+    from novelwriter.core.buildsettings import BuildSettings
+    from novelwriter.core.project import NWProject
+    from novelwriter.formats.tokenizer import Tokenizer
+
 logger = logging.getLogger(__name__)
 
 
@@ -56,8 +60,8 @@ class NWBuildDocument:
     """
 
     __slots__ = (
-        "_project", "_build", "_queue", "_error", "_cache", "_count",
-        "_outline",
+        "_build", "_cache", "_count", "_error", "_outline", "_project",
+        "_queue",
     )
 
     def __init__(self, project: NWProject, build: BuildSettings) -> None:
@@ -307,22 +311,25 @@ class NWBuildDocument:
         )
 
         bldObj.setBodyText(self._build.getBool("text.includeBodyText"))
-        bldObj.setSynopsis(self._build.getBool("text.includeSynopsis"))
-        bldObj.setComments(self._build.getBool("text.includeComments"))
         bldObj.setKeywords(self._build.getBool("text.includeKeywords"))
         bldObj.setIgnoredKeywords(self._build.getStr("text.ignoredKeywords"))
+        bldObj.setCommentType(nwComment.PLAIN, self._build.getBool("text.includeComments"))
+        bldObj.setCommentType(nwComment.SYNOPSIS, self._build.getBool("text.includeSynopsis"))
+        bldObj.setCommentType(nwComment.SHORT, self._build.getBool("text.includeSynopsis"))
+        bldObj.setCommentType(nwComment.STORY, self._build.getBool("text.includeStory"))
+        bldObj.setCommentType(nwComment.NOTE, self._build.getBool("text.includeNotes"))
 
         if isinstance(bldObj, ToHtml):
             bldObj.setStyles(self._build.getBool("html.addStyles"))
             bldObj.setReplaceUnicode(self._build.getBool("format.stripUnicode"))
 
-        if isinstance(bldObj, (ToOdt, ToDocX)):
+        if isinstance(bldObj, ToOdt | ToDocX):
             bldObj.setHeaderFormat(
                 self._build.getStr("doc.pageHeader"),
                 self._build.getInt("doc.pageCountOffset"),
             )
 
-        if isinstance(bldObj, (ToOdt, ToDocX, ToQTextDocument)):
+        if isinstance(bldObj, ToOdt | ToDocX | ToQTextDocument):
             scale = nwLabels.UNIT_SCALE.get(self._build.getStr("format.pageUnit"), 1.0)
             pW, pH = nwLabels.PAPER_SIZE.get(self._build.getStr("format.pageSize"), (-1.0, -1.0))
             bldObj.setPageLayout(

novelwriter/core/document.py

@@ -31,11 +31,11 @@ from time import time
 from typing import TYPE_CHECKING
 
 from novelwriter.common import formatTimeStamp, isHandle
-from novelwriter.core.item import NWItem
 from novelwriter.enum import nwItemClass, nwItemLayout
 from novelwriter.error import formatException, logException
 
-if TYPE_CHECKING:  # pragma: no cover
+if TYPE_CHECKING:
+    from novelwriter.core.item import NWItem
     from novelwriter.core.project import NWProject
 
 logger = logging.getLogger(__name__)