feat: Support inline rendering

Author: SilverRainZ

src/sphinxnotes/data/__init__.py

@@ -27,9 +27,7 @@
 from .render import (
     Caller,
     pending_node,
-    RenderedNode,
     rendered_node,
-    rendered_inline_node,
     BaseDataDefiner,
     BaseDataDefineRole,
     BaseDataDefineDirective,
@@ -59,9 +57,8 @@
     'Template',
     'Caller',
     'pending_node',
-    'RenderedNode',
     'rendered_node',
-    'rendered_inline_node',
+    'rendered_node',
     'BaseDataDefiner',
     'BaseDataDefineRole',
     'BaseDataDefineDirective',
@@ -86,6 +83,7 @@ def extractx(cls) -> ExtraContextRegistry:
 
 REGISTRY = Registry()
 
+
 def setup(app: Sphinx):
     meta.pre_setup(app)
 

src/sphinxnotes/data/adhoc.py

@@ -13,7 +13,9 @@
 """
 
 from __future__ import annotations
-from typing import TYPE_CHECKING, cast, override
+from typing import TYPE_CHECKING, override
+
+from typing import cast
 
 from docutils import nodes
 from docutils.parsers.rst import directives
@@ -67,6 +69,10 @@ def run(self) -> list[nodes.Node]:
         return []
 
 
+if TYPE_CHECKING:
+    ...
+
+
 class FreeDataDefineDirective(BaseDataDefineDirective, FreeStyleDirective):
     optional_arguments = 1
     has_content = True

src/sphinxnotes/data/data.py

@@ -9,11 +9,12 @@
 """
 
 from __future__ import annotations
-from typing import TYPE_CHECKING, override
+from typing import TYPE_CHECKING
 import re
 from dataclasses import dataclass, asdict, field as dataclass_field
 from ast import literal_eval
-from abc import ABC, abstractmethod
+
+from .utils import Unpicklable
 
 if TYPE_CHECKING:
     from typing import Any, Callable, Generator, Self, Literal
@@ -210,25 +211,29 @@ def add_by_option(
 # ======================
 
 
-class Data(ABC):
-    @abstractmethod
-    def as_context(self) -> dict[str, Any]: ...
-
-
 @dataclass
 class RawData:
     name: str | None
     attrs: dict[str, str]
     content: str | None
 
 
+@dataclass
+class PendingData(Unpicklable):
+    raw: RawData
+    schema: Schema
+
+    def parse(self) -> ParsedData:
+        return self.schema.parse(self.raw)
+
+
 @dataclass
 class ParsedData:
     name: Value
     attrs: dict[str, Value]
     content: Value
 
-    def as_context(self) -> dict[str, Any]:
+    def asdict(self) -> dict[str, Any]:
         """
         Convert Data to a dict for usage of Jinja2 context.
 
@@ -247,23 +252,6 @@ def as_context(self) -> dict[str, Any]:
         return ctx
 
 
-@dataclass
-class PendingData(Data):
-    raw: RawData
-    schema: Schema
-    _data: ParsedData | None = dataclass_field(init=False, default=None)
-
-    def parse(self) -> ParsedData:
-        if self._data:
-            return self._data
-        self._data = self.schema.parse(self.raw)
-        return self._data
-
-    @override
-    def as_context(self) -> dict[str, Any]:
-        return self.parse().as_context()
-
-
 @dataclass
 class Field:
     #: Type of element.

src/sphinxnotes/data/extractx.py

@@ -1,18 +1,51 @@
 from __future__ import annotations
 from typing import TYPE_CHECKING, override
+from dataclasses import dataclass
 
+from docutils import nodes
 from sphinx.util.docutils import SphinxDirective, SphinxRole
 from sphinx.transforms import SphinxTransform
 
-from .utils import find_current_document, find_current_section
+from .utils import find_current_section
 from .utils.ctxproxy import proxy
-from .render import EXTRACTX_REGISTRY, ParsePhaseContextGenerator, FullPhaseContextGenerator, ParseCaller, Caller, pending_node
-from .template import Context
+from .renderer import Host, ParseHost
+from .render import (
+    EXTRACTX_REGISTRY,
+    ParsePhaseContextGenerator,
+    RenderPhaseContextGenerator,
+)
+
+if TYPE_CHECKING:
+    from typing import Any
+
+@dataclass
+class _Host:
+    v: Host
+
+    @property
+    def doctree(self) -> nodes.document:
+        if isinstance(self.v, SphinxDirective):
+            return self.v.state.document
+        elif isinstance(self.v, SphinxRole):
+            return self.v.inliner.document
+        elif isinstance(self.v, SphinxTransform):
+            return self.v.document
+        else:
+            raise NotImplementedError
+
+    @property
+    def parent(self) -> nodes.Element | None:
+        if isinstance(self.v, SphinxDirective):
+            return self.v.state.parent
+        elif isinstance(self.v, SphinxRole):
+            return self.v.inliner.parent
+        else:
+            return None
 
 
 class MarkupContextGenerator(ParsePhaseContextGenerator):
     @override
-    def generate(self, caller: ParseCaller, n: pending_node) -> Context:
+    def generate(self, caller: ParseHost) -> Any:
         isdir = isinstance(caller, SphinxDirective)
         return {
             'type': 'directive' if isdir else 'role',
@@ -21,44 +54,34 @@ def generate(self, caller: ParseCaller, n: pending_node) -> Context:
             'rawtext': caller.block_text if isdir else caller.rawtext,
         }
 
-class DocContextGenerator(FullPhaseContextGenerator):
+
+class DocContextGenerator(RenderPhaseContextGenerator):
     @override
-    def generate(self, caller: Caller, n: pending_node) -> Context:
-        if isinstance(caller, SphinxDirective):
-            return proxy(caller.state.document)
-        elif isinstance(caller, SphinxRole):
-            return proxy(caller.inliner.document)
-        elif isinstance(caller, SphinxTransform):
-            return proxy(caller.document)
-        else:
-            assert False
+    def generate(self, caller: Host) -> Any:
+        return proxy(_Host(caller).doctree)
 
 
-class SectionContextGenerator(FullPhaseContextGenerator):
+class SectionContextGenerator(ParsePhaseContextGenerator):
     @override
-    def generate(self, caller: Caller, n: pending_node) -> Context:
-        if n.parent:
-            return proxy(find_current_section(n.parent))
-        elif isinstance(caller, SphinxDirective):
-            return proxy(find_current_section(caller.state.parent))
-        elif isinstance(caller, SphinxRole):
-            return proxy(caller.inliner.parent)
-        else:
-            assert False
+    def generate(self, caller: ParseHost) -> Any:
+        parent = _Host(caller).parent
+        return proxy(find_current_section(parent))
 
 
-class SphinxEnvContextGenerator(FullPhaseContextGenerator):
+class SphinxEnvContextGenerator(RenderPhaseContextGenerator):
     @override
-    def generate(self, caller: Caller, n: pending_node) -> Context:
+    def generate(self, caller: Host) -> Any:
         return proxy(caller.env)
 
-class SphinxConfigContextGenerator(FullPhaseContextGenerator):
+
+class SphinxConfigContextGenerator(RenderPhaseContextGenerator):
     @override
-    def generate(self, caller: Caller, n: pending_node) -> Context:
+    def generate(self, caller: Host) -> Any:
         return proxy(caller.config)
 
-EXTRACTX_REGISTRY.add_parsing_phase_context('markup', MarkupContextGenerator())
-EXTRACTX_REGISTRY.add_full_phase_context('doc', DocContextGenerator())
-EXTRACTX_REGISTRY.add_full_phase_context('section',SectionContextGenerator())
-EXTRACTX_REGISTRY.add_full_phase_context('env', SphinxEnvContextGenerator())
-EXTRACTX_REGISTRY.add_full_phase_context('config', SphinxConfigContextGenerator())
+
+EXTRACTX_REGISTRY.add_parsing('markup', MarkupContextGenerator())
+EXTRACTX_REGISTRY.add_parsing('section', SectionContextGenerator())
+EXTRACTX_REGISTRY.add_render('doc', DocContextGenerator())
+EXTRACTX_REGISTRY.add_render('env', SphinxEnvContextGenerator())
+EXTRACTX_REGISTRY.add_render('config', SphinxConfigContextGenerator())