mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
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.
This commit is contained in:
parent
284d9e703b
commit
654458b525
1
CHANGES
1
CHANGES
@ -67,6 +67,7 @@ Features added
|
||||
dedent via no-argument ``:dedent:`` option
|
||||
* C++, also hyperlink operator overloads in expressions and alias declarations.
|
||||
* #8247: Allow production lists to refer to tokens from other production groups
|
||||
* #8813: Show what extension (or module) caused it on errors on event handler
|
||||
|
||||
Bugs fixed
|
||||
----------
|
||||
|
@ -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:
|
||||
|
@ -19,6 +19,7 @@ from sphinx.deprecation import RemovedInSphinx40Warning
|
||||
from sphinx.errors import ExtensionError, SphinxError
|
||||
from sphinx.locale import __
|
||||
from sphinx.util import logging
|
||||
from sphinx.util.inspect import safe_getattr
|
||||
|
||||
if False:
|
||||
# For type annotation
|
||||
@ -114,8 +115,9 @@ class EventManager:
|
||||
except SphinxError:
|
||||
raise
|
||||
except Exception as exc:
|
||||
modname = safe_getattr(listener.handler, '__module__', None)
|
||||
raise ExtensionError(__("Handler %r for event %r threw an exception") %
|
||||
(listener.handler, name), exc) from exc
|
||||
(listener.handler, name), exc, modname=modname) from exc
|
||||
return results
|
||||
|
||||
def emit_firstresult(self, name: str, *args: Any,
|
||||
|
Loading…
Reference in New Issue
Block a user