Further PEP8 compliance changes

nw/common.py

@@ -17,16 +17,20 @@ logger = logging.getLogger(__name__)
 
 def checkString(checkValue, defaultValue, allowNone=False):
     if allowNone:
-        if checkValue == None:   return None
+        if checkValue == None:
-        if checkValue == "None": return None
+            return None
+        if checkValue == "None":
+            return None
     if isinstance(checkValue,str):
         return str(checkValue)
     return defaultValue
 
 def checkInt(checkValue, defaultValue, allowNone=False):
     if allowNone:
-        if checkValue == None:   return None
+        if checkValue == None:
-        if checkValue == "None": return None
+            return None
+        if checkValue == "None":
+            return None
     try:
         return int(checkValue)
     except:
@@ -34,8 +38,10 @@ def checkInt(checkValue, defaultValue, allowNone=False):
 
 def checkBool(checkValue, defaultValue, allowNone=False):
     if allowNone:
-        if checkValue == None:   return None
+        if checkValue == None:
-        if checkValue == "None": return None
+            return None
+        if checkValue == "None":
+            return None
     if isinstance(checkValue, str):
         if checkValue == "True":
             return True

nw/config.py

@@ -19,12 +19,12 @@ from os           import path, mkdir, makedirs, getcwd
 from appdirs import user_config_dir
 from datetime import datetime
 
-from nw.constants import nwFiles, nwUnicode
-from nw.common    import splitVersionNumber
-
 from PyQt5.Qt import PYQT_VERSION_STR
 from PyQt5.QtCore import QT_VERSION_STR
 
+from nw.constants import nwFiles, nwUnicode
+from nw.common import splitVersionNumber
+
 logger = logging.getLogger(__name__)
 
 class Config:

nw/convert/file/concat.py

@@ -14,6 +14,7 @@ import logging
 import nw
 
 from os import path
+
 from PyQt5.QtWidgets import QMessageBox
 
 from nw.convert.file.text import TextFile
@@ -26,9 +27,7 @@ class ConcatFile(TextFile):
 
     def __init__(self, theProject, theParent):
         TextFile.__init__(self, theProject, theParent)
-
         self.theConv = Tokenizer(self.theProject, self.theParent)
-
         return
 
     def addText(self, tHandle):

nw/convert/file/html.py

@@ -23,9 +23,7 @@ class HtmlFile(TextFile):
 
     def __init__(self, theProject, theParent):
         TextFile.__init__(self, theProject, theParent)
-
         self.theConv = ToHtml(self.theProject, self.theParent)
-
         return
 
     ##

nw/convert/file/latex.py

@@ -32,7 +32,6 @@ class LaTeXFile(TextFile):
     ##
 
     def _doOpenFile(self, filePath):
-
         try:
             self.outFile = open(filePath,mode="wt+",encoding="utf8")
             self.outFile.write("\\documentclass[12pt]{report}\n")
@@ -43,17 +42,13 @@ class LaTeXFile(TextFile):
         except Exception as e:
             self.makeAlert(["Failed to open file.",str(e)], nwAlert.ERROR)
             return False
-
         return True
 
     def _doCloseFile(self):
-
         if self.outFile is not None:
             self.outFile.write("\\end{document}\n")
             self.outFile.close()
-
         self.texCodecFail = self.theConv.texCodecFail
-
         return True
 
 # END Class LaTeXFile

nw/convert/file/markdown.py

@@ -23,9 +23,7 @@ class MarkdownFile(TextFile):
 
     def __init__(self, theProject, theParent):
         TextFile.__init__(self, theProject, theParent)
-
         self.theConv = ToMarkdown(self.theProject, self.theParent)
-
         return
 
     ##

nw/convert/file/text.py

@@ -14,6 +14,7 @@ import logging
 import nw
 
 from os import path
+
 from PyQt5.QtWidgets import QMessageBox
 
 from nw.convert.text.totext import ToText

nw/convert/text/tohtml.py

@@ -31,12 +31,10 @@ class ToHtml(Tokenizer):
         need to make a few changes to formatting, which is selected by
         this flag.
         """
-
         self.forPreview = forPreview
         if forPreview:
             self.doKeywords = True
             self.doComments = doComments
-
         return
 
     def doAutoReplace(self):

nw/convert/tokenizer.py

@@ -230,7 +230,8 @@ class Tokenizer():
         if isNone: return
         if isNote: return
 
-        # For novel files, we need to handle chapter numbering and scene breaks
+        # For novel files, we need to handle chapter numbering and scene
+        # breaks
         if isBook or isUnNum or isChap or isScene:
             for n in range(len(self.theTokens)):
 

nw/gui/dialogs/configeditor.py

@@ -557,25 +557,33 @@ class GuiConfigEditEditor(QWidget):
         if self._checkQuoteSymbol(fmtSingleQuotesO):
             self.mainConf.fmtSingleQuotes[0] = fmtSingleQuotesO
         else:
-            self.theParent.makeAlert("Invalid quote symbol: %s" % fmtSingleQuotesO, nwAlert.ERROR)
+            self.theParent.makeAlert(
+                "Invalid quote symbol: %s" % fmtSingleQuotesO, nwAlert.ERROR
+            )
             validEntries = False
 
         if self._checkQuoteSymbol(fmtSingleQuotesC):
             self.mainConf.fmtSingleQuotes[1] = fmtSingleQuotesC
         else:
-            self.theParent.makeAlert("Invalid quote symbol: %s" % fmtSingleQuotesC, nwAlert.ERROR)
+            self.theParent.makeAlert(
+                "Invalid quote symbol: %s" % fmtSingleQuotesC, nwAlert.ERROR
+            )
             validEntries = False
 
         if self._checkQuoteSymbol(fmtDoubleQuotesO):
             self.mainConf.fmtDoubleQuotes[0] = fmtDoubleQuotesO
         else:
-            self.theParent.makeAlert("Invalid quote symbol: %s" % fmtDoubleQuotesO, nwAlert.ERROR)
+            self.theParent.makeAlert(
+                "Invalid quote symbol: %s" % fmtDoubleQuotesO, nwAlert.ERROR
+            )
             validEntries = False
 
         if self._checkQuoteSymbol(fmtDoubleQuotesC):
             self.mainConf.fmtDoubleQuotes[1] = fmtDoubleQuotesC
         else:
-            self.theParent.makeAlert("Invalid quote symbol: %s" % fmtDoubleQuotesC, nwAlert.ERROR)
+            self.theParent.makeAlert(
+                "Invalid quote symbol: %s" % fmtDoubleQuotesC, nwAlert.ERROR
+            )
             validEntries = False
 
         showTabsNSpaces = self.showTabsNSpaces.isChecked()

nw/gui/dialogs/export.py

@@ -19,8 +19,9 @@ from os import path
 from PyQt5.QtCore import Qt, QSize
 from PyQt5.QtSvg import QSvgWidget
 from PyQt5.QtWidgets import (
-    QDialog, QHBoxLayout, QVBoxLayout, QWidget, QTabWidget, QGridLayout, QGroupBox, QCheckBox,
+    QDialog, QHBoxLayout, QVBoxLayout, QWidget, QTabWidget, QGridLayout,
-    QLabel, QComboBox, QLineEdit, QPushButton, QFileDialog, QProgressBar, QSpinBox, QMessageBox
+    QGroupBox, QCheckBox, QLabel, QComboBox, QLineEdit, QPushButton,
+    QFileDialog, QProgressBar, QSpinBox, QMessageBox
 )
 
 from nw.project.document import NWDoc
@@ -201,9 +202,10 @@ class GuiExport(QDialog):
             # Check that encoding was successful
             if outFile.texCodecFail:
                 self.theParent.makeAlert((
-                    "Failed to escape unicode characters while writing LaTeX file. The generated "
+                    "Failed to escape unicode characters while writing LaTeX "
-                    ".tex file may not build properly. Make sure the python package '{package:s}' "
+                    "file. The generated .tex file may not build properly. "
-                    "is installed and working."
+                    "Make sure the python package '{package:s}' is installed "
+                    "and working."
                 ).format(
                     package = packageRefURL("latexcodec")
                 ), nwAlert.WARN)
@@ -343,27 +345,31 @@ class GuiExportMain(QWidget):
     }
     FMT_HELP  = {
         FMT_NWD : (
-            "Exports a document using the novelWriter markdown format. The files selected by the "
+            "Exports a document using the novelWriter markdown format. "
-            "filters are appended as-is, including comments and other settings."
+            "The files selected by the filters are appended as-is, "
+            "including comments and other settings."
         ),
         FMT_TXT : (
-            "Exports a plain text file. All formatting is stripped and comments are in square "
+            "Exports a plain text file. All formatting is stripped and "
-            "brackets."
+            "comments are in square brackets."
         ),
         FMT_MD : (
-            "Exports a standard markdown file. Comments are converted to preformatted text blocks."
+            "Exports a standard markdown file. Comments are converted "
+            "to preformatted text blocks."
         ),
         FMT_HTML : (
-            "Exports a plain html5 file. Comments are wrapped in blocks with a yellow background "
+            "Exports a plain html5 file. Comments are wrapped in "
-            "colour."
+            "blocks with a yellow background colour."
         ),
         FMT_TEX : (
-            "Exports a LaTeX file that can be compiled to PDF using for instance PDFLaTeX. "
+            "Exports a LaTeX file that can be compiled to PDF using "
-            "Comments are exported as LaTeX comments."
+            "for instance PDFLaTeX. Comments are exported as LaTeX "
+            "comments."
         ),
         FMT_PDOC : (
-            "Exports first to markdown or html5. The file is then passed on to Pandoc for a "
+            "Exports first to markdown or html5. The file is then "
-            "second stage. Use the Pandoc tab for settings up the conversion."
+            "passed on to Pandoc for a second stage. Use the Pandoc "
+            "tab for settings up the conversion."
         ),
     }
 
@@ -566,7 +572,8 @@ class GuiExportMain(QWidget):
         dlgOpt  = QFileDialog.Options()
         dlgOpt |= QFileDialog.DontUseNativeDialog
         saveTo  = QFileDialog.getSaveFileName(
-            self,"Export File",self.exportPath.text(),options=dlgOpt,filter=";;".join(extFilter)
+            self, "Export File", self.exportPath.text(),
+            options=dlgOpt, filter=";;".join(extFilter)
         )
         if saveTo:
             self.exportPath.setText(saveTo[0])
@@ -658,7 +665,6 @@ class GuiExportPandoc(QWidget):
         self.outputFormat.addItem("ePUB eBook v2 (.epub2)",      self.FMT_EPUB2)
         self.outputFormat.addItem("ePUB eBook v3 (.epub3)",      self.FMT_EPUB3)
         self.outputFormat.addItem("Zim Wiki (.txt)",             self.FMT_ZIM)
-        # self.outputFormat.currentIndexChanged.connect(self._updateFormat)
 
         optIdx = self.outputFormat.findData(self.optState.getSetting("pFormat"))
         if optIdx == -1:
@@ -674,9 +680,6 @@ class GuiExportPandoc(QWidget):
         self.outerBox.addWidget(self.guiInfo,   0, 0)
         self.outerBox.addWidget(self.guiOutput, 1, 0)
         self.outerBox.setRowStretch(2, 1)
-        # self.outerBox.setColumnStretch(0, 1)
-        # self.outerBox.setColumnStretch(1, 1)
-        # self.outerBox.setColumnStretch(2, 1)
         self.setLayout(self.outerBox)
 
         return

nw/gui/dialogs/itemeditor.py

@@ -18,7 +18,8 @@ from os import path
 from PyQt5.QtCore import Qt, QSize
 from PyQt5.QtSvg import QSvgWidget
 from PyQt5.QtWidgets import (
-    QDialog, QHBoxLayout, QVBoxLayout, QGroupBox, QFormLayout, QLineEdit, QPushButton, QComboBox
+    QDialog, QHBoxLayout, QVBoxLayout, QGroupBox, QFormLayout,
+    QLineEdit, QPushButton, QComboBox
 )
 
 from nw.enum import nwItemLayout, nwItemClass, nwItemType

nw/gui/dialogs/projecteditor.py

@@ -19,9 +19,10 @@ from PyQt5.QtCore    import Qt, QSize
 from PyQt5.QtGui import QIcon, QPixmap, QColor, QBrush, QStandardItemModel
 from PyQt5.QtSvg import QSvgWidget
 from PyQt5.QtWidgets import (
-    QDialog, QHBoxLayout, QVBoxLayout, QFormLayout, QLineEdit, QPlainTextEdit, QLabel,
+    QDialog, QHBoxLayout, QVBoxLayout, QFormLayout, QLineEdit, QPlainTextEdit,
-    QWidget, QTabWidget, QDialogButtonBox, QListWidget, QListWidgetItem, QPushButton,
+    QLabel, QWidget, QTabWidget, QDialogButtonBox, QListWidget,
-    QColorDialog, QAbstractItemView, QTreeWidget, QTreeWidgetItem, QCheckBox
+    QListWidgetItem, QPushButton, QColorDialog, QAbstractItemView, QTreeWidget,
+    QTreeWidgetItem, QCheckBox
 )
 from nw.enum import nwAlert
 

nw/gui/dialogs/sessionlog.py

@@ -15,11 +15,13 @@ import nw
 
 from os import path
 from datetime import datetime
+
 from PyQt5.QtCore import Qt
 from PyQt5.QtGui import QIcon, QColor, QPixmap, QFont
 from PyQt5.QtWidgets import (
-    QDialog, QVBoxLayout, QHBoxLayout, QTreeWidget, QTreeWidgetItem, QDialogButtonBox, QHeaderView,
+    QDialog, QVBoxLayout, QHBoxLayout, QTreeWidget, QTreeWidgetItem,
-    QGridLayout, QLabel, QGroupBox, QCheckBox
+    QDialogButtonBox, QHeaderView, QGridLayout, QLabel, QGroupBox,
+    QCheckBox
 )
 
 from nw.tools.optlaststate import OptLastState

nw/gui/dialogs/timelineview.py

@@ -18,8 +18,9 @@ from os import path
 from PyQt5.QtCore import Qt
 from PyQt5.QtGui import QIcon, QColor, QPixmap
 from PyQt5.QtWidgets import (
-    QDialog, QVBoxLayout, QHBoxLayout, QTableWidget, QTableWidgetItem, QDialogButtonBox, QLabel,
+    QDialog, QVBoxLayout, QHBoxLayout, QTableWidget, QTableWidgetItem,
-    QPushButton, QHeaderView, QGridLayout, QGroupBox, QCheckBox
+    QDialogButtonBox, QLabel, QPushButton, QHeaderView, QGridLayout,
+    QGroupBox, QCheckBox
 )
 
 from nw.tools.optlaststate import OptLastState

nw/gui/elements/doceditor.py

@@ -16,9 +16,12 @@ import nw
 from time import time
 
 from PyQt5.QtCore import Qt, QTimer, QSizeF
-from PyQt5.QtWidgets import qApp, QTextEdit, QAction, QMenu, QShortcut, QMessageBox
+from PyQt5.QtWidgets import (
+    qApp, QTextEdit, QAction, QMenu, QShortcut, QMessageBox
+)
 from PyQt5.QtGui import (
-    QTextCursor, QTextOption, QIcon, QKeySequence, QFont, QColor, QPalette, QTextDocument,
+    QTextCursor, QTextOption, QIcon, QKeySequence, QFont, QColor,
+    QPalette, QTextDocument,
 )
 
 from nw.project.document import NWDoc

nw/gui/elements/doctree.py

@@ -15,7 +15,9 @@ import nw
 
 from PyQt5.QtCore import Qt, QSize
 from PyQt5.QtGui import QIcon, QFont, QColor
-from PyQt5.QtWidgets import QTreeWidget, QTreeWidgetItem, QAbstractItemView, QApplication
+from PyQt5.QtWidgets import (
+    QTreeWidget, QTreeWidgetItem, QAbstractItemView, QApplication
+)
 
 from nw.project.item import NWItem
 from nw.constants import nwLabels

nw/gui/elements/noticebar.py

@@ -37,6 +37,7 @@ class GuiNoticeBar(QFrame):
         self.mainBox.setContentsMargins(8,2,2,2)
 
         self.noteLabel = QLabel("Hi there!")
+
         self.closeButton = QPushButton(self.theTheme.getIcon("close"),"")
         self.closeButton.clicked.connect(self.hideNote)
 

nw/gui/elements/searchbar.py

@@ -15,7 +15,9 @@ import nw
 
 from PyQt5.QtCore import Qt
 from PyQt5.QtGui import QIcon
-from PyQt5.QtWidgets import QFrame, QGridLayout, QLabel, QLineEdit, QPushButton, QApplication
+from PyQt5.QtWidgets import (
+    QFrame, QGridLayout, QLabel, QLineEdit, QPushButton, QApplication
+)
 
 from nw.enum import nwDocAction
 

nw/gui/elements/viewdetails.py

@@ -16,8 +16,8 @@ import nw
 from PyQt5.QtCore import Qt, QSize
 from PyQt5.QtGui import QFont
 from PyQt5.QtWidgets import (
-    QWidget, QHBoxLayout, QVBoxLayout, QLabel, QGroupBox, QScrollArea, QFrame, QToolButton,
+    QWidget, QHBoxLayout, QVBoxLayout, QLabel, QGroupBox, QScrollArea, QFrame,
-    QSizePolicy, QCheckBox, QGridLayout
+    QToolButton, QSizePolicy, QCheckBox, QGridLayout
 )
 
 from nw.constants import nwLabels

nw/gui/mainmenu.py

@@ -78,7 +78,9 @@ class GuiMainMenu(QMenuBar):
             recentProject = self.mainConf.recentList[n]
             if recentProject == "": continue
             menuItem = QAction("%s" % recentProject, self.projMenu)
-            menuItem.triggered.connect(lambda menuItem, n=n : self.openRecentProject(menuItem, n))
+            menuItem.triggered.connect(
+                lambda menuItem, n=n : self.openRecentProject(menuItem, n)
+            )
             self.recentMenu.addAction(menuItem)
 
         self.recentMenu.addSeparator()

nw/gui/statusbar.py

@@ -14,6 +14,7 @@ import logging
 import nw
 
 from time import time
+
 from PyQt5.QtCore import Qt, QTimer
 from PyQt5.QtGui import QIcon, QColor, QPixmap
 from PyQt5.QtWidgets import QStatusBar, QLabel, QFrame

nw/gui/tools/dochighlight.py

@@ -14,7 +14,9 @@ import logging
 import nw
 
 from PyQt5.QtCore import Qt, QRegularExpression
-from PyQt5.QtGui  import QColor, QTextCharFormat, QFont, QSyntaxHighlighter, QBrush
+from PyQt5.QtGui import (
+    QColor, QTextCharFormat, QFont, QSyntaxHighlighter, QBrush
+)
 
 from nw.constants import nwUnicode
 
@@ -196,7 +198,7 @@ class GuiDocHighlighter(QSyntaxHighlighter):
         ))
 
         self.hRules.append((
-            "<(\S+?)>", {
+            r"<(\S+?)>", {
                 0 : self.hStyles["replace"],
             }
         ))

nw/project/document.py

@@ -103,9 +103,12 @@ class NWDoc():
         docTemp = path.join(dataPath,docFile[:-3]+"tmp")
         docBack = path.join(dataPath,docFile[:-3]+"bak")
 
-        if path.isfile(docTemp): unlink(docTemp)
+        if path.isfile(docTemp):
-        if path.isfile(docBack): rename(docBack,docTemp)
+            unlink(docTemp)
-        if path.isfile(docPath): rename(docPath,docBack)
+        if path.isfile(docBack):
+            rename(docBack,docTemp)
+        if path.isfile(docPath):
+            rename(docPath,docBack)
 
         try:
             with open(docPath,mode="w",encoding="utf8") as outFile:

nw/project/index.py

@@ -390,7 +390,6 @@ class NWIndex():
     def buildNovelList(self):
         """Build a list of the content of the novel.
         """
-
         self.novelList  = []
         self.novelOrder = []
         for tHandle in self.theProject.treeOrder:
@@ -399,7 +398,6 @@ class NWIndex():
             for tEntry in self.novelIndex[tHandle]:
                 self.novelList.append(tEntry)
                 self.novelOrder.append("%s:%d" % (tHandle,tEntry[0]))
-
         return True
 
     def buildReferenceList(self, tHandle):

nw/project/project.py

@@ -194,8 +194,10 @@ class NWProject():
         self.projCache = path.join(self.projPath,"cache")
         self.projDict  = path.join(self.projMeta, nwFiles.PROJ_DICT)
 
-        if not self._checkFolder(self.projMeta):  return
+        if not self._checkFolder(self.projMeta):
-        if not self._checkFolder(self.projCache): return
+            return
+        if not self._checkFolder(self.projCache):
+            return
 
         try:
             nwXML = etree.parse(fileName)
@@ -411,8 +413,8 @@ class NWProject():
                 return False
             if self.projName == "":
                 self.theParent.makeAlert((
-                    "You must set a valid project name in project settings to use "
+                    "You must set a valid project name in project settings to "
-                    "the automatic project backup feature."
+                    "use the automatic project backup feature."
                 ), nwAlert.ERROR)
                 return False
             self.doBackup = True