refactor: Split render to multiple modules

Author: SilverRainZ

docs/index.rst

@@ -46,14 +46,22 @@ 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 }} 
 
 .. data:: Shengyu Zhang
    :github: SilverRainZ
    :homepage: https://silverrainz.me/
 
+.. template::
+
+   I am an inline *{{ content }}*
+
+:data:`text`
+
+:pep:`abc`
+
 .. INTRODUCTION END
 
 Getting Started

src/sphinxnotes/data/__init__.py

@@ -23,20 +23,17 @@
     Field,
     Schema,
 )
-from .template import Phase, Template
 from .render import (
-    Host,
-    pending_node,
-    rendered_node,
-    BaseDataDefiner,
+    pending_data,
+    rendered_data,
     BaseDataDefineRole,
     BaseDataDefineDirective,
     StrictDataDefineDirective,
-    ExtraContextRegistry,
-    EXTRACTX_REGISTRY,
 )
+from .render.template import Template
+from .render.renderer import Host
+from .render.extractx import ExtraContextRegistry, ExtraContextGenerator
 from .config import Config
-from . import extractx
 
 if TYPE_CHECKING:
     from sphinx.application import Sphinx
@@ -56,13 +53,11 @@
     'Phase',
     'Template',
     'Host',
-    'pending_node',
-    'rendered_node',
-    'rendered_node',
-    'BaseDataDefiner',
+    'pending_data',
+    'rendered_data',
+    'rendered_data',
     'BaseDataDefineRole',
     'BaseDataDefineDirective',
-    'BaseDataDefineDirective',
     'StrictDataDefineDirective',
 ]
 
@@ -77,8 +72,8 @@ def data(self) -> DataRegistry:
         return DATA_REGISTRY
 
     @property
-    def extractx(cls) -> ExtraContextRegistry:
-        return EXTRACTX_REGISTRY
+    def extra_context(cls) -> ExtraContextRegistry:
+        return ExtraContextGenerator.registry
 
 
 REGISTRY = Registry()
@@ -87,7 +82,8 @@ def extractx(cls) -> ExtraContextRegistry:
 def setup(app: Sphinx):
     meta.pre_setup(app)
 
-    from . import config, template, render, adhoc
+    from . import config, render, adhoc
+    from .render import template
 
     config.setup(app)
     template.setup(app)

src/sphinxnotes/data/adhoc.py

@@ -22,8 +22,9 @@
 from sphinx.util.docutils import SphinxDirective
 
 from .data import Field, Schema
-from .template import Template, Phase
-from .render import BaseDataDefineDirective
+from .render.template import Template
+from .render.nodes import Phase
+from .render import BaseDataDefineDirective, BaseDataDefineRole
 from .utils.freestyle import FreeStyleDirective, FreeStyleOptionSpec
 from . import preset
 
@@ -35,19 +36,20 @@
 SCHEMA_KEY = 'sphinxnotes-data:schema'
 
 
+def phase_option_spec(arg):
+    choice = directives.choice(arg, [x.value for x in Phase])
+    return Phase[choice.title()]
+
+
 class TemplateDefineDirective(SphinxDirective):
     option_spec = {
-        'on': Phase.option_spec,
+        'on': phase_option_spec,
         'debug': directives.flag,
     }
     has_content = True
 
     def run(self) -> list[nodes.Node]:
-        self.env.temp_data[TEMPLATE_KEY] = Template(
-            text='\n'.join(self.content),
-            phase=self.options.get('on', Phase.default()),
-            debug='debug' in self.options,
-        )
+        self.env.temp_data[TEMPLATE_KEY] = Template('\n'.join(self.content))
 
         return []
 
@@ -68,12 +70,7 @@ def run(self) -> list[nodes.Node]:
 
         return []
 
-
-if TYPE_CHECKING:
-    ...
-
-
-class FreeDataDefineDirective(BaseDataDefineDirective, FreeStyleDirective):
+class AdhocDataDefineDirective(BaseDataDefineDirective, FreeStyleDirective):
     optional_arguments = 1
     has_content = True
 
@@ -88,7 +85,20 @@ def current_schema(self) -> Schema:
         return cast(Schema, schema)
 
 
+class AdhocDataDefineRole(BaseDataDefineRole):
+    @override
+    def current_template(self) -> Template:
+        tmpl = self.env.temp_data.get(TEMPLATE_KEY, preset.Directive.template())
+        return cast(Template, tmpl)
+
+    @override
+    def current_schema(self) -> Schema:
+        schema = self.env.temp_data.get(SCHEMA_KEY, preset.Directive.schema())
+        return cast(Schema, schema)
+
 def setup(app: Sphinx):
     app.add_directive('template', TemplateDefineDirective)
     app.add_directive('schema', SchemaDefineDirective)
-    app.add_directive('data', FreeDataDefineDirective)
+    app.add_directive('data', AdhocDataDefineDirective)
+
+    app.add_role('data', AdhocDataDefineRole())

src/sphinxnotes/data/data.py

@@ -97,7 +97,7 @@ def _bool_conv(v: str | None) -> bool:
     if v in ('false', 'no', '0', 'off', 'n', None):
         return False
     # Same to :meth:`directives.flag`.
-    raise ValueError(f'no argument is allowed; "{v}" supplied')
+    raise ValueError(f'No argument is allowed; "{v}" supplied')
 
 
 def _str_conv(v: str) -> str:
@@ -172,7 +172,7 @@ def add_form(
         self, name: str, ctype: type, sep: str, aliases: list[str] = []
     ) -> None:
         if ctype not in self.ctypes:
-            raise ValueError(f'unsupported type: "{ctype}". available: {self.ctypes}')
+            raise ValueError(f'Unsupported type: "{ctype}". Available: {self.ctypes}')
 
         form = Form(ctype, sep)
 
@@ -297,7 +297,7 @@ def parse(self, rawval: str | None) -> Value:
         if rawval is None:
             if self.required:
                 # Same to :meth:`directives.unchanged_required`.
-                raise ValueError('argument required but none supplied')
+                raise ValueError('Argument required but none supplied')
             if self.ctype:
                 # Return a empty container when a None value is optional.
                 return self.ctype()
@@ -329,7 +329,7 @@ def parse(self, rawval: str | None) -> Value:
 
             return self.ctype(elems)
         except ValueError as e:
-            raise ValueError(f"failed to parse '{rawval}' as {self.etype}: {e}") from e
+            raise ValueError(f"Failed to parse '{rawval}' as {self.etype}: {e}") from e
 
     def __getattr__(self, name: str) -> Value:
         if name in self.flags:
@@ -382,13 +382,13 @@ def _apply_modifier(self, mod: str):
 
             if etype not in REGISTRY.etypes:
                 raise ValueError(
-                    f'unsupported type: "{etype}". '
-                    f'available: {list(REGISTRY.etypes.keys())}'
+                    f'Unsupported type: "{etype}". '
+                    f'Available: {list(REGISTRY.etypes.keys())}'
                 )
             if form not in REGISTRY.forms:
                 raise ValueError(
-                    f'unsupported form: "{form}". '
-                    f'available: {list(REGISTRY.forms.keys())}'
+                    f'Unsupported form: "{form}". '
+                    f'Available: {list(REGISTRY.forms.keys())}'
                 )
 
             self.field.etype = REGISTRY.etypes[etype]
@@ -407,8 +407,8 @@ def _apply_modifier(self, mod: str):
 
             if optname not in REGISTRY.byopts:
                 raise ValueError(
-                    f'unsupported by-option: "{optname}" by. '
-                    f'available: {list(REGISTRY.byopts.keys())}'
+                    f'Unsupported by-option: "{optname}" by. '
+                    f'Available: {list(REGISTRY.byopts.keys())}'
                 )
 
             flags = self.field.flags
@@ -438,13 +438,13 @@ def _apply_modifier(self, mod: str):
             self.field.flags[opt.name] = not opt.default
             return
 
-        raise ValueError(f"unknown modifier: '{mod}'")
+        raise ValueError(f"Unknown modifier: '{mod}'")
 
     @staticmethod
     def by_option_store_value_error(opt: ByOption) -> ValueError:
         raise ValueError(
-            f'unsupported by-option store: "{opt.store}". '
-            f'available: {ByOptionStore}'  # FIXME:
+            f'Unsupported by-option store: "{opt.store}". '
+            f'Available: {ByOptionStore}'  # FIXME:
         )
 
 
@@ -472,14 +472,14 @@ def _parse_single(
     ) -> Value:
         if field[1] is None and rawval is not None:
             raise ValueError(
-                f'parsing {field[0]}: no argument is allowed; "{rawval}" supplied'
+                f'Parsing {field[0]}: no argument is allowed; "{rawval}" supplied'
             )
 
         try:
             assert field[1] is not None
             return field[1].parse(rawval)
         except Exception as e:
-            raise ValueError(f'parsing {field[0]}: {e}')
+            raise ValueError(f'Parsing {field[0]}: {e}')
 
     def parse(self, data: RawData) -> ParsedData:
         if data.name:
@@ -497,7 +497,7 @@ def parse(self, data: RawData) -> ParsedData:
                 if rawval := rawattrs.pop(key, None):
                     attrs[key] = self._parse_single(('attrs.' + key, field), rawval)
             for key, rawval in rawattrs.items():
-                raise ValueError(f'unknown attr: "{key}"')
+                raise ValueError(f'Unknown attr: "{key}"')
 
         if data.content:
             content = self._parse_single(('content', self.content), data.content)