pytest-accept 0.2.2__tar.gz → 0.2.4__tar.gz

pytest_accept-0.2.4/LICENSE

@@ -0,0 +1,191 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright
+owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities
+that control, are controlled by, or are under common control with that entity.
+For the purposes of this definition, "control" means (i) the power, direct or
+indirect, to cause the direction or management of such entity, whether by
+contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including
+but not limited to software source code, documentation source, and configuration
+files.
+
+"Object" form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object code,
+generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made
+available under the License, as indicated by a copyright notice that is included
+in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that
+is based on (or derived from) the Work and for which the editorial revisions,
+annotations, elaborations, or other modifications represent, as a whole, an
+original work of authorship. For the purposes of this License, Derivative Works
+shall not include works that remain separable from, or merely link (or bind by
+name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version
+of the Work and any modifications or additions to that Work or Derivative Works
+thereof, that is intentionally submitted to Licensor for inclusion in the Work
+by the copyright owner or by an individual or Legal Entity authorized to submit
+on behalf of the copyright owner. For the purposes of this definition,
+"submitted" means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems, and
+issue tracking systems that are managed by, or on behalf of, the Licensor for
+the purpose of discussing and improving the Work, but excluding communication
+that is conspicuously marked or otherwise designated in writing by the copyright
+owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
+of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+2. Grant of Copyright License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the Work and such
+Derivative Works in Source or Object form.
+
+3. Grant of Patent License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable (except as stated in this section) patent license to make, have
+made, use, offer to sell, sell, import, and otherwise transfer the Work, where
+such license applies only to those patent claims licensable by such Contributor
+that are necessarily infringed by their Contribution(s) alone or by combination
+of their Contribution(s) with the Work to which such Contribution(s) was
+submitted. If You institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work or a
+Contribution incorporated within the Work constitutes direct or contributory
+patent infringement, then any patent licenses granted to You under this License
+for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution.
+
+You may reproduce and distribute copies of the Work or Derivative Works thereof
+in any medium, with or without modifications, and in Source or Object form,
+provided that You meet the following conditions:
+
+You must give any other recipients of the Work or Derivative Works a copy of
+this License; and
+You must cause any modified files to carry prominent notices stating that You
+changed the files; and
+You must retain, in the Source form of any Derivative Works that You distribute,
+all copyright, patent, trademark, and attribution notices from the Source form
+of the Work, excluding those notices that do not pertain to any part of the
+Derivative Works; and
+If the Work includes a "NOTICE" text file as part of its distribution, then any
+Derivative Works that You distribute must include a readable copy of the
+attribution notices contained within such NOTICE file, excluding those notices
+that do not pertain to any part of the Derivative Works, in at least one of the
+following places: within a NOTICE text file distributed as part of the
+Derivative Works; within the Source form or documentation, if provided along
+with the Derivative Works; or, within a display generated by the Derivative
+Works, if and wherever such third-party notices normally appear. The contents of
+the NOTICE file are for informational purposes only and do not modify the
+License. You may add Your own attribution notices within Derivative Works that
+You distribute, alongside or as an addendum to the NOTICE text from the Work,
+provided that such additional attribution notices cannot be construed as
+modifying the License.
+You may add Your own copyright statement to Your modifications and may provide
+additional or different license terms and conditions for use, reproduction, or
+distribution of Your modifications, or for any such Derivative Works as a whole,
+provided Your use, reproduction, and distribution of the Work otherwise complies
+with the conditions stated in this License.
+
+5. Submission of Contributions.
+
+Unless You explicitly state otherwise, any Contribution intentionally submitted
+for inclusion in the Work by You to the Licensor shall be under the terms and
+conditions of this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify the terms of
+any separate license agreement you may have executed with Licensor regarding
+such Contributions.
+
+6. Trademarks.
+
+This License does not grant permission to use the trade names, trademarks,
+service marks, or product names of the Licensor, except as required for
+reasonable and customary use in describing the origin of the Work and
+reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty.
+
+Unless required by applicable law or agreed to in writing, Licensor provides the
+Work (and each Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
+including, without limitation, any warranties or conditions of TITLE,
+NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
+solely responsible for determining the appropriateness of using or
+redistributing the Work and assume any risks associated with Your exercise of
+permissions under this License.
+
+8. Limitation of Liability.
+
+In no event and under no legal theory, whether in tort (including negligence),
+contract, or otherwise, unless required by applicable law (such as deliberate
+and grossly negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special, incidental,
+or consequential damages of any character arising as a result of this License or
+out of the use or inability to use the Work (including but not limited to
+damages for loss of goodwill, work stoppage, computer failure or malfunction, or
+any and all other commercial damages or losses), even if such Contributor has
+been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability.
+
+While redistributing the Work or Derivative Works thereof, You may choose to
+offer, and charge a fee for, acceptance of support, warranty, indemnity, or
+other liability obligations and/or rights consistent with this License. However,
+in accepting such obligations, You may act only on Your own behalf and on Your
+sole responsibility, not on behalf of any other Contributor, and only if You
+agree to indemnify, defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason of your
+accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work
+
+To apply the Apache License to your work, attach the following boilerplate
+notice, with the fields enclosed by brackets "[]" replaced with your own
+identifying information. (Don't include the brackets!) The text should be
+enclosed in the appropriate comment syntax for the file format. We also
+recommend that a file or class name and description of purpose be included on
+the same "printed page" as the copyright notice for easier identification within
+third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

{pytest_accept-0.2.2 → pytest_accept-0.2.4}/PKG-INFO

@@ -1,9 +1,10 @@
 Metadata-Version: 2.4
 Name: pytest-accept
-Version: 0.2.2
+Version: 0.2.4
 Author: Maximilian Roos
 Author-email: Maximilian Roos <m@maxroos.com>
 License-Expression: Apache-2.0
+License-File: LICENSE
 Requires-Dist: astor>=0.8.1
 Requires-Dist: pytest>=7
 Requires-Python: >=3.9, <4
@@ -24,9 +25,6 @@ documented outputs.
 ## Before
 
 ```python
-import re
-
-
 def extract_functions(code):
     return re.findall(r"(\w+)\(", code)
 
@@ -41,8 +39,8 @@ def test_extract_functions():
 ```diff
 def test_extract_functions():
     assert extract_functions("print('hi')") == ["print"]
--    assert extract_functions("sum(map(f, x))") == ["sum"]
-+    assert extract_functions("sum(map(f, x))") == ["sum", "map"]
+-   assert extract_functions("sum(map(f, x))") == ["sum"]
++   assert extract_functions("sum(map(f, x))") == ["sum", "map"]
 ```
 
 pytest-accept is decoupled from the tests it works with — it can be used with
@@ -71,8 +69,8 @@ pytest --accept
 
 - Often it's fairly easy to observe whether something is working by viewing the
   output it produces
-- ...but often output is verbose, and copying and pasting the output into the
-  test is tedious
+- ...but often the output is verbose, and copying and pasting the output into
+  the test is tedious
 - `pytest-accept` does the copying & pasting for you
 - Similarly, lots of folks generally find writing any tests a bit annoying, and
   prefer to develop by "running the code and seeing if it works". This library

{pytest_accept-0.2.2 → pytest_accept-0.2.4}/README.md

@@ -11,9 +11,6 @@ documented outputs.
 ## Before
 
 ```python
-import re
-
-
 def extract_functions(code):
     return re.findall(r"(\w+)\(", code)
 
@@ -28,8 +25,8 @@ def test_extract_functions():
 ```diff
 def test_extract_functions():
     assert extract_functions("print('hi')") == ["print"]
--    assert extract_functions("sum(map(f, x))") == ["sum"]
-+    assert extract_functions("sum(map(f, x))") == ["sum", "map"]
+-   assert extract_functions("sum(map(f, x))") == ["sum"]
++   assert extract_functions("sum(map(f, x))") == ["sum", "map"]
 ```
 
 pytest-accept is decoupled from the tests it works with — it can be used with
@@ -58,8 +55,8 @@ pytest --accept
 
 - Often it's fairly easy to observe whether something is working by viewing the
   output it produces
-- ...but often output is verbose, and copying and pasting the output into the
-  test is tedious
+- ...but often the output is verbose, and copying and pasting the output into
+  the test is tedious
 - `pytest-accept` does the copying & pasting for you
 - Similarly, lots of folks generally find writing any tests a bit annoying, and
   prefer to develop by "running the code and seeing if it works". This library

{pytest_accept-0.2.2 → pytest_accept-0.2.4}/pyproject.toml

@@ -3,13 +3,14 @@ authors = [{ name = "Maximilian Roos", email = "m@maxroos.com" }]
 dependencies = ["astor>=0.8.1", "pytest>=7"]
 requires-python = ">=3.9, <4"
 license = "Apache-2.0"
+license-files = ["LICENSE"]
 readme = "README.md"
-version = "0.2.2"
+version = "0.2.4"
 name = "pytest-accept"
 urls = { homepage = "https://github.com/max-sixty/pytest-accept", repository = "https://github.com/max-sixty/pytest-accept" }
 
 [dependency-groups]
-dev = ["blackdoc", "mypy", "pre-commit", "pytest-xdist>=3.8.0", "ruff"]
+dev = ["pre-commit", "pytest-xdist>=3.8.0", "ruff", "ty"]
 
 [project.entry-points.pytest11]
 accept = "pytest_accept"
@@ -17,7 +18,7 @@ accept = "pytest_accept"
 [tool.pytest.ini_options]
 addopts = ["--strict-config", "--strict-markers", "--doctest-modules"]
 doctest_optionflags = "NORMALIZE_WHITESPACE IGNORE_EXCEPTION_DETAIL ELLIPSIS"
-filterwarnings = ["error:::pytest_accept.*"]
+filterwarnings = ["error"]
 pytester_example_dir = "examples"
 testpaths = ["pytest_accept"]
 
@@ -33,6 +34,9 @@ module-root = ""
 [tool.ruff]
 fix = true
 
+[tool.ruff.format]
+docstring-code-format = true
+
 [tool.ruff.lint]
 ignore = [
   "E402", # module level import at top — too strict in some cases
@@ -47,8 +51,3 @@ select = [
   "I",   # isort
   "UP",  # Pyupgrade
 ]
-
-[tool.mypy]
-files = "."
-# TODO: ideally we would list the modules that aren't yet typed
-ignore_missing_imports = true

{pytest_accept-0.2.2 → pytest_accept-0.2.4}/pytest_accept/__init__.py

@@ -237,8 +237,10 @@ def _apply_doctest_changes(
     result.extend(original[:next_start_line])
 
     for current, next_failure in zip_longest(failures, failures[1:]):
-        # Get the existing indentation from the source line
-        match = re.match(r"\s*", original[next_start_line])
+        # Get indentation from the >>> source line of the current example,
+        # not from next_start_line which may be an empty line (issue #296)
+        source_line_idx = current.test.lineno + current.example.lineno
+        match = re.match(r"\s*", original[source_line_idx])
         existing_indent = match.group() if match else ""
         snapshot_result = _to_doctest_format(current.got)
         indented = textwrap.indent(snapshot_result, prefix=existing_indent)

{pytest_accept-0.2.2 → pytest_accept-0.2.4}/pytest_accept/assert_plugin.py

@@ -17,7 +17,6 @@ containing a failing assertion:
 
 ```python
 def test_x():
-
     assert 1 + 1 == 3
 
     assert 2 == 3
@@ -111,7 +110,7 @@ def _patch_assertion_rewriter():
 
         # Add simple safety check - if there are too many AST nodes, skip wrapping
         # This prevents "too many statically nested blocks" errors in edge cases
-        total_nodes = sum(1 for _ in ast.walk(ast.Module(body=rv)))
+        total_nodes = sum(1 for _ in ast.walk(ast.Module(body=rv, type_ignores=[])))
         if total_nodes > 200:  # Higher threshold - only skip for very complex cases
             # module_path is an internal pytest attribute that may not exist in all versions
             if hasattr(self, "module_path"):
@@ -123,11 +122,14 @@ def _patch_assertion_rewriter():
             # Return original without wrapping to avoid "too many nested blocks"
             return rv
 
+        exception_type = ast.Name(id="AssertionError", ctx=ast.Load())
+        ast.copy_location(exception_type, assert_)
+
         try_except = ast.Try(
             body=rv,
             handlers=[
                 ast.ExceptHandler(
-                    expr=AssertionError,
+                    type=exception_type,
                     name="__pytest_accept_e",
                     body=_ASSERTION_HANDLER,
                 )
@@ -142,7 +144,7 @@ def _patch_assertion_rewriter():
 
         return [try_except]
 
-    AssertionRewriter.visit_Assert = new_visit_assert
+    AssertionRewriter.visit_Assert = new_visit_assert  # type: ignore[method-assign]
 
 
 def __handle_failed_assertion():
@@ -181,7 +183,7 @@ def __handle_failed_assertion_impl(raw_excinfo, session, left):
     line_number_end = line_number_start + len(tb_entry.statement.lines) - 1
     original_location = slice(line_number_start, line_number_end)
 
-    path = tb_entry.path
+    path = Path(tb_entry.path)
     with path.open() as f:
         tree = ast.parse(f.read())
 
@@ -189,18 +191,21 @@ def __handle_failed_assertion_impl(raw_excinfo, session, left):
         if isinstance(item, ast.Assert) and original_location.start == item.lineno:
             # we need to _then_ check that the next compare item's
             # ops[0] is Eq and then replace the comparator[0]
+            test = item.test
+            if not isinstance(test, ast.Compare):
+                continue
             try:
                 assert item.msg is None
-                assert len(item.test.comparators) == 1
-                assert len(item.test.ops) == 1
-                assert isinstance(item.test.ops[0], ast.Eq)
+                assert len(test.comparators) == 1
+                assert len(test.ops) == 1
+                assert isinstance(test.ops[0], ast.Eq)
 
-                ast.literal_eval(item.test.comparators[0])
+                ast.literal_eval(test.comparators[0])
             except Exception:
                 continue
 
             new_assert = copy.copy(item)
-            new_assert.test.comparators[0] = ast.Constant(value=left)
+            test.comparators[0] = ast.Constant(value=left)
 
             # Submit change to unified change collection
             file_changes = session.stash.setdefault(file_changes_key, {})

{pytest_accept-0.2.2 → pytest_accept-0.2.4}/pytest_accept/tests/test_doctest.py

@@ -14,7 +14,6 @@ def add_example():
     >>> pytester = getfixture("pytester")
     >>> if sys.platform == "win32":
     ...     pytest.skip("Paths differ on windows")
-    ...
     >>> pytester.copy_example("add.py")
     PosixPath('.../pytest_accept.tests.test_doctest.add_example0/add.py')
 
@@ -55,7 +54,6 @@ def add_example():
     (For some reason we need to delete the pyc file, TODO: work out why upstream
     >>> for f in pytester.path.glob(r"**/*.pyc"):
     ...     f.unlink()
-    ...
 
     >>> result = pytester.runpytest("--doctest-modules", "--accept")
     =====...==== test session starts ====...====
@@ -86,7 +84,6 @@ def no_overwrite_example():
 
     >>> if sys.platform == "win32":
     ...     pytest.skip("Paths differ on windows")
-    ...
     >>> path = pytester.copy_example("add.py")
 
     Collect the tests, to simulate starting the tests:

pytest_accept-0.2.4/pytest_accept/tests/test_issue_296.py

@@ -0,0 +1,50 @@
+"""Reproduce issue #296: indentation depends on blank line whitespace content"""
+
+
+def test_indentation_with_empty_blank_line(pytester):
+    """When the blank line after >>> has no whitespace, output should still be indented."""
+    # The blank line between >>> and the closing """ has NO trailing spaces
+    test_contents = (
+        "def func():\n"
+        '    """\n'
+        "    >>> func()\n"
+        "\n"  # truly empty line - no indentation
+        '    """\n'
+        "    return 2\n"
+    )
+    path = pytester.makepyfile(test_contents)
+    result = pytester.runpytest("--doctest-modules", "--accept")
+    result.assert_outcomes(failed=1)
+
+    content = path.read_text()
+    # The output '2' must be indented to match the docstring level
+    assert "    2\n" in content, f"Expected indented output but got:\n{content}"
+
+
+def test_indentation_two_examples_mixed_blank_lines(pytester):
+    """Exact scenario from issue #296: two examples with different blank line content."""
+    # Case 1 blank line has 4 spaces; case 2 blank line is truly empty
+    test_contents = (
+        "def func():\n"
+        '    """\n'
+        "    Examples\n"
+        "    --------\n"
+        "    >>> func()\n"
+        "    \n"  # blank line WITH indentation spaces
+        "    >>> func()\n"
+        "\n"  # blank line WITHOUT any spaces
+        '    """\n'
+        "    return 2\n"
+    )
+    path = pytester.makepyfile(test_contents)
+    result = pytester.runpytest("--doctest-modules", "--accept")
+    result.assert_outcomes(failed=1)
+
+    content = path.read_text()
+    lines = content.splitlines()
+    # Find the output lines (lines containing just "2" with indentation)
+    output_lines = [line for line in lines if line.strip() == "2"]
+    assert len(output_lines) == 2, f"Expected 2 output lines but got:\n{content}"
+    # Both must be indented identically
+    assert output_lines[0] == "    2", f"First output wrong indent:\n{content}"
+    assert output_lines[1] == "    2", f"Second output wrong indent:\n{content}"