Merge pull request #69 from nschloe/skipfile

add skipfile

README.md

@@ -63,10 +63,16 @@ dolor sit amet.
 ````
 
 Conditionally skipping code blocks works with `skipif`, e.g.,
-```
+```markdown
 <!--pytest-codeblocks:skipif(sys.version_info <= (3, 7))-->
 ```
 
+You can also skip all blocks in the entire file by putting
+```markdown
+<!--pytest-codeblocks:skipfile-->
+```
+in the first line.
+
 #### 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.12.0
+version = 0.12.1
 author = Nico Schlömer
 author_email = nico.schloemer@gmail.com
 description = Test code blocks in your READMEs

src/pytest_codeblocks/main.py

@@ -36,6 +36,10 @@ def extract_from_buffer(f, max_num_lines: int = 10000) -> list[CodeBlock]:
 
     while True:
         line = f.readline()
+
+        if k == 1 and line.strip() == "<!--pytest-codeblocks:skipfile-->":
+            return []
+
         k += 1
         if not line:
             # EOF