fix: Show detailed report when error occurs

Author: SilverRainZ

src/sphinxnotes/render/ctxnodes.py

@@ -100,16 +100,8 @@ def render(self, host: Host) -> None:
         # Create debug report.
         report = Report('Render Report', 'DEBUG', source=self.source, line=self.line)
 
-        # Constructor for error report.
-        def err_report() -> Report:
-            if self.template.debug:
-                # Reuse the render report as possible.
-                report['type'] = 'ERROR'
-                return report
-            return Report('Render Report', 'ERROR', source=self.source, line=self.line)
-
         if self._ctx_pickle_error is not None:
-            report = err_report()
+            report.level = 'ERROR'
             report.exception(
                 self._ctx_pickle_error,
                 caption=(
@@ -131,10 +123,10 @@ def err_report() -> Report:
             try:
                 ctx = self.ctx = pdata.resolve(host.env)
             except Exception:
-                report = err_report()
+                report.level = 'ERROR'
                 report.current_exception(
                     caption='Failed to resolve unresolved context:',
-                    debug=self.template.debug,
+                    traceback=self.template.debug,
                 )
                 self += report
                 return None
@@ -170,9 +162,9 @@ def err_report() -> Report:
                 debug=self.template.debug,
             )
         except Exception:
-            report = err_report()
+            report.level = 'ERROR'
             report.current_exception(
-                caption='Failed to render Jinja template:', debug=self.template.debug
+                caption='Failed to render Jinja template:', traceback=self.template.debug
             )
             self += report
             return
@@ -186,13 +178,13 @@ def err_report() -> Report:
         try:
             ns, msgs = MarkupRenderer(host).render(markup, inline=self.inline)
         except Exception:
-            report = err_report()
+            report.level = 'ERROR'
             report.current_exception(
                 caption=(
                     'Failed to render markup text '
                     f'to {"inline " if self.inline else ""}nodes:'
                 ),
-                debug=self.template.debug,
+                traceback=self.template.debug,
             )
             self += report
             return

src/sphinxnotes/render/utils/__init__.py

@@ -97,16 +97,24 @@ def find_nearest_block_element(node: nodes.Node | None) -> nodes.Element | None:
 
 
 class Report(nodes.system_message):
-    type Type = Literal['DEBUG', 'INFO', 'WARNING', 'ERROR']
+    type Level = Literal['DEBUG', 'INFO', 'WARNING', 'ERROR']
 
     title: str
 
     def __init__(
-        self, title: str, typ: Type = 'DEBUG', *children, **attributes
+        self, title: str, level: Level = 'DEBUG', *children, **attributes
     ) -> None:
-        super().__init__(title + ':', type=typ, level=2, *children, **attributes)
+        super().__init__(title + ':', type=level, level=2, *children, **attributes)
         self.title = title
 
+    @property
+    def level(self) -> Level:
+        return self['type']
+
+    @level.setter
+    def level(self, level: Level):
+        self['type'] = level
+
     def empty(self) -> bool:
         # title is the only children
         return len(self.children) <= 1
@@ -177,18 +185,15 @@ def exception(
         self.code(msg, lang='pytb', caption=caption)
 
     def current_exception(
-        self, caption: str | None = None, debug: bool = False
+        self, caption: str | None = None, traceback: bool = False
     ) -> None:
-        if debug:
+        if traceback:
             self.traceback(caption=caption)
-            return
-        _, e, _ = sys.exc_info()
-        if e is None:
-            return
-        self.exception(e, caption=caption)
-
-    def is_error(self) -> bool:
-        return self['type'] == 'ERROR'
+        else:
+            _, e, _ = sys.exc_info()
+            if e is not None:
+                self.exception(e, caption=caption)
+
 
     type Inliner = RstInliner | tuple[nodes.document, nodes.Element]