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

novelwriter/extensions/switchbox.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
 
 from typing import TYPE_CHECKING
@@ -39,7 +39,7 @@ if TYPE_CHECKING:
 
 
 class NSwitchBox(QScrollArea):
-    """Extension: Switch Box Widget
+    """Extension: Switch Box Widget.
 
     A widget that can hold a list of switches with labels and optional
     icons. The switch toggles emits a common signal with a switch key.
@@ -55,7 +55,6 @@ class NSwitchBox(QScrollArea):
         self._sIcon = baseSize
         self._widgets = []
         self.clear()
-        return
 
     def clear(self) -> None:
         """Rebuild the content of the core widget."""
@@ -72,8 +71,6 @@ class NSwitchBox(QScrollArea):
         self.setWidgetResizable(True)
         self.setWidget(self._widget)
 
-        return
-
     def addLabel(self, text: str) -> None:
         """Add a header label to the content box."""
         label = QLabel(text, self)
@@ -83,7 +80,6 @@ class NSwitchBox(QScrollArea):
         self._content.addWidget(label, self._index, 0, 1, 3, QtAlignLeft)
         self._widgets.append(label)
         self._bumpIndex()
-        return
 
     def addItem(self, qIcon: QIcon, text: str, identifier: str, default: bool = False) -> None:
         """Add an item to the content box."""
@@ -104,8 +100,6 @@ class NSwitchBox(QScrollArea):
         self._widgets.append(switch)
         self._bumpIndex()
 
-        return
-
     def addSeparator(self) -> None:
         """Add a blank entry in the content box."""
         spacer = QWidget(self)
@@ -113,7 +107,6 @@ class NSwitchBox(QScrollArea):
         self._content.addWidget(spacer, self._index, 0, 1, 3, QtAlignLeft)
         self._widgets.append(spacer)
         self._bumpIndex()
-        return
 
     ##
     #  Internal Functions
@@ -122,7 +115,6 @@ class NSwitchBox(QScrollArea):
     def _emitSwitchSignal(self, identifier: str, state: bool) -> None:
         """Emit a signal for a switch toggle."""
         self.switchToggled.emit(identifier, state)
-        return
 
     def _bumpIndex(self) -> None:
         """Increase the index counter and make sure only the last
@@ -131,4 +123,3 @@ class NSwitchBox(QScrollArea):
         self._content.setRowStretch(self._index, 0)
         self._content.setRowStretch(self._index + 1, 1)
         self._index += 1
-        return

novelwriter/extensions/versioninfo.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
@@ -45,6 +45,11 @@ API_URL = "https://api.github.com/repos/vkbo/novelwriter/releases/latest"
 
 
 class VersionInfoWidget(QWidget):
+    """Custom: version Info Label.
+
+    A custom widget that will show a clickable area for contacting
+    GitHub and pulling the latest release version info.
+    """
 
     def __init__(self, parent: QWidget) -> None:
         super().__init__(parent=parent)
@@ -75,8 +80,6 @@ class VersionInfoWidget(QWidget):
 
         self.setLayout(self._layout)
 
-        return
-
     ##
     #  Private Slots
     ##
@@ -93,7 +96,6 @@ class VersionInfoWidget(QWidget):
             lookup = _Retriever()
             lookup.signals.dataReady.connect(self._updateReleaseInfo)
             SHARED.runInThreadPool(lookup)
-        return
 
     ##
     #  Private Slots
@@ -109,7 +111,6 @@ class VersionInfoWidget(QWidget):
             ))
         else:
             self._lblRelease.setText(self._trLatest.format(reason or self.tr("Failed")))
-        return
 
 
 class _Retriever(QRunnable):
@@ -117,7 +118,6 @@ class _Retriever(QRunnable):
     def __init__(self) -> None:
         super().__init__()
         self.signals = _RetrieverSignal()
-        return
 
     @pyqtSlot()
     def run(self) -> None:
@@ -140,7 +140,6 @@ class _Retriever(QRunnable):
         except Exception as e:
             logger.error("Failed to retrieve release info")
             self.signals.dataReady.emit("", str(e))
-        return
 
 
 class _RetrieverSignal(QObject):

novelwriter/formats/shared.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 re
@@ -29,7 +29,15 @@ from enum import Flag, IntEnum
 
 from PyQt6.QtGui import QColor
 
-ESCAPES = {r"\*": "*", r"\~": "~", r"\_": "_", r"\[": "[", r"\]": "]", r"\ ": ""}
+ESCAPES = {
+    r"\*": "*",
+    r"\~": "~",
+    r"\=": "=",
+    r"\_": "_",
+    r"\[": "[",
+    r"\]": "]",
+    r"\ ": "",
+}
 RX_ESC = re.compile("|".join([re.escape(k) for k in ESCAPES.keys()]), flags=re.DOTALL)
 
 

novelwriter/formats/todocx.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 logging
@@ -38,7 +38,7 @@ from novelwriter import __version__
 from novelwriter.common import firstFloat, xmlElement, xmlSubElem
 from novelwriter.constants import nwHeadFmt, nwStyles
 from novelwriter.formats.shared import BlockFmt, BlockTyp, T_Formats, TextFmt, stripEscape
-from novelwriter.formats.tokenizer import Tokenizer
+from novelwriter.formats.tokenizer import COMMENT_BLOCKS, Tokenizer
 from novelwriter.types import QtHexRgb
 
 if TYPE_CHECKING:
@@ -51,7 +51,7 @@ if TYPE_CHECKING:
 logger = logging.getLogger(__name__)
 
 # RegEx
-RX_TEXT = re.compile(r"([\n\t])", re.UNICODE)
+RX_TEXT = re.compile(r"([\n\t])")
 
 # Types and Relationships
 OOXML_SCM = "http://schemas.openxmlformats.org"
@@ -100,7 +100,7 @@ def _wText(parent: ET.Element, text: str) -> ET.Element:
 
 
 def _mmToSz(value: float) -> int:
-    """Convert millimetres to internal margin size units"""
+    """Convert millimetres to internal margin size units."""
     return int(value*20.0*72.0/25.4)
 
 
@@ -143,6 +143,7 @@ S_FNOTE = "FootnoteText"
 
 
 class DocXXmlRel(NamedTuple):
+    """DocX XML Rel Data."""
 
     rId: str
     relType: str
@@ -150,6 +151,7 @@ class DocXXmlRel(NamedTuple):
 
 
 class DocXXmlFile(NamedTuple):
+    """DocX XML File Data."""
 
     xml: ET.Element
     path: str
@@ -157,6 +159,7 @@ class DocXXmlFile(NamedTuple):
 
 
 class DocXParStyle(NamedTuple):
+    """DocX XML Paragraph Style Data."""
 
     name: str
     styleId: str
@@ -176,7 +179,7 @@ class DocXParStyle(NamedTuple):
 
 
 class ToDocX(Tokenizer):
-    """Core: DocX Document Writer
+    """Core: DocX Document Writer.
 
     Extend the Tokenizer class to writer DocX Document files.
     """
@@ -202,8 +205,6 @@ class ToDocX(Tokenizer):
         self._usedNotes: dict[str, int] = {}
         self._usedFields: list[tuple[ET.Element, str]] = []
 
-        return
-
     ##
     #  Setters
     ##
@@ -214,25 +215,22 @@ class ToDocX(Tokenizer):
         """Set the document page size and margins in millimetres."""
         self._pageSize = QSize(_mmToSz(width), _mmToSz(height))
         self._pageMargins = QMargins(_mmToSz(left), _mmToSz(top), _mmToSz(right), _mmToSz(bottom))
-        return
 
     def setHeaderFormat(self, value: str, offset: int) -> None:
         """Set the document header format."""
         self._headerFormat = value.strip()
         self._pageOffset = offset
-        return
 
     ##
     #  Class Methods
     ##
 
     def initDocument(self) -> None:
-        """Initialises the DocX document structure."""
+        """Initialise the DocX document structure."""
         super().initDocument()
         self._fontFamily = self._textFont.family()
         self._fontSize = self._textFont.pointSizeF()
         self._generateStyles()
-        return
 
     def doConvert(self) -> None:
         """Convert the list of text tokens into XML elements."""
@@ -296,14 +294,12 @@ class ToDocX(Tokenizer):
             elif tType == BlockTyp.SKIP:
                 self._processFragments(par, S_NORM, "")
 
-            elif tType == BlockTyp.COMMENT:
+            elif tType in COMMENT_BLOCKS:
                 self._processFragments(par, S_META, tText, tFormat)
 
             elif tType == BlockTyp.KEYWORD:
                 self._processFragments(par, S_META, tText, tFormat)
 
-        return
-
     def closeDocument(self) -> None:
         """Generate all the XML."""
         self._coreXml()
@@ -322,8 +318,6 @@ class ToDocX(Tokenizer):
         if self._usedNotes:
             self._footnotesXml()
 
-        return
-
     def saveDocument(self, path: Path) -> None:
         """Save the data to a .docx file."""
         # Content Lists
@@ -373,8 +367,6 @@ class ToDocX(Tokenizer):
                 xmlToZip(f"{rel.path}/{name}", rel.xml, outZip)
             xmlToZip("[Content_Types].xml", dTypes, outZip)
 
-        return
-
     ##
     #  Internal Functions
     ##
@@ -454,8 +446,6 @@ class ToDocX(Tokenizer):
         if temp := text[fStart:]:
             par.addContent(self._textRunToXml(temp, xFmt, fClass, fLink))
 
-        return
-
     def _textRunToXml(self, text: str | None, fmt: int, fClass: str, fLink: str) -> ET.Element:
         """Encode the text run into XML."""
         xR = xmlElement(_wTag("r"))
@@ -668,8 +658,6 @@ class ToDocX(Tokenizer):
         for style in styles:
             self._styles[style.styleId] = style
 
-        return
-
     def _nextRelId(self) -> str:
         """Generate the next unique rId."""
         return f"rId{len(self._rels) + 1}"
@@ -1054,6 +1042,10 @@ class ToDocX(Tokenizer):
 
 
 class DocXParagraph:
+    """DocX Text Paragraph.
+
+    This class holds a single paragraph of a DocX document.
+    """
 
     __slots__ = (
         "_bottomMargin", "_breakAfter", "_breakBefore", "_content",
@@ -1073,7 +1065,6 @@ class DocXParagraph:
         self._breakBefore = False
         self._breakAfter = False
         self._footnoteRef = False
-        return
 
     ##
     #  Properties
@@ -1091,53 +1082,43 @@ class DocXParagraph:
     def setStyle(self, style: DocXParStyle | None) -> None:
         """Set the paragraph style."""
         self._style = style
-        return
 
     def setAlignment(self, value: str) -> None:
         """Set paragraph alignment."""
         if value in ("left", "center", "right", "both"):
             self._textAlign = value
-        return
 
     def setMarginTop(self, value: float) -> None:
         """Set margin above in pt."""
         self._topMargin = value
-        return
 
     def setMarginBottom(self, value: float) -> None:
         """Set margin below in pt."""
         self._bottomMargin = value
-        return
 
     def setMarginLeft(self, value: float) -> None:
         """Set margin left in pt."""
         self._leftMargin = value
-        return
 
     def setMarginRight(self, value: float) -> None:
         """Set margin right in pt."""
         self._rightMargin = value
-        return
 
     def setIndentFirst(self, state: bool) -> None:
         """Set first line indent."""
         self._indentFirst = state
-        return
 
     def setPageBreakBefore(self, state: bool) -> None:
         """Set page break before flag."""
         self._breakBefore = state
-        return
 
     def setPageBreakAfter(self, state: bool) -> None:
         """Set page break after flag."""
         self._breakAfter = state
-        return
 
     def setIsFootnote(self, state: bool) -> None:
         """Set is footnote flag."""
         self._footnoteRef = state
-        return
 
     ##
     #  Methods
@@ -1146,10 +1127,9 @@ class DocXParagraph:
     def addContent(self, run: ET.Element) -> None:
         """Add a run segment to the paragraph."""
         self._content.append(run)
-        return
 
     def toXml(self, body: ET.Element) -> None:
-        """Called after all content is set."""
+        """Generate the XML. Call after all content is set."""
         if style := self._style:
             xP = xmlSubElem(body, _wTag("p"))
 
@@ -1191,5 +1171,3 @@ class DocXParagraph:
             if self._breakAfter:
                 xR = xmlSubElem(xP, _wTag("r"))
                 xmlSubElem(xR, _wTag("br"), attrib={_wTag("type"): "page"})
-
-        return

novelwriter/formats/tohtml.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
@@ -32,7 +32,7 @@ from typing import TYPE_CHECKING
 from novelwriter.common import formatTimeStamp
 from novelwriter.constants import nwHtmlUnicode, nwStyles
 from novelwriter.formats.shared import BlockFmt, BlockTyp, T_Formats, TextFmt, stripEscape
-from novelwriter.formats.tokenizer import Tokenizer
+from novelwriter.formats.tokenizer import COMMENT_BLOCKS, Tokenizer
 from novelwriter.types import FONT_STYLE, FONT_WEIGHTS, QtHexRgb
 
 if TYPE_CHECKING:
@@ -77,7 +77,7 @@ HTML_NONE = (0, "")
 
 
 class ToHtml(Tokenizer):
-    """Core: HTML Document Writer
+    """Core: HTML Document Writer.
 
     Extend the Tokenizer class to writer HTML output. This class is
     also used by the Document Viewer, and Manuscript Build Preview.
@@ -90,7 +90,6 @@ class ToHtml(Tokenizer):
         self._usedNotes: dict[str, int] = {}
         self._usedFields: list[tuple[int, str]] = []
         self.setReplaceUnicode(False)
-        return
 
     ##
     #  Setters
@@ -101,7 +100,6 @@ class ToHtml(Tokenizer):
         class tags.
         """
         self._cssStyles = cssStyles
-        return
 
     def setReplaceUnicode(self, doReplace: bool) -> None:
         """Set the translation map to either minimal or full unicode for
@@ -114,7 +112,6 @@ class ToHtml(Tokenizer):
         if doReplace:
             # Extend to all relevant Unicode characters
             self._trMap.update(str.maketrans(nwHtmlUnicode.U_TO_H))
-        return
 
     ##
     #  Class Methods
@@ -130,7 +127,6 @@ class ToHtml(Tokenizer):
         """
         super().doPreProcessing()
         self._text = self._text.translate(self._trMap)
-        return
 
     def doConvert(self) -> None:
         """Convert the list of text tokens into an HTML document."""
@@ -159,34 +155,33 @@ class ToHtml(Tokenizer):
                 # If we don't have formatting, we can do a plain replace
                 tText = tText.replace("<", "&lt;").replace(">", "&gt;")
 
-            # Styles
+            # Inline Styles
             aStyle = []
-            if self._cssStyles:
-                if tStyle & BlockFmt.LEFT:
-                    aStyle.append("text-align: left;")
-                elif tStyle & BlockFmt.RIGHT:
-                    aStyle.append("text-align: right;")
-                elif tStyle & BlockFmt.CENTRE:
-                    aStyle.append("text-align: center;")
-                elif tStyle & BlockFmt.JUSTIFY:
-                    aStyle.append("text-align: justify;")
-
-                if tStyle & BlockFmt.PBB:
-                    aStyle.append("page-break-before: always;")
-                if tStyle & BlockFmt.PBA:
-                    aStyle.append("page-break-after: always;")
-
-                if tStyle & BlockFmt.Z_BTM:
-                    aStyle.append("margin-bottom: 0;")
-                if tStyle & BlockFmt.Z_TOP:
-                    aStyle.append("margin-top: 0;")
-
-                if tStyle & BlockFmt.IND_L:
-                    aStyle.append(f"margin-left: {self._blockIndent:.2f}em;")
-                if tStyle & BlockFmt.IND_R:
-                    aStyle.append(f"margin-right: {self._blockIndent:.2f}em;")
-                if tStyle & BlockFmt.IND_T:
-                    aStyle.append(f"text-indent: {self._firstWidth:.2f}em;")
+            if tStyle & BlockFmt.LEFT:
+                aStyle.append("text-align: left;")
+            elif tStyle & BlockFmt.RIGHT:
+                aStyle.append("text-align: right;")
+            elif tStyle & BlockFmt.CENTRE:
+                aStyle.append("text-align: center;")
+            elif tStyle & BlockFmt.JUSTIFY:
+                aStyle.append("text-align: justify;")
+
+            if tStyle & BlockFmt.PBB:
+                aStyle.append("page-break-before: always;")
+            if tStyle & BlockFmt.PBA:
+                aStyle.append("page-break-after: always;")
+
+            if tStyle & BlockFmt.Z_BTM:
+                aStyle.append("margin-bottom: 0;")
+            if tStyle & BlockFmt.Z_TOP:
+                aStyle.append("margin-top: 0;")
+
+            if tStyle & BlockFmt.IND_L:
+                aStyle.append(f"margin-left: {self._blockIndent:.2f}em;")
+            if tStyle & BlockFmt.IND_R:
+                aStyle.append(f"margin-right: {self._blockIndent:.2f}em;")
+            if tStyle & BlockFmt.IND_T:
+                aStyle.append(f"text-indent: {self._firstWidth:.2f}em;")
 
             if aStyle:
                 stVals = " ".join(aStyle)
@@ -229,7 +224,7 @@ class ToHtml(Tokenizer):
             elif tType == BlockTyp.SKIP:
                 lines.append(f"<p{hStyle}>&nbsp;</p>\n")
 
-            elif tType == BlockTyp.COMMENT:
+            elif tType in COMMENT_BLOCKS:
                 lines.append(f"<p class='comment'{hStyle}>{self._formatText(tText, tFmt)}</p>\n")
 
             elif tType == BlockTyp.KEYWORD:
@@ -238,8 +233,6 @@ class ToHtml(Tokenizer):
 
         self._pages.append("".join(lines))
 
-        return
-
     def closeDocument(self) -> None:
         """Run close document tasks."""
         # Replace fields if there are stats available
@@ -266,8 +259,6 @@ class ToHtml(Tokenizer):
 
             self._pages.append("".join(lines))
 
-        return
-
     def saveDocument(self, path: Path) -> None:
         """Save the data to an HTML file."""
         if path.suffix.lower() == ".json":
@@ -288,37 +279,33 @@ class ToHtml(Tokenizer):
                 json.dump(data, fObj, indent=2)
 
         else:
+            html = []
+            html.append("<!DOCTYPE html>")
+            html.append("<html>")
+            html.append("<head>")
+            html.append(f"<title>{self._project.data.name:s}</title>")
+            html.append("<meta charset='utf-8'>")
+            if self._cssStyles:
+                html.append("<meta name='viewport' content='width=device-width, initial-scale=1'>")
+                html.append("<style>")
+                html.extend(self.getStyleSheet())
+                html.append("</style>")
+            html.append("</head>")
+            html.append("<body>")
+            html.append(("".join(self._pages)).replace("\t", "&#09;").rstrip())
+            html.append("</body>")
+            html.append("</html>\n")
+
             with open(path, mode="w", encoding="utf-8") as fObj:
-                fObj.write((
-                    "<!DOCTYPE html>\n"
-                    "<html>\n"
-                    "<head>\n"
-                    "<meta charset='utf-8'>\n"
-                    "<title>{title:s}</title>\n"
-                    "<style>\n"
-                    "{style:s}\n"
-                    "</style>\n"
-                    "</head>\n"
-                    "<body>\n"
-                    "{body:s}\n"
-                    "</body>\n"
-                    "</html>\n"
-                ).format(
-                    title=self._project.data.name,
-                    style="\n".join(self.getStyleSheet()),
-                    body=("".join(self._pages)).replace("\t", "&#09;").rstrip(),
-                ))
+                fObj.write("\n".join(html))
 
         logger.info("Wrote file: %s", path)
 
-        return
-
     def replaceTabs(self, nSpaces: int = 8, spaceChar: str = "&nbsp;") -> None:
         """Replace tabs with spaces in the html."""
         tabSpace = spaceChar*nSpaces
         pages = [aLine.replace("\t", tabSpace) for aLine in self._pages]
         self._pages = pages
-        return
 
     def getStyleSheet(self) -> list[str]:
         """Generate a stylesheet for the current settings."""
@@ -410,7 +397,11 @@ class ToHtml(Tokenizer):
         # isn't already open, and only closed if it has previously been opened.
         tags: list[tuple[int, str]] = []
         state = dict.fromkeys(HTML_OPENER, False)
+        plain = not self._cssStyles
         for pos, fmt, data in tFmt:
+            if plain and fmt in (TextFmt.COL_B, TextFmt.COL_E):
+                # We ignore colour tags if CSS is off
+                continue
             if m := HTML_OPENER.get(fmt):
                 if not state.get(fmt, True):
                     if fmt == TextFmt.COL_B and (color := self._classes.get(data)):