Merge pull request #68 from nschloe/skipif

add skipif

Author: nschloe

.flake8

@@ -1,5 +1,5 @@
 [flake8]
-ignore = E203, E266, E501, W503
+ignore = E203, E266, E501, W503, F401, C901
 max-line-length = 80
 max-complexity = 18
 select = B,C,E,F,W,T4,B9

.github/workflows/ci.yml

@@ -26,9 +26,9 @@ jobs:
         python-version: ["3.7", "3.8", "3.9", "3.10"]
         include:
           - platform: macos-latest
-            python-version: "3.9"
+            python-version: "3.10"
           - platform: windows-latest
-            python-version: "3.9"
+            python-version: "3.10"
 
     runs-on: ${{ matrix.platform }}
 
@@ -40,6 +40,6 @@ jobs:
       - name: Test with tox
         run: |
           pip install tox
-          tox -- --codeblocks --cov pytest_codeblocks --cov-report xml --cov-report term
+          tox -- --cov pytest_codeblocks --cov-report xml --cov-report term
       - uses: codecov/codecov-action@v1
-        if: ${{ matrix.python-version == '3.9' }}
+        if: ${{ matrix.python-version == '3.10' && matrix.os == 'ubuntu-latest' }}

README.md

@@ -7,7 +7,8 @@
 [![Anaconda Cloud](https://anaconda.org/conda-forge/pytest-codeblocks/badges/version.svg?=style=flat-square)](https://anaconda.org/conda-forge/pytest-codeblocks/)
 [![PyPI pyversions](https://img.shields.io/pypi/pyversions/pytest-codeblocks.svg?style=flat-square)](https://pypi.org/project/pytest-codeblocks/)
 [![GitHub stars](https://img.shields.io/github/stars/nschloe/pytest-codeblocks.svg?style=flat-square&logo=github&label=Stars&logoColor=white)](https://github.com/nschloe/pytest-codeblocks)
-[![PyPi downloads](https://img.shields.io/pypi/dm/pytest-codeblocks.svg?style=flat-square)](https://pypistats.org/packages/pytest-codeblocks)
+[![Downloads](https://pepy.tech/badge/pytest-codeblocks/month?style=flat-square)](https://pepy.tech/project/pytest-codeblocks)
+<!--[![PyPi downloads](https://img.shields.io/pypi/dm/pytest-codeblocks.svg?style=flat-square)](https://pypistats.org/packages/pytest-codeblocks)-->
 
 [![gh-actions](https://img.shields.io/github/workflow/status/nschloe/pytest-codeblocks/ci?style=flat-square)](https://github.com/nschloe/pytest-codeblocks/actions?query=workflow%3Aci)
 [![codecov](https://img.shields.io/codecov/c/github/nschloe/pytest-codeblocks.svg?style=flat-square)](https://app.codecov.io/gh/nschloe/pytest-codeblocks)
@@ -19,17 +20,17 @@ blocks from README files. It supports Python and shell code.
 
 Install with
 
-```
+```sh
 pip install pytest-codeblocks
 ```
 
 and run pytest with
 
-```
+```sh
 pytest --codeblocks
 ```
 
-```
+```sh
 ================================= test session starts =================================
 platform linux -- Python 3.9.4, pytest-6.2.4, py-1.10.0, pluggy-0.13.1
 rootdir: /path/to/directory
@@ -61,6 +62,11 @@ foo + bar  # not working
 dolor sit amet.
 ````
 
+Conditionally skipping code blocks works with `skipif`, e.g.,
+```
+<!--pytest-codeblocks:skipif(sys.version_info <= (3, 7))-->
+```
+
 #### Merging code blocks
 
 Broken-up code blocks can be merged into one with the `pytest-codeblocks:cont` prefix

setup.cfg

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

src/pytest_codeblocks/main.py

@@ -18,6 +18,8 @@ class CodeBlock:
     syntax: str | None = None
     expected_output: str | None = None
     expect_exception: bool = False
+    skip: bool = False
+    skipif: str | None = None
 
 
 def extract_from_file(
@@ -27,7 +29,7 @@ def extract_from_file(
         return extract_from_buffer(handle, *args, **kwargs)
 
 
-def extract_from_buffer(f, max_num_lines: int = 10000):
+def extract_from_buffer(f, max_num_lines: int = 10000) -> list[CodeBlock]:
     out = []
     previous_nonempty_line = None
     k = 1
@@ -81,9 +83,7 @@ def extract_from_buffer(f, max_num_lines: int = 10000):
             keyword = m.group(1).strip("- ")
 
             # handle special tags
-            if keyword == "skip":
-                continue
-            elif keyword == "expected-output":
+            if keyword == "expected-output":
                 if len(out) == 0:
                     raise RuntimeError(
                         "Found <!--pytest-codeblocks-expected-output--> "
@@ -110,14 +110,25 @@ def extract_from_buffer(f, max_num_lines: int = 10000):
                     out[-1].expected_output,
                     out[-1].expect_exception,
                 )
+            elif keyword == "skip":
+                out.append(CodeBlock("".join(code_block), lineno, syntax, skip=True))
+            elif keyword.startswith("skipif"):
+                m = re.match(r"skipif\((.*)\)", keyword)
+                if m is None:
+                    raise RuntimeError(
+                        "pytest-codeblocks: Expected skipif(some-condition)"
+                    )
+                out.append(
+                    CodeBlock("".join(code_block), lineno, syntax, skipif=m.group(1))
+                )
             elif keyword in ["expect-exception", "expect-error"]:
                 out.append(
                     CodeBlock(
                         "".join(code_block), lineno, syntax, expect_exception=True
                     )
                 )
             else:
-                raise RuntimeError('Unknown pytest-codeblocks keyword "{keyword}."')
+                raise RuntimeError(f'Unknown pytest-codeblocks keyword "{keyword}."')
 
         previous_nonempty_line = line
 

src/pytest_codeblocks/plugin.py

@@ -31,20 +31,32 @@ def collect(self):
             if block.syntax not in ["python", "sh", "bash"]:
                 continue
             # https://docs.pytest.org/en/stable/deprecations.html#node-construction-changed-to-node-from-parent
-            out = Codeblock.from_parent(parent=self, name=self.name)
+            out = TestBlock.from_parent(parent=self, name=self.name)
             out.obj = block
             yield out
 
 
-class Codeblock(pytest.Item):
+class TestBlock(pytest.Item):
     def __init__(self, name, parent, obj=None):
         super().__init__(name, parent=parent)
         self.obj = obj
 
     # TODO for python 3.7+, stdout=subprocess.PIPE can be replaced by
     #      capture_output=True
     def runtest(self):
+        assert self.obj is not None
         output = None
+
+        if self.obj.skip:
+            pytest.skip()
+
+        if self.obj.skipif is not None:
+            # needed for sys.version_info in skipif eval():
+            import sys
+
+            if eval(self.obj.skipif):
+                pytest.skip()
+
         if self.obj.syntax == "python":
             if self.obj.expect_exception:
                 with pytest.raises(Exception):

tests/test_general.py

@@ -35,7 +35,7 @@ def test_skip(testdir):
     """
     testdir.makefile(".md", string1)
     result = testdir.runpytest("--codeblocks")
-    result.assert_outcomes(passed=0)
+    result.assert_outcomes(skipped=2)
 
 
 # example.md against reference strings test against
@@ -50,6 +50,7 @@ def test_reference():
         ),
         pytest_codeblocks.CodeBlock("foobar\n", 16, "ruby"),
         pytest_codeblocks.CodeBlock("echo abc\n", 20, "sh"),
+        pytest_codeblocks.CodeBlock("bar\n", 25, "python", skip=True),
         pytest_codeblocks.CodeBlock("# ```import math```\n", 30, "python"),
         pytest_codeblocks.CodeBlock("1 + 1 == 2\n", 35, "python"),
         pytest_codeblocks.CodeBlock("1 + 1 == 2\n", 40, "python"),
@@ -58,6 +59,6 @@ def test_reference():
     lst = pytest_codeblocks.extract_from_file(this_dir / "example.md")
     print(lst)
     for r, obj in zip(ref, lst):
-        print("r  ", r)
-        print("obj", obj)
+        print("\n\nr  ", r)
+        print("\nobj", obj)
         assert r == obj