Source code for babelizer.errors

"""Exceptions raised by the *babelizer*."""

from __future__ import annotations




[docs]
class BabelizeError(Exception):
    """An exception that the babelizer can handle and show to the user."""



[docs]
    def __init__(self, message: str):
        self._message = message



    def __str__(self) -> str:
        """Render a user-readable error message."""
        return self._message






[docs]
class ValidationError(BabelizeError):
    """Raised if babelizer configuration data are incorrectly formatted."""

    pass






[docs]
class RenderError(BabelizeError):
    """Raised if the babelizer encounters an error in creating output files."""

    pass






[docs]
class ScanError(BabelizeError):
    """Raised if babelizer configuration file is incorrectly formatted."""

    pass






[docs]
class OutputDirExistsError(BabelizeError):
    """An exception used when the directory for babelized output exists."""

    def __str__(self) -> str:
        """Render a user-readable error message."""
        return f"output directory exists: {self._message}"






[docs]
class SetupPyError(BabelizeError):
    """Raised if the babelized package cannot be built through setup.py."""

    pass