pytest-markdown-docs 0.4.3__tar.gz → 0.5.1__tar.gz

{pytest_markdown_docs-0.4.3 → pytest_markdown_docs-0.5.1}/PKG-INFO

@@ -1,20 +1,21 @@
 Metadata-Version: 2.1
 Name: pytest-markdown-docs
-Version: 0.4.3
+Version: 0.5.1
 Summary: Run markdown code fences through pytest
 Home-page: https://github.com/modal-com/pytest-markdown-docs
 License: MIT
 Author: Modal Labs
-Requires-Python: >=3.7,<4.0
+Requires-Python: >=3.8,<4.0
 Classifier: Framework :: Pytest
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Requires-Dist: markdown-it-py (>=2.2.0,<2.3.0)
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: markdown-it-py (>=2.2.0,<4.0)
+Requires-Dist: pytest (>=7.0.0)
 Project-URL: Repository, https://github.com/modal-com/pytest-markdown-docs
 Description-Content-Type: text/markdown
 
@@ -171,10 +172,9 @@ Or for fun, you can use this plugin to include testing of the validity of snippe
 ```
 
 ## Known issues
-
-* Only tested with pytest 6.2.5. There seem to be some minor issue with pytest >7 due to changes of some internal functions in pytest, but that should be relatively easy to fix. Contributions are welcome :)
 * Code for docstring-inlined test discovery can probably be done better (similar to how doctest does it). Currently, seems to sometimes traverse into Python's standard library which isn't great...
 * Traceback logic is extremely hacky, wouldn't be surprised if the tracebacks look weird sometimes
   * Line numbers are "wrong" for docstring-inlined snippets (since we don't know where in the file the docstring starts)
   * Line numbers are "wrong" for continuation blocks even in pure markdown files (can be worked out with some refactoring)
-
+* There are probably more appropriate ways to use pytest internal APIs to get more features "for free" - current state of the code is a bit "patch it til' it works".
+* Assertions are not rewritten w/ pretty data structure inspection like they are with regular pytest tests by default

{pytest_markdown_docs-0.4.3 → pytest_markdown_docs-0.5.1}/README.md

@@ -151,9 +151,9 @@ Or for fun, you can use this plugin to include testing of the validity of snippe
 ```
 
 ## Known issues
-
-* Only tested with pytest 6.2.5. There seem to be some minor issue with pytest >7 due to changes of some internal functions in pytest, but that should be relatively easy to fix. Contributions are welcome :)
 * Code for docstring-inlined test discovery can probably be done better (similar to how doctest does it). Currently, seems to sometimes traverse into Python's standard library which isn't great...
 * Traceback logic is extremely hacky, wouldn't be surprised if the tracebacks look weird sometimes
   * Line numbers are "wrong" for docstring-inlined snippets (since we don't know where in the file the docstring starts)
   * Line numbers are "wrong" for continuation blocks even in pure markdown files (can be worked out with some refactoring)
+* There are probably more appropriate ways to use pytest internal APIs to get more features "for free" - current state of the code is a bit "patch it til' it works".
+* Assertions are not rewritten w/ pretty data structure inspection like they are with regular pytest tests by default

{pytest_markdown_docs-0.4.3 → pytest_markdown_docs-0.5.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pytest-markdown-docs"
-version = "0.4.3"
+version = "0.5.1"
 description = "Run markdown code fences through pytest"
 readme = "README.md"
 authors = ["Modal Labs", "Elias Freider <elias@modal.com>"]
@@ -10,8 +10,9 @@ repository = "https://github.com/modal-com/pytest-markdown-docs"
 include = ["LICENSE"]
 
 [tool.poetry.dependencies]
-python = "^3.7"
-markdown-it-py = "~=2.2.0"
+python = "^3.8"
+markdown-it-py = ">=2.2.0, <4.0"
+pytest = ">=7.0.0"
 
 [tool.poetry.plugins]
 
@@ -19,9 +20,12 @@ markdown-it-py = "~=2.2.0"
 "pytest_markdown_docs" = "pytest_markdown_docs.plugin"
 
 [tool.poetry.group.dev.dependencies]
-pytest = "^7.1.2"
-mypy = "^0.971"
-black = "^22.8.0"
+ruff = "^0.2.1"
+mypy = "^1.8.0"
+pre-commit = [
+    {version="*", python=">=3.9.0"}  # pre-commit only available for Python >= 3.9
+]
+pytest = "8.1.0"
 
 [build-system]
 requires = ["poetry-core>=1.1.0"]

{pytest_markdown_docs-0.4.3 → pytest_markdown_docs-0.5.1}/src/pytest_markdown_docs/hooks.py

@@ -2,4 +2,4 @@ import typing
 
 
 def pytest_markdown_docs_globals() -> typing.Dict[str, typing.Any]:
-    pass
+    return {}

{pytest_markdown_docs-0.4.3 → pytest_markdown_docs-0.5.1}/src/pytest_markdown_docs/plugin.py

@@ -9,9 +9,15 @@ import typing
 from _pytest._code import ExceptionInfo
 from _pytest.config.argparsing import Parser
 from _pytest.pathlib import import_path
-
 from pytest_markdown_docs import hooks
-from _pytest.fixtures import FixtureRequest
+
+
+if pytest.version_tuple >= (8, 0, 0):
+    from _pytest.fixtures import TopRequest
+else:
+    # pytest 7 compatible
+    from _pytest.fixtures import FixtureRequest as TopRequest  # type: ignore
+
 
 MARKER_NAME = "markdown-docs"
 
@@ -22,19 +28,19 @@ class MarkdownInlinePythonItem(pytest.Item):
         name: str,
         parent: typing.Union["MarkdownDocstringCodeModule", "MarkdownTextFile"],
         code: str,
-        usefixtures: typing.List[str],
+        fixture_names: typing.List[str],
         start_line: int,
         fake_line_numbers: bool,
     ) -> None:
         super().__init__(name, parent)
         self.add_marker(MARKER_NAME)
         self.code = code
+        self.obj = None
         self.user_properties.append(("code", code))
         self.start_line = start_line
         self.fake_line_numbers = fake_line_numbers
-
-        self.usefixtures = usefixtures
-        self.add_marker(pytest.mark.usefixtures(*usefixtures))
+        self.fixturenames = fixture_names
+        self.nofuncargs = True
 
     def setup(self):
         def func() -> None:
@@ -42,9 +48,9 @@ class MarkdownInlinePythonItem(pytest.Item):
 
         self.funcargs = {}
         self._fixtureinfo = self.session._fixturemanager.getfixtureinfo(
-            node=self, func=func, cls=None, funcargs=False
+            node=self, func=func, cls=None
         )
-        self.fixture_request = FixtureRequest(self, _ispytest=True)
+        self.fixture_request = TopRequest(self, _ispytest=True)
         self.fixture_request._fillfixtures()
 
     def runtest(self):
@@ -55,21 +61,28 @@ class MarkdownInlinePythonItem(pytest.Item):
         for global_set in global_sets:
             all_globals.update(global_set)
 
-        for fixture_name in self.usefixtures:
-            fixture_value = self.fixture_request.getfixturevalue(fixture_name)
-            all_globals[fixture_name] = fixture_value
+        # make sure to evaluate fixtures
+        # this will insert named fixtures into self.funcargs
+        for fixture_name in self._fixtureinfo.names_closure:
+            self.fixture_request.getfixturevalue(fixture_name)
+
+        # Since these are not actual functions with arguments, the only
+        # arguments that should appear in self.funcargs are the filled fixtures
+        for argname, value in self.funcargs.items():
+            if argname not in all_globals:
+                all_globals[argname] = value
 
         try:
             tree = ast.parse(self.code)
         except SyntaxError:
-            return
+            raise
 
         try:
-            # if we don't compile the code, it seems we gate name lookup errors
+            # if we don't compile the code, it seems we get name lookup errors
             # for functions etc. when doing cross-calls across inline functions
             compiled = compile(tree, self.name, "exec", dont_inherit=True)
         except SyntaxError:
-            return
+            raise
 
         exec(compiled, all_globals)
 
@@ -155,14 +168,12 @@ def extract_code_blocks(
 
         lang = code_info[0] if code_info else None
 
-        if lang in ("py", "python", "python3") and not "notest" in code_info:
+        if lang in ("py", "python", "python3") and "notest" not in code_info:
             code_block = block.content
 
             if "continuation" in code_info:
                 code_block = prev + code_block
-                startline = (
-                    -1
-                )  # this disables proper line numbers, TODO: adjust line numbers *per snippet*
+                startline = -1  # this disables proper line numbers, TODO: adjust line numbers *per snippet*
 
             fixture_names = [
                 f[len("fixture:") :] for f in code_info if f.startswith("fixture:")
@@ -193,7 +204,15 @@ def find_object_tests_recursive(
 
 class MarkdownDocstringCodeModule(pytest.Module):
     def collect(self):
-        module = import_path(self.path, root=self.config.rootpath)
+        if pytest.version_tuple >= (8, 1, 0):
+            # consider_namespace_packages is a required keyword argument in pytest 8.1.0
+            module = import_path(
+                self.path, root=self.config.rootpath, consider_namespace_packages=True
+            )
+        else:
+            # but unsupported before 8.1...
+            module = import_path(self.path, root=self.config.rootpath)
+
         for i, (test_code, fixture_names, start_line) in enumerate(
             find_object_tests_recursive(module.__name__, module.__name__, module)
         ):
@@ -201,7 +220,7 @@ class MarkdownDocstringCodeModule(pytest.Module):
                 self,
                 name=f"{self.path}#{i+1}",
                 code=test_code,
-                usefixtures=fixture_names,
+                fixture_names=fixture_names,
                 start_line=start_line,
                 fake_line_numbers=True,  # TODO: figure out where docstrings are in file to offset line numbers properly
             )
@@ -218,18 +237,18 @@ class MarkdownTextFile(pytest.File):
                 self,
                 name=str(self.path),
                 code=code_block,
-                usefixtures=fixture_names,
+                fixture_names=fixture_names,
                 start_line=start_line,
                 fake_line_numbers=start_line == -1,
             )
 
 
 def pytest_collect_file(
-    path,
+    file_path,
     parent,
 ):
     if parent.config.option.markdowndocs:
-        pathlib_path = pathlib.Path(str(path))  # pytest 7/8 compat
+        pathlib_path = pathlib.Path(str(file_path))  # pytest 7/8 compat
         if pathlib_path.suffix == ".py":
             return MarkdownDocstringCodeModule.from_parent(parent, path=pathlib_path)
         elif pathlib_path.suffix in (".md", ".mdx", ".svx"):