summaryrefslogtreecommitdiff
path: root/sphinx/errors.py
diff options
context:
space:
mode:
authorTakeshi KOMIYA <i.tkomiya@gmail.com>2021-02-02 23:26:14 +0900
committerTakeshi KOMIYA <i.tkomiya@gmail.com>2021-02-04 22:35:48 +0900
commit654458b525d2a6c43f0bb5488297fdc20f34f93d (patch)
tree8a27ecdfa38b236aa8e8791e0685d9643be4bb23 /sphinx/errors.py
parent284d9e703bf9919c34414353afd5992218518745 (diff)
downloadsphinx-git-654458b525d2a6c43f0bb5488297fdc20f34f93d.tar.gz
Close #8813: Show what extension caused it on errors on event handler
Show the module name of the event handler on the error inside it to let users know a hint of the error.
Diffstat (limited to 'sphinx/errors.py')
-rw-r--r--sphinx/errors.py11
1 files changed, 9 insertions, 2 deletions
diff --git a/sphinx/errors.py b/sphinx/errors.py
index c632d8dbc..3e84b6b88 100644
--- a/sphinx/errors.py
+++ b/sphinx/errors.py
@@ -47,12 +47,19 @@ class ApplicationError(SphinxError):
class ExtensionError(SphinxError):
"""Extension error."""
- category = 'Extension error'
- def __init__(self, message: str, orig_exc: Exception = None) -> None:
+ def __init__(self, message: str, orig_exc: Exception = None, modname: str = None) -> None:
super().__init__(message)
self.message = message
self.orig_exc = orig_exc
+ self.modname = modname
+
+ @property
+ def category(self) -> str: # type: ignore
+ if self.modname:
+ return 'Extension error (%s)' % self.modname
+ else:
+ return 'Extension error'
def __repr__(self) -> str:
if self.orig_exc: