mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
88 lines
2.2 KiB
Python
88 lines
2.2 KiB
Python
# -*- coding: utf-8 -*-
|
|
"""
|
|
sphinx.errors
|
|
~~~~~~~~~~~~~
|
|
|
|
Contains SphinxError and a few subclasses (in an extra module to avoid
|
|
circular import problems).
|
|
|
|
:copyright: Copyright 2007-2017 by the Sphinx team, see AUTHORS.
|
|
:license: BSD, see LICENSE for details.
|
|
"""
|
|
|
|
if False:
|
|
# For type annotation
|
|
from typing import Any # NOQA
|
|
|
|
|
|
class SphinxError(Exception):
|
|
"""
|
|
Base class for Sphinx errors that are shown to the user in a nicer
|
|
way than normal exceptions.
|
|
"""
|
|
category = 'Sphinx error'
|
|
|
|
|
|
class SphinxWarning(SphinxError):
|
|
"""Raised for warnings if warnings are treated as errors."""
|
|
category = 'Warning, treated as error'
|
|
|
|
|
|
class ExtensionError(SphinxError):
|
|
"""Raised if something's wrong with the configuration."""
|
|
category = 'Extension error'
|
|
|
|
def __init__(self, message, orig_exc=None):
|
|
# type: (unicode, Exception) -> None
|
|
SphinxError.__init__(self, message)
|
|
self.orig_exc = orig_exc
|
|
|
|
def __repr__(self):
|
|
# type: () -> str
|
|
if self.orig_exc:
|
|
return '%s(%r, %r)' % (self.__class__.__name__,
|
|
self.message, self.orig_exc)
|
|
return '%s(%r)' % (self.__class__.__name__, self.message)
|
|
|
|
def __str__(self):
|
|
# type: () -> str
|
|
parent_str = SphinxError.__str__(self)
|
|
if self.orig_exc:
|
|
return '%s (exception: %s)' % (parent_str, self.orig_exc)
|
|
return parent_str
|
|
|
|
|
|
class ConfigError(SphinxError):
|
|
category = 'Configuration error'
|
|
|
|
|
|
class ThemeError(SphinxError):
|
|
category = 'Theme error'
|
|
|
|
|
|
class VersionRequirementError(SphinxError):
|
|
category = 'Sphinx version error'
|
|
|
|
|
|
class PycodeError(Exception):
|
|
def __str__(self):
|
|
# type: () -> str
|
|
res = self.args[0]
|
|
if len(self.args) > 1:
|
|
res += ' (exception was: %r)' % self.args[1]
|
|
return res
|
|
|
|
|
|
class SphinxParallelError(SphinxError):
|
|
|
|
category = 'Sphinx parallel build error'
|
|
|
|
def __init__(self, message, traceback):
|
|
# type: (str, Any) -> None
|
|
self.message = message
|
|
self.traceback = traceback
|
|
|
|
def __str__(self):
|
|
# type: () -> str
|
|
return self.message
|