mirror of https://github.com/patacrep/patacrep.git
Engine for LaTeX songbooks
http://www.patacrep.com
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
117 lines
3.4 KiB
117 lines
3.4 KiB
"""Songbook exceptions and errors."""
|
|
|
|
class SongbookError(Exception):
|
|
"""Generic songbook error.
|
|
|
|
Songbook errors should inherit from this one.
|
|
"""
|
|
pass
|
|
|
|
class SBFileError(SongbookError):
|
|
"""Error during songbook file decoding"""
|
|
|
|
def __init__(self, message=None):
|
|
super(SBFileError, self).__init__()
|
|
self.message = message
|
|
|
|
def __str__(self):
|
|
return self.message
|
|
|
|
class TemplateError(SongbookError):
|
|
"""Error during template generation"""
|
|
|
|
def __init__(self, original, message=None):
|
|
super(TemplateError, self).__init__()
|
|
self.original = original
|
|
self.message = message
|
|
|
|
def __str__(self):
|
|
if self.message is None:
|
|
return str(self.original)
|
|
else:
|
|
return self.message
|
|
|
|
class ExecutableNotFound(SongbookError):
|
|
"""Couldn't find a LaTeX executable."""
|
|
|
|
def __init__(self, executable):
|
|
super(ExecutableNotFound, self).__init__(
|
|
(
|
|
"""Could not find the following executable: {executable}"""
|
|
).format(executable=executable)
|
|
)
|
|
|
|
class StepError(SongbookError):
|
|
"""Error during execution of one compilation step."""
|
|
|
|
def __init__(self, message):
|
|
super(StepError, self).__init__()
|
|
self.message = message
|
|
|
|
def __str__(self):
|
|
return self.message
|
|
|
|
class LatexCompilationError(StepError):
|
|
"""Error during LaTeX compilation."""
|
|
|
|
def __init__(self, basename):
|
|
super(LatexCompilationError, self).__init__(
|
|
(
|
|
"""Error while LaTeX compilation of "{basename}.tex" """
|
|
"""(see {basename}.log for more information)."""
|
|
).format(basename=basename)
|
|
)
|
|
|
|
class StepCommandError(StepError):
|
|
"""Error during custom command compilation."""
|
|
|
|
def __init__(self, command, code):
|
|
super(StepCommandError, self).__init__((
|
|
"""Error while running custom command "{command}": got return"""
|
|
" code {code}."
|
|
).format(command=command, code=code))
|
|
|
|
|
|
class CleaningError(SongbookError):
|
|
"""Error during cleaning of LaTeX auxiliary files."""
|
|
|
|
def __init__(self, filename, exception):
|
|
super(CleaningError, self).__init__()
|
|
self.filename = filename
|
|
self.exception = exception
|
|
|
|
def __str__(self):
|
|
return """Error while removing "{filename}": {exception}.""".format(
|
|
filename=self.filename,
|
|
exception=str(self.exception)
|
|
)
|
|
|
|
class UnknownStep(StepError):
|
|
"""Unknown compilation step."""
|
|
|
|
def __init__(self, step):
|
|
super(UnknownStep, self).__init__(
|
|
"""Compilation step "{step}" unknown.""".format(step=step)
|
|
)
|
|
|
|
class ParsingError(SongbookError):
|
|
"""Parsing error."""
|
|
|
|
def __init__(self, message):
|
|
super().__init__(self)
|
|
self.message = message
|
|
|
|
def __str__(self):
|
|
return self.message
|
|
|
|
def notfound(filename, paths, message=None):
|
|
"""Return a string saying that file was not found in paths."""
|
|
if message is None:
|
|
message = 'File "{name}" not found in directories {paths}.'
|
|
unique_paths = []
|
|
#pylint: disable=expression-not-assigned
|
|
[unique_paths.append(item) for item in paths if item not in unique_paths]
|
|
return message.format(
|
|
name=filename,
|
|
paths=", ".join(['"{}"'.format(item) for item in unique_paths]),
|
|
)
|
|
|