diff --git a/src/pytest_markdown_docs/plugin.py b/src/pytest_markdown_docs/plugin.py
index 31f2453..4aa0283 100644
--- a/src/pytest_markdown_docs/plugin.py
+++ b/src/pytest_markdown_docs/plugin.py
@@ -35,7 +35,7 @@ class FenceSyntax(Enum):
@dataclass
class FenceTest:
- code_block: str
+ source: str
fixture_names: typing.List[str]
start_line: int
@@ -47,6 +47,19 @@ class ObjectTest:
fence_test: FenceTest
+def get_docstring_start_line(obj) -> int:
+ # Get the source lines and the starting line number of the object
+ source_lines, start_line = inspect.getsourcelines(obj)
+
+ # Find the line in the source code that starts with triple quotes (""" or ''')
+ for idx, line in enumerate(source_lines):
+ line = line.strip()
+ if line.startswith(('"""', "'''")):
+ return start_line + idx # Return the starting line number
+
+ return None # Docstring not found in source
+
+
class MarkdownInlinePythonItem(pytest.Item):
def __init__(
self,
@@ -55,7 +68,6 @@ def __init__(
code: str,
fixture_names: typing.List[str],
start_line: int,
- fake_line_numbers: bool,
) -> None:
super().__init__(name, parent)
self.add_marker(MARKER_NAME)
@@ -63,7 +75,6 @@ def __init__(
self.obj = None
self.user_properties.append(("code", code))
self.start_line = start_line
- self.fake_line_numbers = fake_line_numbers
self.fixturenames = fixture_names
self.nofuncargs = True
@@ -115,61 +126,47 @@ def repr_failure(
excinfo: ExceptionInfo[BaseException],
style=None,
):
- rawlines = self.code.split("\n")
+ rawlines = self.code.rstrip("\n").split("\n")
# custom formatted traceback to translate line numbers and markdown files
traceback_lines = []
stack_summary = traceback.StackSummary.extract(traceback.walk_tb(excinfo.tb))
start_capture = False
- start_line = 0 if self.fake_line_numbers else self.start_line
+ start_line = self.start_line
for frame_summary in stack_summary:
if frame_summary.filename == str(self.path):
- lineno = (frame_summary.lineno or 0) + start_line
- start_capture = (
- True # start capturing frames the first time we enter user code
- )
- line = (
- rawlines[frame_summary.lineno - 1]
- if frame_summary.lineno is not None
- and 1 <= frame_summary.lineno <= len(rawlines)
- else ""
- )
- else:
- lineno = frame_summary.lineno or 0
- line = frame_summary.line or ""
+ # start capturing frames the first time we enter user code
+ start_capture = True
if start_capture:
+ lineno = frame_summary.lineno
+ line = frame_summary.line
linespec = f"line {lineno}"
- if self.fake_line_numbers:
- linespec = f"code block line {lineno}*"
-
traceback_lines.append(
f""" File "{frame_summary.filename}", {linespec}, in {frame_summary.name}"""
)
traceback_lines.append(f" {line.lstrip()}")
- maxnum = len(str(len(rawlines) + start_line + 1))
+ maxdigits = len(str(len(rawlines)))
+ code_margin = " "
numbered_code = "\n".join(
[
- f"{i:>{maxnum}} {line}"
- for i, line in enumerate(rawlines, start_line + 1)
+ f"{i:>{maxdigits}}{code_margin}{line}"
+ for i, line in enumerate(rawlines[start_line:], start_line + 1)
]
)
pretty_traceback = "\n".join(traceback_lines)
- note = ""
- if self.fake_line_numbers:
- note = ", *-denoted line numbers refer to code block"
- pt = f"""Traceback (most recent call last{note}):
+ pt = f"""Traceback (most recent call last):
{pretty_traceback}
{excinfo.exconly()}"""
return f"""Error in code block:
-```
+{maxdigits * " "}{code_margin}```
{numbered_code}
-```
+{maxdigits * " "}{code_margin}```
{pt}
"""
@@ -179,6 +176,7 @@ def reportinfo(self):
def extract_fence_tests(
markdown_string: str,
+ start_line_offset: int,
markdown_type: str = "md",
fence_syntax: FenceSyntax = FenceSyntax.default,
) -> typing.Generator[FenceTest, None, None]:
@@ -192,7 +190,6 @@ def extract_fence_tests(
if block.type != "fence" or not block.map:
continue
- start_line = block.map[0] + 1 # skip the info line when counting
if fence_syntax == FenceSyntax.superfences:
code_info = parse_superfences_block_info(block.info)
else:
@@ -216,11 +213,14 @@ def extract_fence_tests(
code_options |= extract_options_from_mdx_comment(tokens[i - 2].content)
if lang in ("py", "python", "python3") and "notest" not in code_options:
- code_block = block.content
+ start_line = (
+ start_line_offset + block.map[0] + 1
+ ) # actual code starts on +1 from the "info" line
+ if "continuation" not in code_options:
+ prev = ""
- if "continuation" in code_options:
- code_block = prev + code_block
- start_line = -1 # this disables proper line numbers, TODO: adjust line numbers *per snippet*
+ add_blank_lines = start_line - prev.count("\n")
+ code_block = prev + ("\n" * add_blank_lines) + block.content
fixture_names = [
f[len("fixture:") :] for f in code_options if f.startswith("fixture:")
@@ -291,11 +291,10 @@ def collect(self):
fence_test = object_test.fence_test
yield MarkdownInlinePythonItem.from_parent(
self,
- name=f"{object_test.object_name}[CodeBlock#{object_test.intra_object_index+1}][rel.line:{fence_test.start_line}]",
- code=fence_test.code_block,
+ name=f"{object_test.object_name}[CodeFence#{object_test.intra_object_index+1}][line:{fence_test.start_line}]",
+ code=fence_test.source,
fixture_names=fence_test.fixture_names,
start_line=fence_test.start_line,
- fake_line_numbers=True, # TODO: figure out where docstrings are in file to offset line numbers properly
)
def find_object_tests_recursive(
@@ -304,6 +303,7 @@ def find_object_tests_recursive(
docstr = inspect.getdoc(object)
if docstr:
+ docstring_offset = get_docstring_start_line(object)
obj_name = (
getattr(object, "__qualname__", None)
or getattr(object, "__name__", None)
@@ -311,7 +311,7 @@ def find_object_tests_recursive(
)
fence_syntax = FenceSyntax(self.config.option.markdowndocs_syntax)
for i, fence_test in enumerate(
- extract_fence_tests(docstr, fence_syntax=fence_syntax)
+ extract_fence_tests(docstr, docstring_offset, fence_syntax=fence_syntax)
):
yield ObjectTest(i, obj_name, fence_test)
@@ -335,17 +335,17 @@ def collect(self):
for i, fence_test in enumerate(
extract_fence_tests(
markdown_content,
+ start_line_offset=0,
markdown_type=self.path.suffix.replace(".", ""),
fence_syntax=fence_syntax,
)
):
yield MarkdownInlinePythonItem.from_parent(
self,
- name=f"[CodeBlock#{i+1}][line:{fence_test.start_line}]",
- code=fence_test.code_block,
+ name=f"[CodeFence#{i+1}][line:{fence_test.start_line}]",
+ code=fence_test.source,
fixture_names=fence_test.fixture_names,
start_line=fence_test.start_line,
- fake_line_numbers=fence_test.start_line == -1,
)
diff --git a/tests/conftest.py b/tests/conftest.py
index c6481d5..b5fb4d7 100644
--- a/tests/conftest.py
+++ b/tests/conftest.py
@@ -1 +1,10 @@
+from pathlib import Path
+
+import pytest
+
pytest_plugins = ["pytester"]
+
+
+@pytest.fixture()
+def support_dir():
+ return Path(__file__).parent / "support"
diff --git a/tests/plugin_test.py b/tests/plugin_test.py
index a6f540e..d89d669 100644
--- a/tests/plugin_test.py
+++ b/tests/plugin_test.py
@@ -1,4 +1,7 @@
import re
+
+from _pytest.pytester import LineMatcher
+
import pytest_markdown_docs # hack: used for storing a side effect in one of the tests
@@ -122,7 +125,7 @@ def bar():
# we check the traceback vs a regex pattern since the file paths can change
expected_output_pattern = r"""
Error in code block:
-```
+ ```
4 def foo\(\):
5 raise Exception\("doh"\)
6
@@ -130,8 +133,7 @@ def bar():
8 foo\(\)
9
10 foo\(\)
-11
-```
+ ```
Traceback \(most recent call last\):
File ".*/test_traceback.md", line 10, in <module>
foo\(\)
@@ -391,3 +393,41 @@ def simple():
)
result = testdir.runpytest("--markdown-docs", "--markdown-docs-syntax=superfences")
result.assert_outcomes(passed=2)
+
+
+def test_error_origin_after_docstring_traceback(testdir, support_dir):
+ sample_file = support_dir / "docstring_error_after.py"
+ testdir.makepyfile(**{sample_file.stem: sample_file.read_text()})
+ result = testdir.runpytest("-v", "--markdown-docs")
+
+ data: LineMatcher = result.stdout
+ data.re_match_lines(
+ [
+ r"Traceback \(most recent call last\):",
+ r'\s*File ".*/docstring_error_after.py", line 5, in <module>',
+ r"\s*docstring_error_after.error_after\(\)",
+ r'\s*File ".*/docstring_error_after.py", line 10, in error_after',
+ r'\s*raise Exception\("bar"\)',
+ r"\s*Exception: bar",
+ ],
+ consecutive=True,
+ )
+
+
+def test_error_origin_before_docstring_traceback(testdir, support_dir):
+ sample_file = support_dir / "docstring_error_before.py"
+ testdir.makepyfile(**{sample_file.stem: sample_file.read_text()})
+ result = testdir.runpytest("-v", "--markdown-docs")
+
+ data: LineMatcher = result.stdout
+ data.re_match_lines(
+ [
+ r"Traceback \(most recent call last\):",
+ r'\s*File ".*/docstring_error_before.py", line 9, in <module>',
+ r"\s*docstring_error_before.error_before\(\)",
+ r'\s*File ".*/docstring_error_before.py", line 2, in error_before',
+ r'\s*raise Exception\("foo"\)',
+ r"\s*Exception: foo",
+ ],
+ consecutive=True,
+ )
diff --git a/tests/support/docstring_error_after.py b/tests/support/docstring_error_after.py
new file mode 100644
index 0000000..34a9f0e
--- /dev/null
+++ b/tests/support/docstring_error_after.py
@@ -0,0 +1,11 @@
+def func():
+ """
+ ```python
+ import docstring_error_after
+ docstring_error_after.error_after()
+ ```
+ """
+
+
+def error_after():
+ raise Exception("bar")