refactor: Add env parameter to UnresolvedContext.resolve()

src/sphinxnotes/render/ctx.py

@@ -4,11 +4,14 @@
 """
 
 from __future__ import annotations
-from typing import Any
+from typing import TYPE_CHECKING, Any
 from abc import ABC, abstractmethod
 from collections.abc import Hashable
 from .data import ParsedData
 
+if TYPE_CHECKING:
+    from sphinx.environment import BuildEnvironment
+
 type ResolvedContext = ParsedData | dict[str, Any]
 """Resolved context types used by template rendering."""
 
@@ -17,7 +20,7 @@ class UnresolvedContext(ABC, Hashable):
     """An abstract representation of context that will be resolved later."""
 
     @abstractmethod
-    def resolve(self) -> ResolvedContext:
+    def resolve(self, env: BuildEnvironment) -> ResolvedContext:
         """This method will be called when rendering to get the available
         :py:type:`ResolvedContext`."""
         ...

src/sphinxnotes/render/ctxnodes.py

@@ -114,7 +114,7 @@ def err_report() -> Report:
                 hook(self, pdata)
 
             try:
-                ctx = self.ctx = pdata.resolve()
+                ctx = self.ctx = pdata.resolve(host.env)
             except Exception as e:
                 report = err_report()
                 report.text('Failed to resolve unresolved context:')

src/sphinxnotes/render/sources.py

@@ -9,7 +9,7 @@
 """
 
 from __future__ import annotations
-from typing import final, override
+from typing import TYPE_CHECKING, final, override
 from abc import abstractmethod
 from dataclasses import dataclass
 
@@ -20,6 +20,9 @@
 from .template import Template
 from .pipeline import BaseContextSource, BaseContextDirective, BaseContextRole
 
+if TYPE_CHECKING:
+    from sphinx.environment import BuildEnvironment
+
 
 @dataclass
 class UnparsedData(UnresolvedContext):
@@ -32,7 +35,7 @@ class UnparsedData(UnresolvedContext):
     schema: Schema
 
     @override
-    def resolve(self) -> ResolvedContext:
+    def resolve(self, env: BuildEnvironment) -> ResolvedContext:
         return self.schema.parse(self.raw)
 
     @override

tests/test_ctx.py

@@ -1,4 +1,5 @@
 import pickle
+from unittest.mock import MagicMock
 
 from sphinxnotes.render.data import RawData, Schema
 from sphinxnotes.render.sources import UnparsedData
@@ -17,6 +18,7 @@ def test_schema_and_unparsed_data_are_picklable():
 
     restored = pickle.loads(pickle.dumps(pending))
 
-    assert restored.resolve().name == 'mimi'
-    assert restored.resolve().attrs == {'age': 2, 'tags': ['cat', 'cute']}
-    assert restored.resolve().content == 'hello'
+    mock_env = MagicMock()
+    assert restored.resolve(mock_env).name == 'mimi'
+    assert restored.resolve(mock_env).attrs == {'age': 2, 'tags': ['cat', 'cute']}
+    assert restored.resolve(mock_env).content == 'hello'