update

Author: SilverRainZ

docs/index.rst

@@ -10,7 +10,7 @@ sphinxnotes-data
 FooBar
 ======
 
-.. data.autobj::
+.. data::
    :color:
    :size: 1
 

src/sphinxnotes/data/__init__.py

@@ -18,7 +18,7 @@
 from . import meta
 from .data import Field, Schema
 from .template import Template, Phase
-from .render import BaseDataDirective, BaseDataRole
+from .render import BaseDataDefineDirective, BaseDataDefineRole
 from .utils.freestyle import FreeStyleDirective, FreeStyleOptionSpec
 from . import preset
 
@@ -62,7 +62,7 @@ def run(self) -> list[nodes.Node]:
         return []
 
 
-class FreeDataRole(BaseDataRole):
+class FreeDataRole(BaseDataDefineRole):
     @override
     def current_template(self) -> Template:
         tmpl = self.env.temp_data.get(TEMPLATE_KEY, preset.Role.template())
@@ -74,7 +74,7 @@ def current_schema(self) -> Schema:
         return cast(Schema, schema)
 
 
-class FreeDataDirective(BaseDataDirective, FreeStyleDirective):
+class FreeDataDirective(BaseDataDefineDirective, FreeStyleDirective):
     optional_arguments = 1
     has_content = True
 
@@ -116,7 +116,7 @@ def setup(app: Sphinx):
     app.add_directive('data.tmpl', TemplateDirective)
     app.add_directive('data.template', TemplateDirective)
     app.add_directive('data.schema', SchemaDirective)
-    app.add_directive('data.obj', FreeDataDirective)
+    app.add_directive('data', FreeDataDirective)
 
     app.add_role('data', FreeDataRole())
 

src/sphinxnotes/data/data.py

@@ -1,11 +1,12 @@
 from __future__ import annotations
-from typing import Any, Callable, Generator, Literal as Lit, TYPE_CHECKING, Self
+from typing import TYPE_CHECKING
 import re
-from dataclasses import dataclass, asdict, field as datacls_field
-import hashlib
-import pickle
+from dataclasses import dataclass, asdict, field as dataclass_field
 from ast import literal_eval
 
+if TYPE_CHECKING:
+    from typing import Any, Callable, Generator, Self, Literal as Lit
+
 
 #########################################
 # Basic classes: Value, Form, Flag, ... #
@@ -19,7 +20,7 @@
 class ValueWrapper:
     v: Value
 
-    def as_value(self) -> PlainValue | None:
+    def as_plain(self) -> PlainValue | None:
         if self.v is None:
             return None
         if isinstance(self.v, list):
@@ -28,6 +29,9 @@ def as_value(self) -> PlainValue | None:
             return self.v[0]
         return self.v
 
+    def as_str(self) -> str | None:
+        return str(self.as_plain())
+
     def as_list(self) -> list[PlainValue]:
         if self.v is None:
             return []
@@ -36,8 +40,13 @@ def as_list(self) -> list[PlainValue]:
         else:
             return [self.v]
 
-    def as_str(self) -> str | None:
-        return str(self.as_value())
+    def as_str_list(self) -> list[str]:
+        if self.v is None:
+            return []
+        elif isinstance(self.v, list):
+            return [str(x) for x in self.v]
+        else:
+            return [str(self.v)]
 
 
 @dataclass(frozen=True)
@@ -151,31 +160,25 @@ class RawData:
 
 
 @dataclass
-class ParsedData:
+class Data:
     name: Value
     attrs: dict[str, Value]
     content: Value
 
     def ascontext(self) -> dict[str, Any]:
         return asdict(self)
 
-    @property
     def title(self) -> str | None:
         return ValueWrapper(self.name).as_str()
 
-    @property
-    def hexdigest(self) -> str:
-        return hashlib.sha1(pickle.dumps(self)).hexdigest()[:7]
-
-
 @dataclass
 class Field:
     #: Type of element.
     etype: type = str
     #: Type of container (if the field holds multiple values).
     ctype: type | None = None
     #: Flags of field.
-    flags: dict[str, Value] = datacls_field(default_factory=dict)
+    flags: dict[str, Value] = dataclass_field(default_factory=dict)
 
     # Type hints for builtin flags.
     if TYPE_CHECKING:
@@ -386,7 +389,7 @@ def _parse_single(
         except Exception as e:
             raise ValueError(f'parsing {field[0]}: {e}')
 
-    def parse(self, data: RawData) -> ParsedData:
+    def parse(self, data: RawData) -> Data:
         if data.name:
             name = self._parse_single(('name', self.name), data.name)
         else:
@@ -409,25 +412,36 @@ def parse(self, data: RawData) -> ParsedData:
         else:
             content = None
 
-        return ParsedData(name, attrs, content)
+        return Data(name, attrs, content)
+
+    def fields(self, pred: Callable[[Field], bool] | None = None) -> Generator[tuple[str, Field]]:
+        def ok(f: Field) -> bool:
+            return not pred or pred(f)
+
+        if self.name and ok(self.name):
+            yield 'name', self.name
+
+        for name, field in self.attrs.items():
+            if ok(field):
+                yield name, field
+
+        if self.content and ok(self.content):
+            yield 'content', self.content
+
 
     def items(
-        self, data: ParsedData, pred=Callable[[Field], bool]
+        self, data: Data, pred: Callable[[Field], bool] | None = None
     ) -> Generator[tuple[str, Field, Value]]:
         def ok(f: Field) -> bool:
             return not pred or pred(f)
 
         if self.name and ok(self.name):
             yield 'name', self.name, data.name
 
-        if isinstance(self.attrs, Field) and ok(self.attrs):
-            for name, val in data.attrs.items():
-                yield name, self.attrs, val
-        else:
-            for name, field in self.attrs.items():
-                if not ok(field):
-                    continue
-                yield name, field, data.attrs.get(name)
+        for name, field in self.attrs.items():
+            if not ok(field):
+                continue
+            yield name, field, data.attrs.get(name)
 
         if self.content and ok(self.content):
             yield 'content', self.content, data.content

src/sphinxnotes/data/extra_contexts.py

@@ -25,9 +25,9 @@ def markup(v: SphinxDirective | SphinxRole | nodes.Element) -> dict[str, Any]:
     return ctx
 
 
-def doctree(v: SphinxDirective | SphinxRole | nodes.Element) -> dict[str, Any]:
+def doctree(v: SphinxDirective | SphinxRole | nodes.Node) -> dict[str, Any]:
     ctx = {}
-    if isinstance(v, nodes.Element):
+    if isinstance(v, nodes.Node):
         ctx['_doc'] = proxy(find_current_document(v))
         ctx['_section'] = proxy(find_current_section(v))
     else: