mktestdocs 0.2.5__py3-none-any.whl

mktestdocs/__init__.py

@@ -0,0 +1,21 @@
+import importlib.metadata
+from .__main__ import (
+    register_executor,
+    check_codeblock,
+    grab_code_blocks,
+    check_docstring,
+    check_md_file,
+    get_codeblock_members,
+)
+
+__version__ = importlib.metadata.version("mktestdocs")
+
+__all__ = [
+    "__version__",
+    "register_executor",
+    "check_codeblock",
+    "grab_code_blocks",
+    "check_docstring",
+    "check_md_file",
+    "get_codeblock_members",
+]

mktestdocs/__main__.py

@@ -0,0 +1,169 @@
+import inspect
+import pathlib
+import subprocess
+import textwrap
+
+_executors = {}
+
+
+def register_executor(lang, executor):
+    """Add a new executor for markdown code blocks
+
+    lang should be the tag used after the opening ```
+    executor should be a callable that takes one argument:
+        the code block found
+    """
+    _executors[lang] = executor
+
+
+def exec_bash(source):
+    """Exec the bash source given in a new subshell
+
+    Does not return anything, but if any command returns not-0 an error
+    will be raised
+    """
+    command = ["bash", "-e", "-u", "-c", source]
+    try:
+        subprocess.run(command, check=True)
+    except Exception:
+        print(source)
+        raise
+
+
+register_executor("bash", exec_bash)
+
+
+def exec_python(source):
+    """Exec the python source given in a new module namespace
+
+    Does not return anything, but exceptions raised by the source
+    will propagate out unmodified
+    """
+    try:
+        exec(source, {"__name__": "__main__"})
+    except Exception:
+        print(source)
+        raise
+
+
+register_executor("", exec_python)
+register_executor("python", exec_python)
+
+
+def get_codeblock_members(*classes, lang="python"):
+    """
+    Grabs the docstrings of any methods of any classes that are passed in.
+    """
+    results = []
+    for cl in classes:
+        if cl.__doc__:
+            results.append(cl)
+        for name, member in inspect.getmembers(cl):
+            if member.__doc__:
+                results.append(member)
+    return [m for m in results if len(grab_code_blocks(m.__doc__, lang=lang)) > 0]
+
+
+def check_codeblock(block, lang="python"):
+    """
+    Cleans the found codeblock and checks if the proglang is correct.
+
+    Returns an empty string if the codeblock is deemed invalid.
+
+    Arguments:
+        block: the code block to analyse
+        lang: if not None, the language that is assigned to the codeblock
+    """
+    first_line = block.split("\n")[0]
+    if lang:
+        if first_line.lstrip()[3:] != lang:
+            return ""
+    return "\n".join(block.split("\n")[1:])
+
+
+def grab_code_blocks(docstring, lang="python"):
+    """
+    Given a docstring, grab all the markdown codeblocks found in docstring.
+
+    Arguments:
+        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 "```" 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 [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=""):
+    """
+    Given a function, test the contents of the docstring.
+    """
+    if lang not in _executors:
+        raise LookupError(
+            f"{lang} is not a supported language to check\n"
+            "\tHint: you can add support for any language by using register_executor"
+        )
+    executor = _executors[lang]
+    for b in grab_code_blocks(obj.__doc__, lang=lang):
+        executor(b)
+
+
+def check_raw_string(raw, lang="python"):
+    """
+    Given a raw string, test the contents.
+    """
+    if lang not in _executors:
+        raise LookupError(
+            f"{lang} is not a supported language to check\n"
+            "\tHint: you can add support for any language by using register_executor"
+        )
+    executor = _executors[lang]
+    for b in grab_code_blocks(raw, lang=lang):
+        executor(b)
+
+
+def check_raw_file_full(raw, lang="python"):
+    if lang not in _executors:
+        raise LookupError(
+            f"{lang} is not a supported language to check\n"
+            "\tHint: you can add support for any language by using register_executor"
+        )
+    executor = _executors[lang]
+    all_code = ""
+    for b in grab_code_blocks(raw, lang=lang):
+        all_code = f"{all_code}\n{b}"
+    executor(all_code)
+
+
+def check_md_file(fpath, memory=False, lang="python"):
+    """
+    Given a markdown file, parse the contents for python code blocks
+    and check that each independent block does not cause an error.
+
+    Arguments:
+        fpath: path to markdown file
+        memory: whether or not previous code-blocks should be remembered
+    """
+    text = pathlib.Path(fpath).read_text()
+    if not memory:
+        check_raw_string(text, lang=lang)
+    else:
+        check_raw_file_full(text, lang=lang)

mktestdocs-0.2.5.dist-info/METADATA

@@ -0,0 +1,191 @@
+Metadata-Version: 2.4
+Name: mktestdocs
+Version: 0.2.5
+Summary: A tool for testing markdown documentation
+License: MIT
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Dynamic: license-file
+
+<img src="icon.png" width=125 height=125 align="right">
+
+### mktestdocs
+
+Run pytest against markdown files/docstrings.
+
+# Installation 
+
+```
+pip install mktestdocs
+```
+
+## Usage 
+
+Let's say that you're using [mkdocs](https://squidfunk.github.io/mkdocs-material/getting-started/) 
+for your documentation. Then you're writing down markdown to explain how your Python packages work. 
+It'd be a shame if a codeblock had an error in it, so it'd be 
+great if you could run your unit tests against them. 
+
+This package allows you to do _just that_. Here's an example:
+
+```python
+import pathlib
+import pytest
+
+from mktestdocs import check_md_file
+
+# Note the use of `str`, makes for pretty output
+@pytest.mark.parametrize('fpath', pathlib.Path("docs").glob("**/*.md"), ids=str)
+def test_files_good(fpath):
+    check_md_file(fpath=fpath)
+```
+
+This will take any codeblock that starts with *\`\`\`python* and run it, checking
+for any errors that might happen. This means that if your docs contain asserts, that
+you get some unit-tests for free! 
+
+## Multiple Code Blocks 
+
+Let's suppose that you have the following markdown file: 
+
+    This is a code block
+
+    ```python
+    from operator import add
+    a = 1
+    b = 2
+    ```
+
+    This code-block should run fine.
+
+    ```python
+    assert add(1, 2) == 3
+    ```
+
+Then in this case the second code-block depends on the first code-block. The standard settings of `check_md_file` assume that each code-block needs to run independently. If you'd like to test markdown files with these sequential code-blocks be sure to set `memory=True`. 
+
+```python
+import pathlib
+
+from mktestdocs import check_md_file
+
+fpath = pathlib.Path("docs") / "multiple-code-blocks.md"
+
+try:
+    # Assume that cell-blocks are independent.
+    check_md_file(fpath=fpath)
+except NameError:
+    # But they weren't
+    pass
+
+# Assumes that cell-blocks depend on each other.
+check_md_file(fpath=fpath, memory=True)
+```
+
+## Markdown in Docstrings
+
+You might also have docstrings written in markdown. Those can be easily checked
+as well. 
+
+```python
+# I'm assuming that we've got a library called dinosaur
+from dinosaur import roar, super_roar
+
+import pytest
+from mktestdocs import check_docstring
+
+# Note the use of `__name__`, makes for pretty output
+@pytest.mark.parametrize('func', [roar, super_roar], ids=lambda d: d.__name__)
+def test_docstring(func):
+    check_docstring(obj=func)
+```
+
+There's even some utilities for grab all the docstrings from classes that you've defined. 
+
+```python
+# I'm assuming that we've got a library called dinosaur
+from dinosaur import Dinosaur
+
+import pytest
+from mktestdocs import check_docstring, get_codeblock_members
+
+# This retrieves all methods/properties that have a docstring.
+members = get_codeblock_members(Dinosaur)
+
+# Note the use of `__qualname__`, makes for pretty output
+@pytest.mark.parametrize("obj", members, ids=lambda d: d.__qualname__)
+def test_member(obj):
+    check_docstring(obj)
+```
+
+When you run these commands via `pytest --verbose` you should see informative test info being run. 
+
+If you're wondering why you'd want to write markdown in a docstring feel free to check out [mkdocstrings](https://github.com/mkdocstrings/mkdocstrings).
+
+## Bash Support
+
+Be default, bash code blocks are also supported. A markdown file that contains
+both python and bash code blocks can have each executed separately.
+
+    This will print the python version to the terminal
+
+    ```bash
+    python --version
+    ```
+
+    This will print the exact same version string
+
+    ```python
+    import sys
+
+    print(f"Python {sys.version_info.major}.{sys.version_info.minor}.{sys.version_info.micro}")
+    ```
+
+This markdown could be fully tested like this
+
+```python
+import pathlib
+
+from mktestdocs import check_md_file
+
+fpath = pathlib.Path("docs") / "bash-support.md"
+
+check_md_file(fpath=fpath, lang="python")
+check_md_file(fpath=fpath, lang="bash")
+```
+
+## Additional Language Support
+
+You can add support for languages other than python and bash by first
+registering a new executor for that language. The `register_executor` function
+takes a tag to specify the code block type supported, and a function that will
+be passed any code blocks found in markdown files.
+
+For example if you have a markdown file like this
+
+````markdown
+This is an example REST response
+
+```json
+{"body": {"results": ["spam", "eggs"]}, "errors": []}
+```
+````
+
+You could create a json validator that tested the example was always valid json like this
+
+```python
+import json
+import pathlib
+
+from mktestdocs import check_md_file, register_executor
+
+def parse_json(json_text):
+    json.loads(json_text)
+
+register_executor("json", parse_json)
+
+check_md_file(fpath=pathlib.Path("docs") / "additional-language-support.md", lang="json")
+```

mktestdocs-0.2.5.dist-info/RECORD

@@ -0,0 +1,7 @@
+mktestdocs/__init__.py,sha256=KT3OfqR3S2foMTti09sDrpu5RctKFNUjU6o7dke60kc,420
+mktestdocs/__main__.py,sha256=LuTB8bop42Q8bIIOrr2kYSz_Q4y3PkkG7BmYuS29ZCI,4788
+mktestdocs-0.2.5.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+mktestdocs-0.2.5.dist-info/METADATA,sha256=FvEN2kcXIbD3gMMFktVVSC48kHo1fVprUoj046R64v8,5047
+mktestdocs-0.2.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+mktestdocs-0.2.5.dist-info/top_level.txt,sha256=1XGYsQSl3FsAtilWThIet3WOJQSuzQXXn6sQA7hxlho,11
+mktestdocs-0.2.5.dist-info/RECORD,,

mktestdocs-0.2.5.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

mktestdocs-0.2.5.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

mktestdocs-0.2.5.dist-info/top_level.txt

@@ -0,0 +1 @@
+mktestdocs