mktestdocs 0.2.0__py2.py3-none-any.whl → 0.2.2__py2.py3-none-any.whl

mktestdocs/__init__.py

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

mktestdocs/__main__.py

@@ -3,7 +3,6 @@ import pathlib
 import subprocess
 import textwrap
 
-
 _executors = {}
 
 
@@ -90,6 +89,7 @@ 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 = ""
@@ -104,6 +104,11 @@ def grab_code_blocks(docstring, lang="python"):
             block += line + "\n"
     return [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.2.dist-info/METADATA

@@ -0,0 +1,7 @@
+Metadata-Version: 2.1
+Name: mktestdocs
+Version: 0.2.2
+License-File: LICENSE
+Provides-Extra: test
+Requires-Dist: pytest >=4.0.2 ; extra == 'test'
+

mktestdocs-0.2.2.dist-info/RECORD

@@ -0,0 +1,7 @@
+mktestdocs/__init__.py,sha256=wL-m_63-2NFVKQpqKySIm7y2vfwcutnIXpgLJU4xsxw,371
+mktestdocs/__main__.py,sha256=J-x8TWbSanfrbry41ApOuoZRFClvXaH0Dq3SLXpZqtw,4745
+mktestdocs-0.2.2.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+mktestdocs-0.2.2.dist-info/METADATA,sha256=YdOdkMSjz5zQzR8VJIc3uEsCNUGHBZ932h38meQ-GW0,146
+mktestdocs-0.2.2.dist-info/WHEEL,sha256=DZajD4pwLWue70CAfc7YaxT1wLUciNBvN_TTcvXpltE,110
+mktestdocs-0.2.2.dist-info/top_level.txt,sha256=1XGYsQSl3FsAtilWThIet3WOJQSuzQXXn6sQA7hxlho,11
+mktestdocs-0.2.2.dist-info/RECORD,,

{mktestdocs-0.2.0.dist-info → mktestdocs-0.2.2.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.37.1)
+Generator: bdist_wheel (0.43.0)
 Root-Is-Purelib: true
 Tag: py2-none-any
 Tag: py3-none-any

{mktestdocs-0.2.0.dist-info → mktestdocs-0.2.2.dist-info}/top_level.txt

@@ -1,2 +1 @@
 mktestdocs
-tests

mktestdocs-0.2.0.dist-info/METADATA

@@ -1,12 +0,0 @@
-Metadata-Version: 2.1
-Name: mktestdocs
-Version: 0.2.0
-Summary: UNKNOWN
-License: UNKNOWN
-Platform: UNKNOWN
-License-File: LICENSE
-Provides-Extra: test
-Requires-Dist: pytest (>=4.0.2) ; extra == 'test'
-
-UNKNOWN
-

mktestdocs-0.2.0.dist-info/RECORD

@@ -1,14 +0,0 @@
-mktestdocs/__init__.py,sha256=dkhHcGV1XKIm22O3NkS7j9Cabmxpo39XNMAlLqQS_oM,371
-mktestdocs/__main__.py,sha256=BO5LopXLAeKFFuKcT0KaeErUeFXt8ekjIiyrTymBG3k,4508
-tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-tests/conftest.py,sha256=9K0dbGVqN7yeK4PJ3k36vOKGlZecILTZRJPxuEomjqM,214
-tests/test_actual_docstrings.py,sha256=N1yIuHOBNhv2qR2yO1DkqiBNvHK3_o_pbLJCHLKUa68,940
-tests/test_class.py,sha256=lkZ73We8Hb4IvPbQVn8w5LX5zMHptFHkUcJ3xfBJqgc,1220
-tests/test_codeblock.py,sha256=FxyPZZw1lVLFWXB1BErciHP6h-kFNBLLPU9UX_6uBfE,903
-tests/test_markdown.py,sha256=ny6_Jy9Wj9FNXQMrz48RYloEdgPjCkE3z8X6Ch7HMAU,2656
-tests/test_mktestdocs.py,sha256=EegZRk2GRrsxAQW-TPQnXXbAogdNG0Eb5OZ0dabQtTU,235
-mktestdocs-0.2.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-mktestdocs-0.2.0.dist-info/METADATA,sha256=oM6g1nrBC3KNILrI30eSzMmZCW0nnSXdYTG9VPyDav4,209
-mktestdocs-0.2.0.dist-info/WHEEL,sha256=z9j0xAa_JmUKMpmz72K0ZGALSM_n-wQVmGbleXx2VHg,110
-mktestdocs-0.2.0.dist-info/top_level.txt,sha256=Wh9mCrbRZsALS8VKzSi8ifKBj95gf-BHeWQCoTTNBKc,17
-mktestdocs-0.2.0.dist-info/RECORD,,

tests/conftest.py

@@ -1,12 +0,0 @@
-from copy import copy
-
-import pytest
-
-import mktestdocs
-
-
-@pytest.fixture
-def temp_executors():
-    old_executors = copy(mktestdocs.__main__._executors)
-    yield
-    mktestdocs.__main__._executors = old_executors

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

tests/test_class.py

@@ -1,73 +0,0 @@
-import pytest
-
-from mktestdocs import get_codeblock_members, check_docstring
-
-
-class Dinosaur:
-    """
-    This is a dino.
-
-    ```python
-    from dinosaur import Dinosaur
-
-    assert Dinosaur().name == 'trex'
-    ```
-    """
-
-    def __init__(self):
-        self.name = "trex"
-
-    @staticmethod
-    def a(value):
-        """
-        Returns value
-
-        Example:
-
-        ```python
-        from dinosaur import Dinosaur
-
-        dino = Dinosaur()
-        assert dino.a(1) == 1
-        ```
-        """
-        return value
-
-    @classmethod
-    def b(cls, value):
-        """
-        Returns value
-
-        Example:
-
-        ```python
-        from dinosaur import Dinosaur
-        assert Dinosaur.b(1) == 1
-        ```
-        """
-        return value
-
-    def hello(self):
-        """
-        Returns value
-
-        Example:
-
-        ```python
-        from dinosaur import Dinosaur
-        assert Dinosaur().name == 'trex'
-        ```
-        """
-        return self.name
-
-
-members = get_codeblock_members(Dinosaur)
-
-
-def test_grab_methods():
-    assert len(get_codeblock_members(Dinosaur)) == 4
-
-
-@pytest.mark.parametrize("obj", members, ids=lambda d: d.__qualname__)
-def test_member(obj):
-    check_docstring(obj)

tests/test_codeblock.py

@@ -1,56 +0,0 @@
-import pytest
-
-from mktestdocs import check_codeblock, grab_code_blocks
-
-exibit_a = """
-This is an example docstring. 
-
-Arguments:
-    a: a parameter 
-    
-There is no example
-"""
-
-exibit_b = """
-This is an example docstring. 
-
-Arguments:
-    a: a parameter 
-
-```python
-assert 1 == 1
-```
-"""
-
-exibit_c = """
-This is an example docstring. 
-
-Arguments:
-    a: a parameter 
-
-```
-assert 1 == 1
-```
-
-```python
-assert 1 == 1
-```
-"""
-
-
-@pytest.mark.parametrize(
-    "doc, n",
-    [(exibit_a, 0), (exibit_b, 1), (exibit_c, 1)],
-    ids=["exibit_a", "exibit_b", "exibit_c"],
-)
-def test_number_of_codeblocks(doc, n):
-    assert len(grab_code_blocks(doc, lang="python")) == n
-
-
-@pytest.mark.parametrize(
-    "doc, n",
-    [(exibit_a, 0), (exibit_b, 1), (exibit_c, 2)],
-    ids=["exibit_a", "exibit_b", "exibit_c"],
-)
-def test_number_of_codeblocks_any(doc, n):
-    assert len(grab_code_blocks(doc, lang=None)) == n

tests/test_markdown.py

@@ -1,77 +0,0 @@
-import pathlib
-import pytest
-from shutil import which
-from unittest.mock import Mock
-
-from mktestdocs import check_md_file, register_executor
-from mktestdocs.__main__ import exec_bash
-
-
-@pytest.mark.parametrize("fpath", pathlib.Path("tests/data/good").glob("?.md"), ids=str)
-def test_files_good(fpath):
-    check_md_file(fpath=fpath)
-
-
-def test_files_bad():
-    fpath = pathlib.Path("tests") / "data" / "bad" / "a.md"
-    with pytest.raises(Exception):
-        check_md_file(fpath=fpath)
-
-
-def test_big_files_good():
-    """Confirm that we can deal with multi-cell markdown cells."""
-    check_md_file(fpath="tests/data/good/big-good.md", memory=True)
-
-
-def test_big_file_independant():
-    """Confirm that different files don't influence each other."""
-    check_md_file(fpath="tests/data/good/big-good.md", memory=True)
-    with pytest.raises(Exception):
-        check_md_file(fpath="tests/data/bad/big-bad.md", memory=True)
-
-
-@pytest.mark.skipif(which("bash") is None, reason="No bash shell available")
-@pytest.mark.parametrize("fpath", pathlib.Path("tests/data/good").glob("?.md"), ids=str)
-def test_files_good_bash(fpath):
-    check_md_file(fpath=fpath, lang="bash")
-
-
-@pytest.mark.skipif(which("bash") is None, reason="No bash shell available")
-def test_files_bad_bash():
-    fpath = pathlib.Path("tests") / "data" / "bad" / "b.md"
-    with pytest.raises(Exception):
-        check_md_file(fpath=fpath, lang="bash")
-
-
-@pytest.mark.skipif(which("bash") is None, reason="No bash shell available")
-def test_big_files_good_bash():
-    fpath = pathlib.Path("tests") / "data" / "good" / "big-good.md"
-    check_md_file(fpath=fpath, memory=True, lang="bash")
-
-
-@pytest.mark.skipif(which("bash") is None, reason="No bash shell available")
-def test_big_file_independant_bash():
-    fdir = pathlib.Path("tests") / "data"
-    check_md_file(fpath=fdir / "good" / "big-good.md", memory=True, lang="bash")
-    with pytest.raises(Exception):
-        check_md_file(fpath=fdir / "bad" / "big-bad.md", memory=True, lang="bash")
-
-
-def test_files_unmarked_language_default():
-    fpath = pathlib.Path("tests") / "data" / "good" / "c.md"
-    check_md_file(fpath, lang="")
-
-
-@pytest.mark.skipif(which("bash") is None, reason="No bash shell available")
-def test_files_unmarked_language_bash(temp_executors):
-    fpath = pathlib.Path("tests") / "data" / "good" / "c.md"
-    register_executor("", exec_bash)
-    check_md_file(fpath, lang="")
-
-
-def test_override_executor(temp_executors):
-    fpath = pathlib.Path("tests") / "data" / "good" / "a.md"
-    hijack = Mock()
-    register_executor("python", hijack)
-    check_md_file(fpath, lang="python")
-    hijack.assert_called()

tests/test_mktestdocs.py

@@ -1,10 +0,0 @@
-import pathlib
-
-from mktestdocs import check_md_file
-
-def test_readme(monkeypatch):
-    test_dir = pathlib.Path(__file__).parent
-    fpath = test_dir.parent / "README.md"
-    monkeypatch.chdir(test_dir)
-
-    check_md_file(fpath=fpath)