Source code for pyquickhelper.helpgen.helpgen_exceptions

"""
Exception raised by the automated documentation



:githublink:`%|py|6`
"""


class HelpGenException(Exception):

    """
    custom exception


    :githublink:`%|py|12`
    """

    def __init__(self, message, file=None):
        """
        redefines the message sent to an exception

        :param      message:     message
        :param      file:        filename


        :githublink:`%|py|20`
        """
        if file is None:
            Exception.__init__(self, message)
        else:
            mes = '{0}\n  File "{1}", line 1'.format(message, file)
            Exception.__init__(self, mes)


class ImportErrorHelpGen(ImportError):

    """
    A custom exception to detect a specific location when
    *ImportError* happens in the process.


    :githublink:`%|py|33`
    """
    pass


class HelpGenConvertError(Exception):

    """
    Exception raised when a conversion failed.


    :githublink:`%|py|41`
    """
    pass


class NotebookConvertError(Exception):

    """
    Exception raised when a conversion failed.


    :githublink:`%|py|49`
    """
    pass