Fix definition list

Previously, definition list item terms were emitted to the AST as
a RefRole (incorrect) child, leaving the term field of the
DefinitionListItem node empty.

Author: i80and

CHANGELOG.md

@@ -11,6 +11,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Support for deprecated versions (DOP-908).
 
+### Fixed
+
+- Definition list AST format.
+
 ## [v0.4.3] - 2020-04-15
 
 ### Added

snooty/eventparser.py

@@ -62,6 +62,10 @@ def consume(self, d: Iterable[Tuple[FileId, Page]]) -> None:
     def _iterate(self, d: n.Node, filename: FileId) -> None:
         self._on_object_enter_event(d, filename)
         if isinstance(d, n.Parent):
+            if isinstance(d, n.DefinitionListItem):
+                for child in d.term:
+                    self._iterate(child, filename)
+
             for child in d.children:
                 self._iterate(child, filename)
         self._on_object_exit_event(d, filename)

snooty/n.py

@@ -203,7 +203,12 @@ class Heading(Parent[InlineNode]):
 class DefinitionListItem(Parent[Node]):
     __slots__ = ("term",)
     type = "definitionListItem"
-    term: List[InlineNode]
+    term: MutableSequence[InlineNode]
+
+    def verify(self) -> None:
+        super().verify()
+        for part in self.term:
+            part.verify()
 
 
 @dataclass

snooty/parser.py

@@ -62,6 +62,19 @@
 logger = logging.getLogger(__name__)
 
 
+@dataclass
+class _DefinitionListTerm(n.InlineParent):
+    """A private node used for internal book-keeping that should not be exported to the AST."""
+
+    __slots__ = ()
+    type = "definition_list_term"
+
+    def verify(self) -> None:
+        assert (
+            False
+        ), f"{self.__class__.__name__} is private and should have been removed from AST"
+
+
 class PendingLiteralInclude(PendingTask):
     """Transform a literal-include directive AST node into a code node."""
 
@@ -374,7 +387,7 @@ def dispatch_visit(self, node: docutils.nodes.Node) -> None:
         elif isinstance(node, rstparser.directive_argument):
             self.state.append(n.DirectiveArgument((line,), []))
         elif isinstance(node, docutils.nodes.term):
-            self.state.append(n.RefRole((line,), [], "std", "term", "", "", None, None))
+            self.state.append(_DefinitionListTerm((line,), []))
         elif isinstance(node, docutils.nodes.line_block):
             self.state.append(n.LineBlock((line,), []))
         elif isinstance(node, docutils.nodes.line):
@@ -398,6 +411,14 @@ def dispatch_departure(self, node: docutils.nodes.Node) -> None:
         popped = self.state.pop()
 
         top_of_state = self.state[-1]
+
+        if isinstance(popped, _DefinitionListTerm):
+            assert isinstance(
+                top_of_state, n.DefinitionListItem
+            ), "Definition list terms must be children of definition list items"
+            top_of_state.term = popped.children
+            return
+
         if not isinstance(top_of_state, NO_CHILDREN):
             if isinstance(top_of_state, n.Parent):
                 top_of_state.children.append(popped)

snooty/test_parser.py

@@ -1149,3 +1149,40 @@ def test_problematic() -> None:
     page.finish(diagnostics)
     assert len(diagnostics) == 1
     check_ast_testing_string(page.ast, "<root><paragraph></paragraph></root>")
+
+
+def test_definition_list() -> None:
+    path = ROOT_PATH.joinpath(Path("test.rst"))
+    project_config = ProjectConfig(ROOT_PATH, "", source="./")
+    parser = rstparser.Parser(project_config, JSONVisitor)
+
+    page, diagnostics = parse_rst(
+        parser,
+        path,
+        """
+A term
+  A definition for this term.
+
+``Another term``
+  A definition for *THIS* term.""",
+    )
+
+    assert not diagnostics
+
+    check_ast_testing_string(
+        page.ast,
+        """
+<root>
+    <definitionList>
+        <definitionListItem>
+            <term><text>A term</text></term>
+            <paragraph><text>A definition for this term.</text></paragraph>
+        </definitionListItem>
+        <definitionListItem>
+            <term><literal><text>Another term</text></literal></term>
+            <paragraph><text>A definition for </text><emphasis><text>THIS</text></emphasis><text> term.</text></paragraph>
+        </definitionListItem>
+    </definitionList>
+</root>
+""",
+    )

snooty/util_test.py

@@ -29,9 +29,11 @@ def ast_to_testing_string(ast: Any) -> str:
     attr_pairs = [
         (k, v)
         for k, v in ast.items()
-        if k not in ("argument", "value", "children", "type", "position", "options")
+        if k
+        not in ("argument", "term", "value", "children", "type", "position", "options")
         and v
     ]
+
     attr_pairs.extend((k, v) for k, v in ast.get("options", {}).items())
     attrs = " ".join('{}="{}"'.format(k, escape(str(v))) for k, v in attr_pairs)
     contents = (
@@ -47,6 +49,15 @@ def ast_to_testing_string(ast: Any) -> str:
         contents = (
             "".join(ast_to_testing_string(part) for part in ast["argument"]) + contents
         )
+
+    if "term" in ast:
+        contents = (
+            "<term>"
+            + "".join(ast_to_testing_string(part) for part in ast["term"])
+            + "</term>"
+            + contents
+        )
+
     return "<{}{}>{}</{}>".format(
         ast["type"], " " + attrs if attrs else "", contents, ast["type"]
     )