Merge pull request #70 from nschloe/skip-expected-output

Skip expected output

Author: nschloe

README.md

@@ -67,7 +67,7 @@ Conditionally skipping code blocks works with `skipif`, e.g.,
 <!--pytest-codeblocks:skipif(sys.version_info <= (3, 7))-->
 ```
 
-You can also skip all blocks in the entire file by putting
+Skip the entire file by putting
 ```markdown
 <!--pytest-codeblocks:skipfile-->
 ```
@@ -136,6 +136,9 @@ gives
 ```
 ````
 
+(Conditionally) Skipping the output verfication works by prepending the first
+block with `skip`/`skipif` (see [above](#skipping-code-blocks)).
+
 #### Expected errors
 
 Some code blocks are expected to give errors. You can verify this with

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = pytest-codeblocks
-version = 0.12.1
+version = 0.12.2
 author = Nico Schlömer
 author_email = nico.schloemer@gmail.com
 description = Test code blocks in your READMEs

src/pytest_codeblocks/main.py

@@ -98,10 +98,7 @@ def extract_from_buffer(f, max_num_lines: int = 10000) -> list[CodeBlock]:
                         "Found <!--pytest-codeblocks-expected-output--> "
                         + "but block already has expected_output."
                     )
-                expected_output = "".join(code_block)
-                out[-1] = CodeBlock(
-                    out[-1].code, out[-1].lineno, out[-1].syntax, expected_output
-                )
+                out[-1].expected_output = "".join(code_block)
             elif keyword == "cont":
                 if len(out) == 0:
                     raise RuntimeError(

tests/test_skipif.py

@@ -0,0 +1,105 @@
+def test_skip(testdir):
+    string = """
+    Lorem ipsum
+
+    <!--pytest-codeblocks:skip-->
+
+    ```python
+    print(1 + 3)
+    ```
+    """
+    testdir.makefile(".md", string)
+    result = testdir.runpytest("--codeblocks")
+    result.assert_outcomes(skipped=1)
+
+
+def test_skip_expected_output(testdir):
+    string = """
+    Lorem ipsum
+
+    <!--pytest-codeblocks:skip-->
+
+    ```python
+    print(1 + 3)
+    ```
+
+    <!--pytest-codeblocks:expected-output-->
+
+    ```
+    25abc
+    ```
+
+    """
+    testdir.makefile(".md", string)
+    result = testdir.runpytest("--codeblocks")
+    result.assert_outcomes(skipped=1)
+
+
+def test_skipif(testdir):
+    string = """
+    Lorem ipsum
+
+    <!--pytest-codeblocks:skipif(1 < 3)-->
+
+    ```python
+    print(1 + 3)
+    ```
+    """
+    testdir.makefile(".md", string)
+    result = testdir.runpytest("--codeblocks")
+    result.assert_outcomes(skipped=1)
+
+    string = """
+    Lorem ipsum
+
+    <!--pytest-codeblocks:skipif(1 > 3)-->
+
+    ```python
+    print(1 + 3)
+    ```
+    """
+    testdir.makefile(".md", string)
+    result = testdir.runpytest("--codeblocks")
+    result.assert_outcomes(passed=1)
+
+
+def test_skipif_expected_output(testdir):
+    string = """
+    Lorem ipsum
+
+    <!--pytest-codeblocks:skipif(1 < 3)-->
+
+    ```python
+    print(1 + 3)
+    ```
+
+    <!--pytest-codeblocks:expected-output-->
+
+    ```
+    25abc
+    ```
+
+    """
+    testdir.makefile(".md", string)
+    result = testdir.runpytest("--codeblocks")
+    result.assert_outcomes(skipped=1)
+
+    string = """
+    Lorem ipsum
+
+    <!--pytest-codeblocks:skipif(1 > 3)-->
+
+    ```python
+    print(1 + 3)
+    ```
+
+    <!--pytest-codeblocks:expected-output-->
+
+    ```
+    4
+    ```
+
+    """
+    testdir.makefile(".md", string)
+    result = testdir.runpytest("--codeblocks")
+    result.assert_outcomes(passed=1)