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

novelwriter/formats/toodt.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
@@ -40,7 +40,7 @@ from novelwriter import __version__
 from novelwriter.common import xmlElement, xmlIndent, xmlSubElem
 from novelwriter.constants import nwHeadFmt, nwStyles
 from novelwriter.formats.shared import BlockFmt, BlockTyp, TextFmt, stripEscape
-from novelwriter.formats.tokenizer import Tokenizer
+from novelwriter.formats.tokenizer import COMMENT_BLOCKS, Tokenizer
 from novelwriter.types import FONT_STYLE, QtHexRgb
 
 if TYPE_CHECKING:
@@ -128,7 +128,7 @@ FONT_WEIGHT_MAP = {"400": "normal", "700": "bold"}
 
 
 class ToOdt(Tokenizer):
-    """Core: Open Document Writer
+    """Core: Open Document Writer.
 
     Extend the Tokenizer class to writer Open Document files. The output
     should conform to the 1.3 Extended standard.
@@ -189,8 +189,6 @@ class ToOdt(Tokenizer):
         self._mDocLeft   = "2.000cm"
         self._mDocRight  = "2.000cm"
 
-        return
-
     ##
     #  Setters
     ##
@@ -205,20 +203,18 @@ class ToOdt(Tokenizer):
         self._mDocBtm    = f"{bottom/10.0:.3f}cm"
         self._mDocLeft   = f"{left/10.0:.3f}cm"
         self._mDocRight  = f"{right/10.0:.3f}cm"
-        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 a new open document XML tree."""
+        """Initialise a new open document XML tree."""
         super().initDocument()
 
         # Initialise Variables
@@ -325,8 +321,6 @@ class ToOdt(Tokenizer):
         self._useableStyles()
         self._writeHeader()
 
-        return
-
     def doConvert(self) -> None:
         """Convert the list of text tokens into XML elements."""
         xText = self._xText
@@ -389,14 +383,12 @@ class ToOdt(Tokenizer):
             elif tType == BlockTyp.SKIP:
                 self._addTextPar(xText, S_TEXT, oStyle, "")
 
-            elif tType == BlockTyp.COMMENT:
+            elif tType in COMMENT_BLOCKS:
                 self._addTextPar(xText, S_META, oStyle, tText, tFmt=tFormat)
 
             elif tType == BlockTyp.KEYWORD:
                 self._addTextPar(xText, S_META, oStyle, tText, tFmt=tFormat)
 
-        return
-
     def closeDocument(self) -> None:
         """Add additional collected information to the XML."""
         for style in self._autoPara.values():
@@ -412,7 +404,6 @@ class ToOdt(Tokenizer):
                     _mkTag("text", "name"): f"Manuscript{key[:1].upper()}{key[1:]}",
                 })
             self._xText.insert(0, xFields)
-        return
 
     def saveDocument(self, path: Path) -> None:
         """Save the data to an .fodt or .odt file."""
@@ -456,8 +447,6 @@ class ToOdt(Tokenizer):
 
         logger.info("Wrote file: %s", path)
 
-        return
-
     ##
     #  Internal Functions
     ##
@@ -670,7 +659,7 @@ class ToOdt(Tokenizer):
         return None
 
     def _emToCm(self, value: float) -> str:
-        """Converts an em value to centimetres."""
+        """Convert an em value to centimetres."""
         return f"{value*self._fontSize*2.54/72.0:.3f}cm"
 
     def _emToPt(self, scale: float) -> str:
@@ -705,8 +694,6 @@ class ToOdt(Tokenizer):
             _mkTag("fo", "margin-bottom"): self._emToCm(0.5),
         })
 
-        return
-
     def _defaultStyles(self) -> None:
         """Set the default styles."""
         hScale = self._scaleHeads
@@ -783,8 +770,6 @@ class ToOdt(Tokenizer):
             _mkTag("number", "min-integer-digits"): "1",
         })
 
-        return
-
     def _useableStyles(self) -> None:
         """Set the usable styles."""
         hScale = self._scaleHeads
@@ -954,8 +939,6 @@ class ToOdt(Tokenizer):
         style.packXML(self._xStyl)
         self._mainPara[style.name] = style
 
-        return
-
     def _writeHeader(self) -> None:
         """Write the header elements."""
         xPage = ET.SubElement(self._xMast, _mkTag("style", "master-page"), attrib={
@@ -993,8 +976,6 @@ class ToOdt(Tokenizer):
             _mkTag("text", "style-name"): "Header"
         })
 
-        return
-
 
 # Auto-Style Classes
 # ==================
@@ -1004,6 +985,7 @@ class ODTParagraphStyle:
     exporter. Only the used settings are exposed here to keep the class
     minimal and fast.
     """
+
     VALID_ALIGN: Final[list[str]]  = ["start", "center", "end", "justify", "left", "right"]
     VALID_BREAK: Final[list[str]]  = ["auto", "page", "even-page", "odd-page", "inherit"]
     VALID_LEVEL: Final[list[str]]  = ["1", "2", "3", "4"]
@@ -1046,8 +1028,6 @@ class ODTParagraphStyle:
             "opacity":     ["loext", None],
         }
 
-        return
-
     @property
     def name(self) -> str:
         return self._name
@@ -1059,7 +1039,6 @@ class ODTParagraphStyle:
     def setName(self, name: str) -> None:
         """Set the paragraph style name."""
         self._name = name
-        return
 
     ##
     #  Attribute Setters
@@ -1068,17 +1047,14 @@ class ODTParagraphStyle:
     def setDisplayName(self, value: str | None) -> None:
         """Set style display name."""
         self._mAttr["display-name"][1] = value
-        return
 
     def setParentStyleName(self, value: str | None) -> None:
         """Set parent style name."""
         self._mAttr["parent-style-name"][1] = value
-        return
 
     def setNextStyleName(self, value: str | None) -> None:
         """Set next style name."""
         self._mAttr["next-style-name"][1] = value
-        return
 
     def setOutlineLevel(self, value: str | None) -> None:
         """Set paragraph outline level."""
@@ -1086,7 +1062,6 @@ class ODTParagraphStyle:
             self._mAttr["default-outline-level"][1] = value
         else:
             self._mAttr["default-outline-level"][1] = None
-        return
 
     def setClass(self, value: str | None) -> None:
         """Set paragraph class."""
@@ -1094,7 +1069,6 @@ class ODTParagraphStyle:
             self._mAttr["class"][1] = value
         else:
             self._mAttr["class"][1] = None
-        return
 
     ##
     #  Paragraph Setters
@@ -1103,32 +1077,26 @@ class ODTParagraphStyle:
     def setMarginTop(self, value: str | None) -> None:
         """Set paragraph top margin."""
         self._pAttr["margin-top"][1] = value
-        return
 
     def setMarginBottom(self, value: str | None) -> None:
         """Set paragraph bottom margin."""
         self._pAttr["margin-bottom"][1] = value
-        return
 
     def setMarginLeft(self, value: str | None) -> None:
         """Set paragraph left margin."""
         self._pAttr["margin-left"][1] = value
-        return
 
     def setMarginRight(self, value: str | None) -> None:
         """Set paragraph right margin."""
         self._pAttr["margin-right"][1] = value
-        return
 
     def setTextIndent(self, value: str | None) -> None:
         """Set text indentation."""
         self._pAttr["text-indent"][1] = value
-        return
 
     def setLineHeight(self, value: str | None) -> None:
         """Set line height."""
         self._pAttr["line-height"][1] = value
-        return
 
     def setTextAlign(self, value: str | None) -> None:
         """Set paragraph text alignment."""
@@ -1136,7 +1104,6 @@ class ODTParagraphStyle:
             self._pAttr["text-align"][1] = value
         else:
             self._pAttr["text-align"][1] = None
-        return
 
     def setBreakBefore(self, value: str | None) -> None:
         """Set page break before policy."""
@@ -1144,7 +1111,6 @@ class ODTParagraphStyle:
             self._pAttr["break-before"][1] = value
         else:
             self._pAttr["break-before"][1] = None
-        return
 
     def setBreakAfter(self, value: str | None) -> None:
         """Set page break after policy."""
@@ -1152,7 +1118,6 @@ class ODTParagraphStyle:
             self._pAttr["break-after"][1] = value
         else:
             self._pAttr["break-after"][1] = None
-        return
 
     ##
     #  Text Setters
@@ -1161,17 +1126,14 @@ class ODTParagraphStyle:
     def setFontName(self, value: str | None) -> None:
         """Set font name."""
         self._tAttr["font-name"][1] = value
-        return
 
     def setFontFamily(self, value: str | None) -> None:
         """Set font family."""
         self._tAttr["font-family"][1] = value
-        return
 
     def setFontSize(self, value: str | None) -> None:
         """Set font size."""
         self._tAttr["font-size"][1] = value
-        return
 
     def setFontWeight(self, value: str | None) -> None:
         """Set font weight."""
@@ -1179,7 +1141,6 @@ class ODTParagraphStyle:
             self._tAttr["font-weight"][1] = value
         else:
             self._tAttr["font-weight"][1] = None
-        return
 
     def setColor(self, value: QColor | None) -> None:
         """Set text colour."""
@@ -1189,7 +1150,6 @@ class ODTParagraphStyle:
         else:
             self._tAttr["color"][1] = None
             self._tAttr["opacity"][1] = None
-        return
 
     ##
     #  Methods
@@ -1233,14 +1193,13 @@ class ODTParagraphStyle:
         if attr := {_mkTag(n, m): v for m, (n, v) in self._tAttr.items() if v}:
             ET.SubElement(xEntry, _mkTag("style", "text-properties"), attrib=attr)
 
-        return
-
 
 class ODTTextStyle:
     """Wrapper class for the text style setting used by the exporter.
     Only the used settings are exposed here to keep the class minimal
     and fast.
     """
+
     VALID_WEIGHT: Final[list[str]] = ["normal", "bold", *FONT_WEIGHT_NUM]
     VALID_STYLE: Final[list[str]]  = ["normal", "italic", "oblique"]
     VALID_POS: Final[list[str]]    = ["super", "sub"]
@@ -1263,7 +1222,6 @@ class ODTTextStyle:
             "text-underline-width":    ["style", None],
             "text-underline-color":    ["style", None],
         }
-        return
 
     @property
     def name(self) -> str:
@@ -1279,7 +1237,6 @@ class ODTTextStyle:
             self._tAttr["font-weight"][1] = value
         else:
             self._tAttr["font-weight"][1] = None
-        return
 
     def setFontStyle(self, value: str | None) -> None:
         """Set text font style."""
@@ -1287,7 +1244,6 @@ class ODTTextStyle:
             self._tAttr["font-style"][1] = value
         else:
             self._tAttr["font-style"][1] = None
-        return
 
     def setColor(self, value: QColor | None) -> None:
         """Set text colour."""
@@ -1295,7 +1251,6 @@ class ODTTextStyle:
             self._tAttr["color"][1] = value.name(QtHexRgb)
         else:
             self._tAttr["color"][1] = None
-        return
 
     def setBackgroundColor(self, value: QColor | None) -> None:
         """Set text background colour."""
@@ -1303,7 +1258,6 @@ class ODTTextStyle:
             self._tAttr["background-color"][1] = value.name(QtHexRgb)
         else:
             self._tAttr["background-color"][1] = None
-        return
 
     def setTextPosition(self, value: str | None) -> None:
         """Set text vertical position."""
@@ -1311,7 +1265,6 @@ class ODTTextStyle:
             self._tAttr["text-position"][1] = f"{value} 58%"
         else:
             self._tAttr["text-position"][1] = None
-        return
 
     def setStrikeStyle(self, value: str | None) -> None:
         """Set text line-trough style."""
@@ -1319,7 +1272,6 @@ class ODTTextStyle:
             self._tAttr["text-line-through-style"][1] = value
         else:
             self._tAttr["text-line-through-style"][1] = None
-        return
 
     def setStrikeType(self, value: str | None) -> None:
         """Set text line-through type."""
@@ -1327,7 +1279,6 @@ class ODTTextStyle:
             self._tAttr["text-line-through-type"][1] = value
         else:
             self._tAttr["text-line-through-type"][1] = None
-        return
 
     def setUnderlineStyle(self, value: str | None) -> None:
         """Set text underline style."""
@@ -1335,7 +1286,6 @@ class ODTTextStyle:
             self._tAttr["text-underline-style"][1] = value
         else:
             self._tAttr["text-underline-style"][1] = None
-        return
 
     def setUnderlineWidth(self, value: str | None) -> None:
         """Set text underline width."""
@@ -1343,7 +1293,6 @@ class ODTTextStyle:
             self._tAttr["text-underline-width"][1] = value
         else:
             self._tAttr["text-underline-width"][1] = None
-        return
 
     def setUnderlineColor(self, value: str | None) -> None:
         """Set text underline colour."""
@@ -1351,7 +1300,6 @@ class ODTTextStyle:
             self._tAttr["text-underline-color"][1] = value
         else:
             self._tAttr["text-underline-color"][1] = None
-        return
 
     ##
     #  Methods
@@ -1365,7 +1313,6 @@ class ODTTextStyle:
         })
         if attr := {_mkTag(n, m): v for m, (n, v) in self._tAttr.items() if v}:
             ET.SubElement(xEntry, _mkTag("style", "text-properties"), attrib=attr)
-        return
 
 
 # XML Complex Element Helper Class
@@ -1378,7 +1325,9 @@ X_SPAN_SING = 3
 
 
 class XMLParagraph:
-    """This is a helper class to manage the text content of a single
+    """ODT Text Paragraph.
+
+    This is a helper class to manage the text content of a single
     XML element using mixed content tags.
 
     Rules:
@@ -1408,8 +1357,6 @@ class XMLParagraph:
         self._rawTxt = ""
         self._xRoot.text = ""
 
-        return
-
     def appendText(self, text: str) -> None:
         """Append text to the XML element. We do this one character at
         the time in order to be able to process line breaks, tabs and
@@ -1424,7 +1371,7 @@ class XMLParagraph:
             if c == " ":
                 nSpaces += 1
                 continue
-            elif nSpaces > 0:
+            if nSpaces > 0:
                 self._processSpaces(nSpaces)
                 nSpaces = 0
 
@@ -1468,8 +1415,6 @@ class XMLParagraph:
             # Handle trailing spaces
             self._processSpaces(nSpaces)
 
-        return
-
     def appendSpan(self, text: str, style: str, link: str) -> None:
         """Append a text span to the XML element. The span is always
         closed since we do not produce nested spans (like Libre Office).
@@ -1491,7 +1436,6 @@ class XMLParagraph:
         self._nState = X_SPAN_TEXT
         self.appendText(text)
         self._nState = X_ROOT_TAIL
-        return
 
     def appendNode(self, xNode: ET.Element | None) -> None:
         """Append an XML node to the paragraph. We only check for the
@@ -1504,7 +1448,6 @@ class XMLParagraph:
             self._xTail = xNode
             self._xTail.tail = ""
             self._nState = X_ROOT_TAIL
-        return
 
     def checkError(self) -> tuple[int, str]:
         """Check that the number of characters written matches the
@@ -1575,5 +1518,3 @@ class XMLParagraph:
                 self._xSing.tail = ""
                 self._nState = X_SPAN_SING
                 self._chrPos += nSpaces - 1
-
-        return

novelwriter/formats/toqdoc.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
@@ -37,7 +37,7 @@ from PyQt6.QtPrintSupport import QPrinter
 from novelwriter import __version__
 from novelwriter.constants import nwStyles, nwUnicode
 from novelwriter.formats.shared import BlockFmt, BlockTyp, T_Formats, TextFmt, stripEscape
-from novelwriter.formats.tokenizer import HEADINGS, Tokenizer
+from novelwriter.formats.tokenizer import HEADING_BLOCKS, META_BLOCKS, Tokenizer
 from novelwriter.types import (
     QtAlignAbsolute, QtAlignCenter, QtAlignJustify, QtAlignLeft, QtAlignRight,
     QtKeepAnchor, QtMoveAnchor, QtPageBreakAfter, QtPageBreakAuto,
@@ -56,6 +56,7 @@ T_TextStyle = tuple[QTextBlockFormat, QTextCharFormat]
 
 
 def newBlock(cursor: QTextCursor, bFmt: QTextBlockFormat) -> None:
+    """Insert a new block if not at the beginning of the document."""
     if cursor.position() > 0:
         cursor.insertBlock(bFmt)
     else:
@@ -63,7 +64,7 @@ def newBlock(cursor: QTextCursor, bFmt: QTextBlockFormat) -> None:
 
 
 class ToQTextDocument(Tokenizer):
-    """Core: QTextDocument Writer
+    """Core: QTextDocument Writer.
 
     Extend the Tokenizer class to generate a QTextDocument output. This
     is intended for usage in the document viewer and build tool preview.
@@ -92,8 +93,6 @@ class ToQTextDocument(Tokenizer):
         self._pageSize = QPageSize(QPageSize.PageSizeId.A4)
         self._pageMargins = QMarginsF(20.0, 20.0, 20.0, 20.0)
 
-        return
-
     ##
     #  Properties
     ##
@@ -113,17 +112,14 @@ class ToQTextDocument(Tokenizer):
         """Set the document page size and margins in millimetres."""
         self._pageSize = QPageSize(QSizeF(width, height), QPageSize.Unit.Millimeter)
         self._pageMargins = QMarginsF(left, top, right, bottom)
-        return
 
     def setShowNewPage(self, state: bool) -> None:
         """Add markers for page breaks."""
         self._newPage = state
-        return
 
     def disableAnchors(self) -> None:
         """Disable anchors for when writing to file."""
         self._anchors = False
-        return
 
     ##
     #  Class Methods
@@ -200,8 +196,6 @@ class ToQTextDocument(Tokenizer):
 
         self._init = True
 
-        return
-
     def doConvert(self) -> None:
         """Write text tokens into the document."""
         if not self._init:
@@ -214,7 +208,7 @@ class ToQTextDocument(Tokenizer):
         for tType, tMeta, tText, tFormat, tStyle in self._blocks:
 
             bFmt = QTextBlockFormat(self._blockFmt)
-            if tType in (BlockTyp.COMMENT, BlockTyp.KEYWORD):
+            if tType in META_BLOCKS:
                 bFmt.setTopMargin(self._mMeta[0])
                 bFmt.setBottomMargin(self._mMeta[1])
             elif tType == BlockTyp.SEP:
@@ -248,17 +242,21 @@ class ToQTextDocument(Tokenizer):
             if tStyle & BlockFmt.IND_T:
                 bFmt.setTextIndent(self._tIndent)
 
-            if tType in (BlockTyp.TEXT, BlockTyp.COMMENT, BlockTyp.KEYWORD):
+            if tType == BlockTyp.TEXT:
                 newBlock(cursor, bFmt)
                 self._insertFragments(tText, tFormat, cursor, self._charFmt)
 
-            elif tType in HEADINGS:
+            elif tType in HEADING_BLOCKS:
                 bFmt, cFmt = self._genHeadStyle(tType, tMeta, bFmt)
                 for tPart in tText.split("\n"):
                     newBlock(cursor, bFmt)
                     cursor.insertText(tPart, cFmt)
                     bFmt.setPageBreakPolicy(QtPageBreakAuto)
 
+            elif tType in META_BLOCKS:
+                newBlock(cursor, bFmt)
+                self._insertFragments(tText, tFormat, cursor, self._charFmt)
+
             elif tType == BlockTyp.SEP:
                 newBlock(cursor, bFmt)
                 cursor.insertText(tText, self._charFmt)
@@ -293,8 +291,6 @@ class ToQTextDocument(Tokenizer):
         self._document.setPageSize(printer.pageRect(QPrinter.Unit.DevicePixel).size())
         self._document.print(printer)
 
-        return
-
     def closeDocument(self) -> None:
         """Run close document tasks."""
         self._document.blockSignals(True)
@@ -329,8 +325,6 @@ class ToQTextDocument(Tokenizer):
 
         self._document.blockSignals(False)
 
-        return
-
     ##
     #  Internal Functions
     ##
@@ -435,8 +429,6 @@ class ToQTextDocument(Tokenizer):
         # Insert whatever is left in the buffer
         cursor.insertText(stripEscape(temp[start:]), cFmt)
 
-        return
-
     def _insertNewPageMarker(self, cursor: QTextCursor) -> None:
         """Insert a new page marker."""
         if self._newPage:
@@ -471,8 +463,6 @@ class ToQTextDocument(Tokenizer):
             if root := self._document.rootFrame():
                 cursor.swap(root.lastCursorPosition())
 
-        return
-
     def _genHeadStyle(self, hType: BlockTyp, hKey: str, rFmt: QTextBlockFormat) -> T_TextStyle:
         """Generate a heading style set."""
         mTop, mBottom = self._mHead.get(hType, (0.0, 0.0))

novelwriter/formats/toraw.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
@@ -41,7 +41,7 @@ logger = logging.getLogger(__name__)
 
 
 class ToRaw(Tokenizer):
-    """Core: Raw novelWriter Text Writer
+    """Core: Raw novelWriter Text Writer.
 
     A class that will collect the minimally altered original source text
     and write it to either a text or JSON file.
@@ -51,7 +51,6 @@ class ToRaw(Tokenizer):
         super().__init__(project)
         self._keepRaw = True
         self._noTokens = True
-        return
 
     def doConvert(self) -> None:
         """No conversion to perform."""
@@ -86,10 +85,7 @@ class ToRaw(Tokenizer):
 
         logger.info("Wrote file: %s", path)
 
-        return
-
     def replaceTabs(self, nSpaces: int = 8, spaceChar: str = " ") -> None:
         """Replace tabs with spaces."""
         spaces = spaceChar*nSpaces
         self._raw = [p.replace("\t", spaces) for p in self._raw]
-        return