fix: add snapshot, ensure original render tests pass again

Author: machow

quartodoc/renderers/md_renderer.py

@@ -65,14 +65,14 @@ def __init__(
         show_signature_annotations: bool = False,
         display_name: str = "relative",
         hook_pre=None,
-        use_interlinks=False,
+        render_interlinks=False,
     ):
         self.header_level = header_level
         self.show_signature = show_signature
         self.show_signature_annotations = show_signature_annotations
         self.display_name = display_name
         self.hook_pre = hook_pre
-        self.use_interlinks = use_interlinks
+        self.render_interlinks = render_interlinks
 
         self.crnt_header_level = self.header_level
 
@@ -124,7 +124,10 @@ def render_annotation(self, el: None) -> str:
     def render_annotation(self, el: expr.Name) -> str:
         # TODO: maybe there is a way to get tabulate to handle this?
         # unescaped pipes screw up table formatting
-        return f"[{sanitize(el.source)}](`{el.full}`)"
+        if self.render_interlinks:
+            return f"[{el.source}](`{el.full}`)"
+        
+        return el.source
 
     @dispatch
     def render_annotation(self, el: expr.Expression) -> str:
@@ -468,7 +471,7 @@ def render(self, el: ds.DocstringSectionAttributes):
     def render(self, el: ds.DocstringAttribute):
         row = [
             sanitize(el.name),
-            self.render_annotation(el.annotation),
+            sanitize(self.render_annotation(el.annotation)),
             sanitize(el.description or "", allow_markdown=True),
         ]
         return row

quartodoc/tests/__snapshots__/test_renderers.ambr

@@ -1,4 +1,11 @@
 # serializer version: 1
+# name: test_render_annotations_complex
+  '''
+  # quartodoc.tests.example_signature.a_complex_signature { #quartodoc.tests.example_signature.a_complex_signature }
+  
+  `tests.example_signature.a_complex_signature(x)`
+  '''
+# ---
 # name: test_render_doc_class[embedded]
   '''
   # quartodoc.tests.example_class.C { #quartodoc.tests.example_class.C }
@@ -12,10 +19,10 @@
 
   ## Parameters
 
-  | Name   | Type         | Description          | Default    |
-  |--------|--------------|----------------------|------------|
-  | `x`    | [str](`str`) | Uses signature type. | _required_ |
-  | `y`    | [int](`int`) | Uses manual type.    | _required_ |
+  | Name   | Type   | Description          | Default    |
+  |--------|--------|----------------------|------------|
+  | `x`    | str    | Uses signature type. | _required_ |
+  | `y`    | int    | Uses manual type.    | _required_ |
 
   ## Attributes
 
@@ -51,10 +58,10 @@
 
   ## Parameters
 
-  | Name   | Type         | Description          | Default    |
-  |--------|--------------|----------------------|------------|
-  | `x`    | [str](`str`) | Uses signature type. | _required_ |
-  | `y`    | [int](`int`) | Uses manual type.    | _required_ |
+  | Name   | Type   | Description          | Default    |
+  |--------|--------|----------------------|------------|
+  | `x`    | str    | Uses signature type. | _required_ |
+  | `y`    | int    | Uses manual type.    | _required_ |
 
   ## Attributes
 
@@ -87,11 +94,11 @@
 
   ## Attributes
 
-  | Name   | Type             | Description         |
-  |--------|------------------|---------------------|
-  | x      | [str](`str`)     | Uses signature type |
-  | y      | [int](`int`)     | Uses manual type    |
-  | z      | [float](`float`) | Defined in init     |
+  | Name   | Type   | Description         |
+  |--------|--------|---------------------|
+  | x      | str    | Uses signature type |
+  | y      | int    | Uses manual type    |
+  | z      | float  | Defined in init     |
   '''
 # ---
 # name: test_render_doc_module[embedded]

quartodoc/tests/example_signature.py

@@ -22,3 +22,11 @@ def early_args(x, *args, a, b=2, **kwargs):
 
 def late_args(x, a, b=2, *args, **kwargs):
     ...
+
+
+class C:
+    ...
+
+
+def a_complex_signature(x: "list[C | int | None]"):
+    ...

quartodoc/tests/test_renderers.py

@@ -19,14 +19,14 @@ def test_render_param_kwargs(renderer):
 
 
 def test_render_param_kwargs_annotated():
-    renderer = MdRenderer()
+    renderer = MdRenderer(show_signature_annotations=True)
     f = get_object("quartodoc.tests.example_signature.yes_annotations")
 
     res = renderer.render(f.parameters)
 
     assert (
         res
-        == "a: int, b: int = 1, *args: list\\[str\\], c: int, d: int, **kwargs: dict\\[str, str\\]"
+        == "a: int, b: int = 1, *args: list\[str\], c: int, d: int, **kwargs: dict\[str, str\]"
     )
 
 
@@ -94,14 +94,14 @@ def test_render_doc_attribute(renderer):
     attr = ds.DocstringAttribute(
         name="abc",
         description="xyz",
-        annotation=exp.Expression(exp.Name("Optional[]", full="Optional")),
+        annotation=exp.Expression(exp.Name("Optional", full="Optional"), "[", "]"),
         value=1,
     )
 
     res = renderer.render(attr)
     print(res)
 
-    assert res == ["abc", r"[Optional\[\]](`Optional`)", "xyz"]  # noqa
+    assert res == ["abc", r"Optional\[\]", "xyz"]
 
 
 @pytest.mark.parametrize("children", ["embedded", "flat"])
@@ -112,6 +112,14 @@ def test_render_doc_module(snapshot, renderer, children):
     assert res == snapshot
 
 
+def test_render_annotations_complex(snapshot):
+    renderer = MdRenderer(render_interlinks=True)
+    bp = blueprint(Auto(name="quartodoc.tests.example_signature.a_complex_signature"))
+    res = renderer.render(bp)
+
+    assert res == snapshot
+
+
 @pytest.mark.parametrize("children", ["embedded", "flat"])
 def test_render_doc_class(snapshot, renderer, children):
     bp = blueprint(Auto(name="quartodoc.tests.example_class.C", children=children))