Check even more line reporting

Refs: executablebooks/MyST-Parser#1048

Author: kdeldycke

click_extra/sphinx.py

@@ -260,6 +260,9 @@ def run_example(self, directive: SphinxDirective) -> list[str]:
                         doc_lineno = (
                             directive.lineno + directive.content_offset + python_lineno
                         )
+                        # XXX MyST absolute error line reporting is broken in some
+                        # situations, see:
+                        # https://github.com/executablebooks/MyST-Parser/pull/1048
                     else:
                         # In rST, the content offset is the absolute position at which
                         # the source code starts in the document.

tests/test_sphinx.py

@@ -187,7 +187,7 @@ class DirectiveTestCase:
     example_block: str | None = None
     run_block: str | None = None
     document: str | None = None
-    html_matches: Sequence[str] = None
+    html_matches: Sequence[str] | None = None
 
     def __post_init__(self):
         self.html_matches = self.html_matches or tuple()
@@ -379,7 +379,7 @@ def simple_print():
 
 SHOW_SOURCE_TEST_CASE = DirectiveTestCase(
     # Test that :show-source: option shows source code in click:run directive.
-    name="show_source_",
+    name="show_source",
     example_block="""
         from click import command, echo
 
@@ -674,7 +674,7 @@ def bad_format():
 
         .. click:run::
 
-            invoke(bad_format, [])
+            invoke(bad_format)
     """)
 
     # RST should fail to parse this malformed directive.
@@ -809,44 +809,26 @@ def cmd2():
         (
             RST,
             """\
-            .. click:example::
-
-                from click import command, echo
-
-                @command
-                def hello():
-                    echo("Hello World!")
-
             .. click:run::
 
                 # This should fail due to variable conflict.
                 {var_name} = "Do not overwrite me!"
-                result = invoke(hello)
             """,
-            9,
-            12,
+            1,
+            4,
         ),
         (
             MYST,
             """\
-            ```{{click:example}}
-            from click import command, echo
-
-            @command
-            def hello():
-                echo("Hello World!")
-            ```
-
             ```{{click:run}}
             # This should fail due to variable conflict.
             {var_name} = "Do not overwrite me!"
-            result = invoke(hello)
             ```
             """,
-            9,
-            11,
+            1,
+            3,
         ),
-        # Check proper line number reporting with preceding blank lines.
+        # Check proper line number reporting with preceding lines.
         (
             RST,
             """
@@ -893,13 +875,16 @@ def hello():
             9 + 4,
             11 + 4,
         ),
+        # Check proper line number reporting with blank lines within the directive.
         (
             RST,
             """\
             .. click:run::
 
                 # This should fail due to variable conflict.
                 {var_name} = "Do not overwrite me!"
+
+
             """,
             1,
             4,
@@ -910,6 +895,8 @@ def hello():
             ```{{click:run}}
             # This should fail due to variable conflict.
             {var_name} = "Do not overwrite me!"
+
+
             ```
             """,
             1,
@@ -966,7 +953,32 @@ def hello():
             1,
             4,
         ),
-        # Options should not affect line numbering.
+        (
+            RST,
+            """\
+            .. click:run::
+                :linenos:
+                :lineno-start: 10
+
+                # This should fail due to variable conflict.
+                {var_name} = "Do not overwrite me!"
+            """,
+            1,
+            6,
+        ),
+        (
+            MYST,
+            """\
+            ```{{click:run}}
+            :linenos:
+            :lineno-start: 10
+            # This should fail due to variable conflict.
+            {var_name} = "Do not overwrite me!"
+            ```
+            """,
+            1,
+            5,
+        ),
         (
             RST,
             """\
@@ -995,6 +1007,42 @@ def hello():
             1,
             6,
         ),
+        (
+            RST,
+            """\
+            .. click:run::
+                :linenos:
+
+                # This should fail due to variable conflict.
+                {var_name} = "Do not overwrite me!"
+
+
+
+            """,
+            1,
+            5,
+        ),
+        pytest.param(
+            MYST,
+            """\
+            ```{{click:run}}
+            :linenos:
+            # This should fail due to variable conflict.
+            {var_name} = "Do not overwrite me!"
+
+
+
+            ```
+            """,
+            1,
+            4,
+            marks=pytest.mark.xfail(
+                reason="MyST line reporting is off: "
+                "https://github.com/executablebooks/MyST-Parser/pull/1048",
+                # This is going to fail unless MyST is fixed upstream.
+                strict=True,
+            ),
+        ),
     ],
     indirect=["sphinx_app"],
 )