mktestdocs 0.2.1__tar.gz → 0.2.3__tar.gz

{mktestdocs-0.2.1 → mktestdocs-0.2.3}/PKG-INFO

@@ -1,5 +1,6 @@
 Metadata-Version: 2.1
 Name: mktestdocs
-Version: 0.2.1
-Provides-Extra: test
+Version: 0.2.3
 License-File: LICENSE
+Provides-Extra: test
+Requires-Dist: pytest>=4.0.2; extra == "test"

{mktestdocs-0.2.1 → mktestdocs-0.2.3}/README.md

@@ -1,6 +1,6 @@
 <img src="icon.png" width=125 height=125 align="right">
 
-# mktestdocs
+### mktestdocs
 
 Run pytest against markdown files/docstrings.
 

{mktestdocs-0.2.1 → mktestdocs-0.2.3}/mktestdocs/__init__.py

@@ -7,7 +7,7 @@ from mktestdocs.__main__ import (
     get_codeblock_members,
 )
 
-__version__ = "0.2.1"
+__version__ = "0.2.3"
 
 __all__ = [
     "__version__",

{mktestdocs-0.2.1 → mktestdocs-0.2.3}/mktestdocs/__main__.py

@@ -3,7 +3,6 @@ import pathlib
 import subprocess
 import textwrap
 
-
 _executors = {}
 
 
@@ -90,20 +89,26 @@ def grab_code_blocks(docstring, lang="python"):
         docstring: the docstring to analyse
         lang: if not None, the language that is assigned to the codeblock
     """
+    docstring = format_docstring(docstring)
     docstring = textwrap.dedent(docstring)
     in_block = False
     block = ""
     codeblocks = []
     for idx, line in enumerate(docstring.split("\n")):
-        if line.startswith("```"):
+        if "```" in line:
             if in_block:
                 codeblocks.append(check_codeblock(block, lang=lang))
                 block = ""
             in_block = not in_block
         if in_block:
             block += line + "\n"
-    return [c for c in codeblocks if c != ""]
+    return [textwrap.dedent(c) for c in codeblocks if c != ""]
 
+def format_docstring(docstring):
+    """Formats docstring to be able to successfully go through dedent."""
+    if docstring[:1] != "\n":
+        return f"\n    {docstring}"
+    return docstring
 
 def check_docstring(obj, lang=""):
     """

{mktestdocs-0.2.1 → mktestdocs-0.2.3}/mktestdocs.egg-info/PKG-INFO

@@ -1,5 +1,6 @@
 Metadata-Version: 2.1
 Name: mktestdocs
-Version: 0.2.1
-Provides-Extra: test
+Version: 0.2.3
 License-File: LICENSE
+Provides-Extra: test
+Requires-Dist: pytest>=4.0.2; extra == "test"

{mktestdocs-0.2.1 → mktestdocs-0.2.3}/mktestdocs.egg-info/SOURCES.txt

@@ -11,5 +11,6 @@ mktestdocs.egg-info/top_level.txt
 tests/test_actual_docstrings.py
 tests/test_class.py
 tests/test_codeblock.py
+tests/test_format_docstring.py
 tests/test_markdown.py
 tests/test_mktestdocs.py

mktestdocs-0.2.3/tests/test_actual_docstrings.py

@@ -0,0 +1,74 @@
+import pytest
+from mktestdocs import check_docstring
+
+
+def foobar_good(a, b):
+    """
+    Returns a + b.
+
+    Examples:
+
+    ```python
+    import random
+
+    random.random()
+    assert 'a' + 'b' == 'ab'
+    assert 1 + 2 == 3
+    ```
+    """
+    pass
+
+
+def foobar_also_good(a, b):
+    """
+    ```python
+    import random
+
+    assert random.random() < 10
+    ```
+    """
+    pass
+
+
+def foobar_bad(a, b):
+    """
+    ```python
+    assert foobar(1, 2) == 4
+    ```
+    """
+    pass
+
+
+def admonition_edge_cases():
+    """
+    !!! note
+
+        All cells of a table are initialized with an empty string. Therefore, to delete the content of a cell,
+        you need to assign an empty string, i.e. `''`. For instance, to delete the first row after the header:
+
+        ```python
+        assert 1 + 2 == 3
+        ```"""
+    pass
+
+def adminition_edge_case_bad():
+    """Test that we can handle the edge cases of admonitions."""
+    example = """!!! note
+
+    Another one. 
+    ```python
+    assert 1 + 2 == 4
+    ```"""
+    pass
+
+@pytest.mark.parametrize("func", [foobar_good, foobar_also_good, admonition_edge_cases])
+def test_base_docstrings(func):
+    check_docstring(func)
+
+
+@pytest.mark.parametrize("func", [foobar_bad, adminition_edge_case_bad])
+def test_base_docstrings_bad(func, capsys):
+    with pytest.raises(Exception):
+        check_docstring(func)
+        capsys.readouterr()
+        assert func.__name__ in capsys.readouterr().out

mktestdocs-0.2.3/tests/test_format_docstring.py

@@ -0,0 +1,61 @@
+import pytest
+
+from mktestdocs import get_codeblock_members
+from mktestdocs.__main__ import format_docstring
+
+
+def test_docstring_formatted():
+    # given (a docstring not prepared for dedent)
+    docstring = "Some class with a header and a code block"
+    # when (we go through the format_docstring function)
+    formatted = format_docstring(docstring)
+    # then (a new line and tab are added to the docstring)
+    assert formatted == "\n    Some class with a header and a code block"
+
+def test_docstring_not_formatted():
+    # given (a docstring prepared for dedent)
+    docstring = "\n    Some class with a header and a code block"
+    # when (we go through the format_docstring function)
+    formatted = format_docstring(docstring)
+    # then (the docstring doesn't change)
+    assert formatted == docstring
+
+
+
+# The docstring of the first class starts like
+# """Some class ...
+# The docstring of the second class starts like
+# """
+# Some class ...
+# The tests are checking that regardless of how the class docstring starts we should always be able to read the tests
+class BadClass:
+    """Some class with a header and a code block.
+
+    ```python
+    assert False, "this should fail."
+    ```
+    
+    """
+    def __init__(self):
+        pass
+
+class BadClassNewLine:
+    """
+    Some class with a header and a code block.
+
+    ```python
+    assert False, "this should fail."
+    ```
+    
+    """
+    def __init__(self):
+        pass
+
+
+
+@pytest.mark.parametrize("cls", [BadClass, BadClassNewLine], ids=lambda d: d.__qualname__)
+def test_grab_bad_methods(cls):
+    bad_members = get_codeblock_members(cls)
+    assert len(bad_members) == 1
+
+

mktestdocs-0.2.1/tests/test_actual_docstrings.py

@@ -1,60 +0,0 @@
-import pytest
-from mktestdocs import check_docstring
-
-
-def foobar_good(a, b):
-    """
-    Returns a + b.
-
-    Examples:
-
-    ```python
-    import random
-
-    random.random()
-    assert 'a' + 'b' == 'ab'
-    assert 1 + 2 == 3
-    ```
-    """
-    return a + b
-
-
-def foobar_also_good(a, b):
-    """
-    Returns a + b.
-
-    Examples:
-
-    ```python
-    import random
-
-    assert random.random() < 10
-    ```
-    """
-    return a + b
-
-
-def foobar_bad(a, b):
-    """
-    Returns a + b.
-
-    Examples:
-
-    ```python
-    assert foobar(1, 2) == 4
-    ```
-    """
-    return a + b
-
-
-@pytest.mark.parametrize("func", [foobar_good, foobar_also_good])
-def test_base_docstrings(func):
-    check_docstring(func)
-
-
-@pytest.mark.parametrize("func", [foobar_bad])
-def test_base_docstrings_bad(func, capsys):
-    with pytest.raises(Exception):
-        check_docstring(func)
-        capsys.readouterr()
-        assert func.__name__ in capsys.readouterr().out