save

Author: SilverRainZ

docs/index.rst

@@ -46,7 +46,7 @@ Introduction
    :{{ k }}: {{ v }}
    {%- endfor %}
 
-   This document "_doc.title" has {{ _doc.sections | length }} section(s).
+   This document "{{ _doc.title }}" has {{ _doc.sections | length }} section(s).
 
    {{ content }} 
 

src/sphinxnotes/data/__init__.py

@@ -33,10 +33,10 @@
     BaseDataDefiner,
     BaseDataDefineRole,
     BaseDataDefineDirective,
-    StrictDataDefineDirective,
     ExtraContextRegistry,
     EXTRACTX_REGISTRY,
 )
+from .derive import StrictDataDefineDirective
 from .config import Config
 from . import extractx
 

src/sphinxnotes/data/data.py

@@ -13,7 +13,8 @@
 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
@@ -209,18 +210,19 @@ def add_by_option(
 # Data, Field and Schema
 # ======================
 
-
-class Data(ABC):
-    @abstractmethod
-    def asdict(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:
@@ -247,19 +249,6 @@ def asdict(self) -> dict[str, Any]:
         return ctx
 
 
-@dataclass
-class PendingData(Data):
-    raw: RawData
-    schema: Schema
-
-    def parse(self) -> ParsedData:
-        return self.schema.parse(self.raw)
-
-    @override
-    def asdict(self) -> dict[str, Any]:
-        return self.parse().asdict()
-
-
 @dataclass
 class Field:
     #: Type of element.

src/sphinxnotes/data/derive.py

@@ -0,0 +1,71 @@
+"""
+sphinxnotes.data.derive
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Module for rendering data to doctree nodes.
+
+:copyright: Copyright 2025 by the Shengyu Zhang.
+:license: BSD, see LICENSE for details.
+"""
+
+from __future__ import annotations
+from typing import TYPE_CHECKING, override
+
+from docutils.parsers.rst import directives
+
+from .data import Field, Schema
+from .template import Template
+from .render import BaseDataDefineDirective
+
+class StrictDataDefineDirective(BaseDataDefineDirective):
+    final_argument_whitespace = True
+
+    schema: Schema
+    template: Template
+
+    @override
+    def current_template(self) -> Template:
+        return self.template
+
+    @override
+    def current_schema(self) -> Schema:
+        return self.schema
+
+    @classmethod
+    def derive(
+        cls, name: str, schema: Schema, tmpl: Template
+    ) -> type[StrictDataDefineDirective]:
+        """Generate an AnyDirective child class for describing object."""
+        if not schema.name:
+            required_arguments = 0
+            optional_arguments = 0
+        elif schema.name.required:
+            required_arguments = 1
+            optional_arguments = 0
+        else:
+            required_arguments = 0
+            optional_arguments = 1
+
+        assert not isinstance(schema.attrs, Field)
+        option_spec = {}
+        for name, field in schema.attrs.items():
+            if field.required:
+                option_spec[name] = directives.unchanged_required
+            else:
+                option_spec[name] = directives.unchanged
+
+        has_content = schema.content is not None
+
+        # Generate directive class
+        return type(
+            '%sStrictDataDefineDirective' % name.title(),
+            (cls,),
+            {
+                'schema': schema,
+                'template': tmpl,
+                'has_content': has_content,
+                'required_arguments': required_arguments,
+                'optional_arguments': optional_arguments,
+                'option_spec': option_spec,
+            },
+        )

src/sphinxnotes/data/extractx.py

@@ -1,5 +1,5 @@
 from __future__ import annotations
-from typing import override
+from typing import TYPE_CHECKING, override
 
 from sphinx.util.docutils import SphinxDirective, SphinxRole
 from sphinx.transforms import SphinxTransform
@@ -9,17 +9,17 @@
 from .render import (
     EXTRACTX_REGISTRY,
     ParsePhaseContextGenerator,
-    FullPhaseContextGenerator,
+    RenderPhaseContextGenerator,
     ParseCaller,
     Caller,
-    pending_node,
 )
-from .template import Context
 
+if TYPE_CHECKING:
+    from typing import Any
 
 class MarkupContextGenerator(ParsePhaseContextGenerator):
     @override
-    def generate(self, caller: ParseCaller, n: pending_node) -> Context:
+    def generate(self, caller: ParseCaller) -> Any:
         isdir = isinstance(caller, SphinxDirective)
         return {
             'type': 'directive' if isdir else 'role',
@@ -29,9 +29,9 @@ def generate(self, caller: ParseCaller, n: pending_node) -> Context:
         }
 
 
-class DocContextGenerator(FullPhaseContextGenerator):
+class DocContextGenerator(RenderPhaseContextGenerator):
     @override
-    def generate(self, caller: Caller, n: pending_node) -> Context:
+    def generate(self, caller: Caller) -> Any:
         if isinstance(caller, SphinxDirective):
             return proxy(caller.state.document)
         elif isinstance(caller, SphinxRole):
@@ -42,33 +42,31 @@ def generate(self, caller: Caller, n: pending_node) -> Context:
             assert False
 
 
-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):
+    def generate(self, caller: ParseCaller) -> Any:
+        if isinstance(caller, SphinxDirective):
             return proxy(find_current_section(caller.state.parent))
         elif isinstance(caller, SphinxRole):
             return proxy(caller.inliner.parent)
         else:
             assert False
 
 
-class SphinxEnvContextGenerator(FullPhaseContextGenerator):
+class SphinxEnvContextGenerator(RenderPhaseContextGenerator):
     @override
-    def generate(self, caller: Caller, n: pending_node) -> Context:
+    def generate(self, caller: Caller) -> 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: Caller) -> 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())