refactor: pending_data -> pending_node, rendered_data -> rendered_node

Author: SilverRainZ

src/sphinxnotes/data/__init__.py

@@ -27,8 +27,8 @@
     Phase,
     Template,
     Host,
-    pending_data,
-    rendered_data,
+    pending_node,
+    rendered_node,
     BaseDataDefineRole,
     BaseDataDefineDirective,
     ExtraContextRegistry,
@@ -55,9 +55,9 @@
     'Phase',
     'Template',
     'Host',
-    'pending_data',
-    'rendered_data',
-    'rendered_data',
+    'pending_node',
+    'rendered_node',
+    'rendered_node',
     'BaseDataDefineRole',
     'BaseDataDefineDirective',
     'StrictDataDefineDirective',

src/sphinxnotes/data/render/__init__.py

@@ -2,7 +2,7 @@
 from typing import TYPE_CHECKING
 
 from .render import Phase, Template, Host
-from .datanodes import pending_data, rendered_data
+from .datanodes import pending_node, rendered_node
 from .pipeline import (
     BaseDataDefineRole,
     BaseDataDefineDirective,
@@ -17,9 +17,9 @@
     'Phase',
     'Template',
     'Host',
-    'pending_data',
-    'rendered_data',
-    'rendered_data',
+    'pending_node',
+    'rendered_node',
+    'rendered_node',
     'BaseDataDefineRole',
     'BaseDataDefineDirective',
     'ExtraContextRegistry',

src/sphinxnotes/data/render/datanodes.py

@@ -25,7 +25,7 @@
 class Base(nodes.Element): ...
 
 
-class pending_data(Base, Unpicklable):
+class pending_node(Base, Unpicklable):
     # The data to be rendered by Jinja template.
     data: PendingData | ParsedData | dict[str, Any]
     # The extra context for Jina template.
@@ -56,7 +56,7 @@ def __init__(
         self._markup_text_hooks = []
         self._rendered_nodes_hooks = []
 
-    def render(self, host: Host) -> rendered_data:
+    def render(self, host: Host) -> rendered_node:
         """
         The core function for rendering data to docutils nodes.
 
@@ -65,7 +65,7 @@ def render(self, host: Host) -> rendered_data:
         3. MarkupRenderer.render(Markup Text) -> doctree Nodes (list[nodes.Node])
         """
         # 0. Create container for rendered nodes.
-        rendered = rendered_data()
+        rendered = rendered_node()
         # Copy attributes from pending_node.
         rendered.update_all_atts(self)
         # Copy source and line (which are not included in update_all_atts).
@@ -145,8 +145,8 @@ def render(self, host: Host) -> rendered_data:
 
         return rendered
 
-    def replace_self_inline(self, rendered: rendered_data) -> None:
-        # Split inline nodes and system_message noeds from rendered_data node.
+    def replace_self_inline(self, rendered: rendered_node) -> None:
+        # Split inline nodes and system_message noeds from rendered_node node.
         ns, msgs = rendered.inline(parent=self.parent)
 
         # Insert reports to nearst block elements (usually nodes.paragraph).
@@ -161,11 +161,11 @@ def replace_self_inline(self, rendered: rendered_data) -> None:
 
     """Hooks for procssing render intermediate products. """
 
-    type RawDataHook = Callable[[pending_data, RawData], None]
-    type ParsedDataHook = Callable[[pending_data, RawData], None]
-    type MarkupTextHook = Callable[[pending_data, str], None]
+    type RawDataHook = Callable[[pending_node, RawData], None]
+    type ParsedDataHook = Callable[[pending_node, RawData], None]
+    type MarkupTextHook = Callable[[pending_node, str], None]
     type RenderedNodesHook = Callable[
-        [pending_data, list[nodes.Node], list[nodes.system_message]], None
+        [pending_node, list[nodes.Node], list[nodes.system_message]], None
     ]
 
     _raw_data_hooks: list[RawDataHook]
@@ -186,7 +186,7 @@ def process_rendered_nodes(self, hook: RenderedNodesHook) -> None:
         self._rendered_nodes_hooks.append(hook)
 
 
-class rendered_data(Base, nodes.container):
+class rendered_node(Base, nodes.container):
     # The data used when rendering this node.
     data: ParsedData | dict[str, Any] | None
 

src/sphinxnotes/data/render/extractx.py

@@ -5,7 +5,7 @@
 from sphinx.util.docutils import SphinxDirective
 
 from .render import HostWrapper
-from .datanodes import pending_data
+from .datanodes import pending_node
 from ..utils import find_current_section, Report, Reporter
 from ..utils.ctxproxy import proxy
 
@@ -127,12 +127,12 @@ def generate(self) -> Any:
 
 
 class ExtraContextGenerator:
-    node: pending_data
+    node: pending_node
     report: Report
 
     registry: ClassVar[ExtraContextRegistry] = ExtraContextRegistry()
 
-    def __init__(self, node: pending_data) -> None:
+    def __init__(self, node: pending_node) -> None:
         self.node = node
         self.report = Report(
             'Extra Context Generation Report',

src/sphinxnotes/data/render/pipeline.py

@@ -10,13 +10,13 @@
 The Pipline
 ===========
 
-1. Define data: BaseDataDefiner generates a :cls:`pending_data`, which contains:
+1. Define data: BaseDataDefiner generates a :cls:`pending_node`, which contains:
 
    - Data and possible extra contexts
    - Schema for validating Data
    - Template for rendering data to markup text
 
-2. Render data: the ``pending_data`` nodes will be rendered
+2. Render data: the ``pending_node`` nodes will be rendered
    (by calling :meth:`pending_node.render`) at some point, depending on :cls:`Phase`.
 
    The one who calls ``pending_node.render`` is called ``Host``.
@@ -37,7 +37,7 @@
 How :cls:`RawData` be rendered ``list[nodes.Node]``
 ===================================================
 
-.. seealso:: :meth:`.datanodes.pending_data.render`.
+.. seealso:: :meth:`.datanodes.pending_node.render`.
 
 """
 
@@ -51,7 +51,7 @@
 from sphinx.transforms.post_transforms import SphinxPostTransform, ReferencesResolver
 
 from .render import Phase, Template, Host, ParseHost, TransformHost
-from .datanodes import pending_data, rendered_data
+from .datanodes import pending_node, rendered_node
 from .extractx import ExtraContextGenerator
 from ..data import RawData, PendingData, ParsedData, Schema
 
@@ -64,11 +64,11 @@
 
 class Pipeline(ABC):
     #: Queue of pending node to be rendered.
-    _q: list[pending_data] | None = None
+    _q: list[pending_node] | None = None
 
     """Methods to be overrided."""
 
-    def process_pending_node(self, n: pending_data) -> bool:
+    def process_pending_node(self, n: pending_node) -> bool:
         """
         You can add hooks to pending node here.
 
@@ -78,43 +78,43 @@ def process_pending_node(self, n: pending_data) -> bool:
         """
         ...
 
-    def process_rendered_node(self, n: rendered_data) -> None: ...
+    def process_rendered_node(self, n: rendered_node) -> None: ...
 
     """Helper method for subclasses."""
 
     @final
-    def queue(self, n: pending_data) -> None:
+    def queue(self, n: pending_node) -> None:
         if not self._q:
             self._q = []
         self._q.append(n)
 
     @final
     def queue_raw_data(
         self, data: RawData, schema: Schema, tmpl: Template
-    ) -> pending_data:
-        pending = pending_data(PendingData(data, schema), tmpl)
+    ) -> pending_node:
+        pending = pending_node(PendingData(data, schema), tmpl)
         self.queue(pending)
         return pending
 
     @final
-    def queue_parsed_data(self, data: ParsedData, tmpl: Template) -> pending_data:
-        pending = pending_data(data, tmpl)
+    def queue_parsed_data(self, data: ParsedData, tmpl: Template) -> pending_node:
+        pending = pending_node(data, tmpl)
         self.queue(pending)
         return pending
 
     @final
-    def queue_any_data(self, data: Any, tmpl: Template) -> pending_data:
-        pending = pending_data(data, tmpl)
+    def queue_any_data(self, data: Any, tmpl: Template) -> pending_node:
+        pending = pending_node(data, tmpl)
         self.queue(pending)
         return pending
 
     @final
-    def render_queue(self) -> list[pending_data | rendered_data]:
+    def render_queue(self) -> list[pending_node | rendered_node]:
         """
         Try rendering all pending nodes in queue.
 
-        If the timing(Phase) is ok, :cls:`pending_data` will be rendered to a
-        :cls:`rendered_data`; otherwise, the pending node is unchanged.
+        If the timing(Phase) is ok, :cls:`pending_node` will be rendered to a
+        :cls:`rendered_node`; otherwise, the pending node is unchanged.
 
         If the pending node is already inserted to document, it will not be return.
         And the corrsponding rendered node will replace it too.
@@ -169,7 +169,7 @@ def current_template(self) -> Template: ...
     """Methods override from parent."""
 
     @override
-    def process_pending_node(self, n: pending_data) -> bool:
+    def process_pending_node(self, n: pending_node) -> bool:
         host = cast(ParseHost, self)
 
         # Set source and line.
@@ -204,7 +204,7 @@ def current_data(self) -> RawData:
         return RawData(None, {}, self.text)
 
     @override
-    def process_pending_node(self, n: pending_data) -> bool:
+    def process_pending_node(self, n: pending_node) -> bool:
         n.inline = True
         return super().process_pending_node(n)
 
@@ -216,7 +216,7 @@ def run(self) -> tuple[list[nodes.Node], list[nodes.system_message]]:
 
         ns, msgs = [], []
         for n in self.render_queue():
-            if not isinstance(n, rendered_data):
+            if not isinstance(n, rendered_node):
                 ns.append(n)
                 continue
             n, msg = n.inline(parent=self.inliner.parent)
@@ -228,7 +228,7 @@ def run(self) -> tuple[list[nodes.Node], list[nodes.system_message]]:
 
 class _ParsedHook(SphinxDirective, Pipeline):
     @override
-    def process_pending_node(self, n: pending_data) -> bool:
+    def process_pending_node(self, n: pending_node) -> bool:
         self.state.document.note_source(n.source, n.line)  # type: ignore[arg-type]
 
         # Generate and save parsed extra context for later use.
@@ -240,7 +240,7 @@ def process_pending_node(self, n: pending_data) -> bool:
     def run(self) -> list[nodes.Node]:
         logger.warning(f'running parsed hook for doc {self.env.docname}...')
 
-        for pending in self.state.document.findall(pending_data):
+        for pending in self.state.document.findall(pending_node):
             self.queue(pending)
             # Hook system_message method to let it report the
             # correct line number.
@@ -273,7 +273,7 @@ class _ResolvingHook(SphinxPostTransform, Pipeline):
     default_priority = (ReferencesResolver.default_priority or 10) + 5
 
     @override
-    def process_pending_node(self, n: pending_data) -> bool:
+    def process_pending_node(self, n: pending_node) -> bool:
         # Generate and save post transform extra context for later use.
         ExtraContextGenerator(n).on_post_transform(cast(TransformHost, self))
 
@@ -283,7 +283,7 @@ def process_pending_node(self, n: pending_data) -> bool:
     def apply(self, **kwargs):
         logger.warning(f'running resolving hook for doc {self.env.docname}...')
 
-        for pending in self.document.findall(pending_data):
+        for pending in self.document.findall(pending_node):
             self.queue(pending)
 
         ns = self.render_queue()