Reproog/novelWriter
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Code and GUI text cleanup (#926)

Browse Source 
* Move int range checkers from options class to common file
* Improve error handling and reporting
* Make some minor improvements to init and test suite
* Fix 'trypewriter' to 'typewriter' typo
* Remove menu path description in dialog help text
* Improve the help text for entries in the Format menu
* Reword a couple of dialog messages
This commit is contained in:
Veronica Berglyd Olsen
2021-11-07 18:17:17 +01:00
committed by GitHub
parent e71121f738
commit e8bb130245
23 changed files with 257 additions and 250 deletions
Download Patch File Download Diff File Expand all files Collapse all files
novelwriter/core/document.py
+6 -6
View File
@@ -100,8 +100,8 @@ class NWDoc():
# Load the rest of the file
theText += inFile.read()
except Exception as e:
self._docError = str(e)
except Exception as exc:
self._docError = str(exc)
return None
else:
@@ -149,8 +149,8 @@ class NWDoc():
with open(docTemp, mode="w", encoding="utf-8") as outFile:
outFile.write(docMeta)
outFile.write(docText)
except Exception as e:
self._docError = str(e)
except Exception as exc:
self._docError = str(exc)
return False
# If we're here, the file was successfully saved, so we can
@@ -184,8 +184,8 @@ class NWDoc():
try:
os.unlink(chkFile)
logger.debug("Deleted: %s", chkFile)
except Exception as e:
self._docError = str(e)
except Exception as exc:
self._docError = str(exc)
return False
return True
novelwriter/core/options.py
-22
View File
@@ -185,26 +185,4 @@ class OptionState():
return checkBool(self._theState[group].get(name, default), default)
return default
##
# Validators
##
def validIntRange(self, value, first, last, default):
"""Check that an int is in a given range. If it isn't, return
the default value.
"""
if isinstance(value, int):
if value >= first and value <= last:
return value
return default
def validIntTuple(self, value, valid, default):
"""Check that an int is an element of a tuple. If it isn't,
return the default value.
"""
if isinstance(value, int):
if value in valid:
return value
return default
# END Class OptionState
novelwriter/core/project.py
+42 -42
View File
@@ -415,10 +415,10 @@ class NWProject():
try:
nwXML = etree.parse(fileName)
except Exception as e:
self.theParent.makeAlert([
self.tr("Failed to parse project xml."), str(e)
], nwAlert.ERROR)
except Exception as exc:
self.theParent.makeAlert(self.tr(
"Failed to parse project xml."
), nwAlert.ERROR, exception=exc)
# Trying to open backup file instead
backFile = fileName[:-3]+"bak"
@@ -428,10 +428,10 @@ class NWProject():
), nwAlert.INFO)
try:
nwXML = etree.parse(backFile)
except Exception as e:
self.theParent.makeAlert([
self.tr("Failed to parse project xml."), str(e)
], nwAlert.ERROR)
except Exception as exc:
self.theParent.makeAlert(self.tr(
"Failed to parse project xml."
), nwAlert.ERROR, exception=exc)
self.clearProject()
return False
else:
@@ -487,8 +487,8 @@ class NWProject():
self.tr("File Version"),
self.tr(
"The file format of your project is about to be updated. "
"If you proceed, this project can no longer be opened by "
"an older version of novelWriter. Continue?"
"If you proceed, older versions of novelWriter will no "
"longer be able to open this project. Continue?"
)
)
if not msgYes:
@@ -708,10 +708,10 @@ class NWProject():
encoding="utf-8",
xml_declaration=True
))
except Exception as e:
self.theParent.makeAlert([
self.tr("Failed to save project."), str(e)
], nwAlert.ERROR)
except Exception as exc:
self.theParent.makeAlert(self.tr(
"Failed to save project."
), nwAlert.ERROR, exception=exc)
return False
# If we're here, the file was successfully saved,
@@ -788,21 +788,21 @@ class NWProject():
if self.mainConf.backupPath is None or self.mainConf.backupPath == "":
self.theParent.makeAlert(self.tr(
"Cannot backup project because no backup path is set. "
"Please set a valid backup location in Tools > Preferences."
"Please set a valid backup location in Preferences."
), nwAlert.ERROR)
return False
if self.projName is None or self.projName == "":
self.theParent.makeAlert(self.tr(
"Cannot backup project because no project name is set. "
"Please set a Working Title in Project > Project Settings."
"Please set a Working Title in Project Settings."
), nwAlert.ERROR)
return False
if not os.path.isdir(self.mainConf.backupPath):
self.theParent.makeAlert(self.tr(
"Cannot backup project because the backup path does not exist. "
"Please set a valid backup location in Tools > Preferences."
"Please set a valid backup location in Preferences."
), nwAlert.ERROR)
return False
@@ -812,17 +812,17 @@ class NWProject():
try:
os.mkdir(baseDir)
logger.debug("Created folder: %s", baseDir)
except Exception as e:
self.theParent.makeAlert([
self.tr("Could not create backup folder."), str(e)
], nwAlert.ERROR)
except Exception as exc:
self.theParent.makeAlert(self.tr(
"Could not create backup folder."
), nwAlert.ERROR, exception=exc)
return False
if os.path.commonpath([self.projPath, baseDir]) == self.projPath:
self.theParent.makeAlert(self.tr(
"Cannot backup project because the backup path is within the "
"project folder to be backed up. Please choose a different "
"backup path in Tools > Preferences."
"backup path in Preferences."
), nwAlert.ERROR)
return False
@@ -839,10 +839,10 @@ class NWProject():
"Backup archive file written to: {0}"
).format(f"{os.path.join(cleanName, archName)}.zip"), nwAlert.INFO)
except Exception as e:
self.theParent.makeAlert([
self.tr("Could not write backup archive."), str(e)
], nwAlert.ERROR)
except Exception as exc:
self.theParent.makeAlert(self.tr(
"Could not write backup archive."
), nwAlert.ERROR, exception=exc)
return False
self.theParent.setStatus(self.tr(
@@ -872,10 +872,10 @@ class NWProject():
try:
shutil.unpack_archive(pkgSample, projPath)
isSuccess = True
except Exception as e:
self.theParent.makeAlert([
self.tr("Failed to create a new example project."), str(e)
], nwAlert.ERROR)
except Exception as exc:
self.theParent.makeAlert(self.tr(
"Failed to create a new example project."
), nwAlert.ERROR, exception=exc)
elif os.path.isdir(srcSample):
@@ -894,10 +894,10 @@ class NWProject():
isSuccess = True
except Exception as e:
self.theParent.makeAlert([
self.tr("Failed to create a new example project."), str(e)
], nwAlert.ERROR)
except Exception as exc:
self.theParent.makeAlert(self.tr(
"Failed to create a new example project."
), nwAlert.ERROR, exception=exc)
else:
self.theParent.makeAlert(self.tr(
@@ -933,10 +933,10 @@ class NWProject():
try:
os.mkdir(projPath)
logger.debug("Created folder: %s", projPath)
except Exception as e:
self.theParent.makeAlert([
self.tr("Could not create new project folder."), str(e)
], nwAlert.ERROR)
except Exception as exc:
self.theParent.makeAlert(self.tr(
"Could not create new project folder."
), nwAlert.ERROR, exception=exc)
return False
if os.path.isdir(projPath):
@@ -1327,10 +1327,10 @@ class NWProject():
try:
os.mkdir(thePath)
logger.debug("Created folder: %s", thePath)
except Exception as e:
self.theParent.makeAlert([
self.tr("Could not create folder."), str(e)
], nwAlert.ERROR)
except Exception as exc:
self.theParent.makeAlert(self.tr(
"Could not create folder."
), nwAlert.ERROR, exception=exc)
return False
return True