refactor: Replace extra context loader with closure

Author: SilverRainZ

src/sphinxnotes/render/ctxnodes.py

@@ -12,7 +12,7 @@
     UnresolvedContext,
     ResolvedContext,
 )
-from .extractx import ExtraContextLoader
+from .extractx import ExtraContextRequest, build_load_extra, extra_context_names
 from .markup import MarkupRenderer
 from .jinja import TemplateRenderer
 from .utils import (
@@ -132,15 +132,15 @@ def err_report() -> Report:
         report.text(f'Template (phase: {self.template.phase}):')
         report.code(self.template.text, lang='jinja')
 
-        extras = ExtraContextLoader(self, host)
+        extra_request = ExtraContextRequest(self.template.phase, self, host.env, host)
         report.text('Available extra context names:')
-        report.code(pformat(sorted(extras.names())), lang='python')
+        report.code(pformat(sorted(extra_context_names())), lang='python')
 
         # 2. Render the template and context to markup text.
         try:
             markup = TemplateRenderer(self.template.text).render(
                 ctx,
-                globals_={'load_extra': extras.load},
+                globals={'load_extra': build_load_extra(extra_request)},
                 debug=self.template.debug,
             )
         except Exception as e:

src/sphinxnotes/render/extractx.py

@@ -15,9 +15,13 @@
 
 @dataclass(frozen=True)
 class ExtraContextRequest:
+    #: The render phase of the current template.
     phase: Phase
+    #: The pending node being rendered.
     node: pending_node
+    #: The current Sphinx build environment.
     env: BuildEnvironment
+    #: The current render host.
     host: SphinxDirective | SphinxRole | SphinxTransform
 
 
@@ -68,39 +72,19 @@ def decorator(cls):
     return decorator
 
 
-# ========================
-# Extra Context Generation
-# ========================
+def extra_context_names() -> set[str]:
+    return _REGISTRY.get_names()
 
 
-class ExtraContextLoader:
-    node: pending_node
-    request: ExtraContextRequest
-    cache: dict[str, Any]
-
-    def __init__(
-        self,
-        node: pending_node,
-        host: SphinxDirective | SphinxRole | SphinxTransform,
-    ) -> None:
-        self.node = node
-        self.request = ExtraContextRequest(node.template.phase, node, host.env, host)
-        self.cache = {}
-
-    def names(self) -> set[str]:
-        return _REGISTRY.get_names()
-
-    def load(self, name: str) -> Any:
-        if name in self.cache:
-            return self.cache[name]
-
+def build_load_extra(request: ExtraContextRequest):
+    def load_extra(name: str) -> Any:
         ctx = _REGISTRY.get(name)
         if ctx is None:
             raise ValueError(
                 f'Extra context "{name}" is not registered. '
-                f'Available: {sorted(self.names())}'
+                f'Available: {sorted(extra_context_names())}'
             )
 
-        value = ctx.generate(self.request)
-        self.cache[name] = value
-        return value
+        return ctx.generate(request)
+
+    return load_extra

src/sphinxnotes/render/jinja.py

@@ -33,7 +33,7 @@ class TemplateRenderer:
     def render(
         self,
         data: ResolvedContext,
-        globals_: dict[str, Any] | None = None,
+        globals: dict[str, Any] | None = None,
         debug: bool = False,
     ) -> str:
         # Convert data to context dict.
@@ -43,8 +43,8 @@ def render(
             ctx = data.copy()
 
         # Inject globals.
-        if globals_:
-            ctx.update(globals_)
+        if globals:
+            ctx.update(globals)
 
         return self._render(ctx, debug=debug)
 

tests/test_extractx.py

@@ -0,0 +1,36 @@
+from types import SimpleNamespace
+
+from sphinxnotes.render.extractx import (
+    ExtraContext,
+    ExtraContextRequest,
+    _REGISTRY,
+    build_load_extra,
+)
+from sphinxnotes.render.template import Template
+from sphinxnotes.render.ctxnodes import pending_node
+
+
+class CountingExtraContext(ExtraContext):
+    def __init__(self) -> None:
+        self.calls = 0
+
+    def generate(self, request):
+        self.calls += 1
+        return self.calls
+
+
+def test_extra_context_loader_does_not_cache_values():
+    name = 'test_no_cache'
+    ctx = CountingExtraContext()
+    _REGISTRY.register(name, ctx)
+
+    try:
+        node = pending_node({}, Template(''))
+        host = SimpleNamespace(env=SimpleNamespace())
+        request = ExtraContextRequest(Template('').phase, node, host.env, host)
+        load_extra = build_load_extra(request)
+
+        assert load_extra(name) == 1
+        assert load_extra(name) == 2
+    finally:
+        _REGISTRY.ctxs.pop(name, None)