pytest-markdown-docs 0.5.1__tar.gz → 0.7.0__tar.gz

pytest_markdown_docs-0.7.0/.github/pull_request_template.md

@@ -0,0 +1,5 @@
+<!--
+  ✍️ Write a short summary of this change, then request review from a recent contributor.
+-->
+
+**Issue:** https://github.com/modal-labs/pytest-markdown-docs/issues/XX or N/A

pytest_markdown_docs-0.7.0/.github/workflows/check.yml

@@ -0,0 +1,27 @@
+name: ruff & mypy
+on: push
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+
+      - name: Install Python (3.11)
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.11
+
+      - name: Install the project
+        run: uv sync --all-extras --dev --no-install-project
+
+      - name: Ruff check
+        run: uv run ruff check --diff
+
+      - name: Ruff format
+        run: uv run ruff format --diff
+
+      - name: Mypy
+        run: uv run mypy .

pytest_markdown_docs-0.7.0/.github/workflows/ci.yml

@@ -0,0 +1,31 @@
+name: Test
+on: push
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+
+      - name: Install Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install the project
+        run: uv sync --all-extras --dev
+
+      - name: Run tests with pytest
+        run: uv run pytest
+
+      - name: Downgrade to pytest 7
+        run: uv pip install "pytest<8"
+
+      - name: Run tests with pytest 7
+        run: uv run pytest

pytest_markdown_docs-0.7.0/.github/workflows/codeql.yml

@@ -0,0 +1,74 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+  schedule:
+    - cron: '42 12 * * 0'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'python' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Use only 'java' to analyze code written in Java, Kotlin or both
+        # Use only 'javascript' to analyze code written in JavaScript, TypeScript or both
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+
+        # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, Go, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines.
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #     echo "Run, Build Application using script"
+    #     ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2
+      with:
+        category: "/language:${{matrix.language}}"

pytest_markdown_docs-0.7.0/.gitignore

@@ -0,0 +1,129 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/

pytest_markdown_docs-0.7.0/.pre-commit-config.yaml

@@ -0,0 +1,8 @@
+repos:
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: "v0.2.1"
+    hooks:
+      - id: ruff
+        # Autofix, and respect `exclude` and `extend-exclude` settings.
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format

pytest_markdown_docs-0.7.0/Makefile

@@ -0,0 +1,8 @@
+build:
+	uv build
+
+clean:
+	rm -rf dist
+
+publish: clean build
+	uv publish

pytest_markdown_docs-0.5.1/README.md → pytest_markdown_docs-0.7.0/PKG-INFO

@@ -1,3 +1,15 @@
+Metadata-Version: 2.3
+Name: pytest-markdown-docs
+Version: 0.7.0
+Summary: Run markdown code fences through pytest
+Author: Modal Labs
+Author-email: Elias Freider <elias@modal.com>
+License: MIT
+Requires-Python: >=3.8
+Requires-Dist: markdown-it-py<4.0,>=2.2.0
+Requires-Dist: pytest>=7.0.0
+Description-Content-Type: text/markdown
+
 # Pytest Markdown Docs
 
 A plugin for [pytest](https://docs.pytest.org) that uses markdown code snippets from markdown files and docstrings as tests.
@@ -136,6 +148,39 @@ assert a + " world" == "hello world"
 ```
 ````
 
+### Compatibility with Material for MkDocs
+
+Material for Mkdocs is not compatible with the default syntax.
+
+But if the extension `pymdownx.superfences` is configured for mkdocs, the brace format can be used:
+````markdown
+```{.python continuation}
+````
+
+You will need to call pytest with the `--markdown-docs-syntax` option:
+```shell
+pytest --markdown-docs --markdown-docs-syntax=superfences
+```
+
+## MDX Comments for Metadata Options
+In .mdx files, you can use MDX comments to provide additional options for code blocks. These comments should be placed immediately before the code block and take the following form:
+
+```mdx
+{/* pmd-metadata: notest fixture:capsys */}
+```python
+print("hello")
+captured = capsys.readouterr()
+assert captured.out == "hello\n"
+```
+
+The following options can be specified using MDX comments:
+
+* notest: Exclude the code block from testing.
+* fixture:<name>: Apply named pytest fixtures to the code block.
+* continuation: Continue from the previous code block, allowing you to carry over state.
+
+This approach allows you to add metadata to the code block without modifying the code fence itself, making it particularly useful in MDX environments.
+
 ## Testing of this plugin
 
 You can test this module itself (sadly not using markdown tests at the moment) using pytest:
@@ -156,4 +201,4 @@ Or for fun, you can use this plugin to include testing of the validity of snippe
   * Line numbers are "wrong" for docstring-inlined snippets (since we don't know where in the file the docstring starts)
   * Line numbers are "wrong" for continuation blocks even in pure markdown files (can be worked out with some refactoring)
 * There are probably more appropriate ways to use pytest internal APIs to get more features "for free" - current state of the code is a bit "patch it til' it works".
-* Assertions are not rewritten w/ pretty data structure inspection like they are with regular pytest tests by default
+* Assertions are not rewritten w/ pretty data structure inspection like they are with regular pytest tests by default

pytest_markdown_docs-0.5.1/PKG-INFO → pytest_markdown_docs-0.7.0/README.md

@@ -1,24 +1,3 @@
-Metadata-Version: 2.1
-Name: pytest-markdown-docs
-Version: 0.5.1
-Summary: Run markdown code fences through pytest
-Home-page: https://github.com/modal-com/pytest-markdown-docs
-License: MIT
-Author: Modal Labs
-Requires-Python: >=3.8,<4.0
-Classifier: Framework :: Pytest
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: markdown-it-py (>=2.2.0,<4.0)
-Requires-Dist: pytest (>=7.0.0)
-Project-URL: Repository, https://github.com/modal-com/pytest-markdown-docs
-Description-Content-Type: text/markdown
-
 # Pytest Markdown Docs
 
 A plugin for [pytest](https://docs.pytest.org) that uses markdown code snippets from markdown files and docstrings as tests.
@@ -157,6 +136,39 @@ assert a + " world" == "hello world"
 ```
 ````
 
+### Compatibility with Material for MkDocs
+
+Material for Mkdocs is not compatible with the default syntax.
+
+But if the extension `pymdownx.superfences` is configured for mkdocs, the brace format can be used:
+````markdown
+```{.python continuation}
+````
+
+You will need to call pytest with the `--markdown-docs-syntax` option:
+```shell
+pytest --markdown-docs --markdown-docs-syntax=superfences
+```
+
+## MDX Comments for Metadata Options
+In .mdx files, you can use MDX comments to provide additional options for code blocks. These comments should be placed immediately before the code block and take the following form:
+
+```mdx
+{/* pmd-metadata: notest fixture:capsys */}
+```python
+print("hello")
+captured = capsys.readouterr()
+assert captured.out == "hello\n"
+```
+
+The following options can be specified using MDX comments:
+
+* notest: Exclude the code block from testing.
+* fixture:<name>: Apply named pytest fixtures to the code block.
+* continuation: Continue from the previous code block, allowing you to carry over state.
+
+This approach allows you to add metadata to the code block without modifying the code fence itself, making it particularly useful in MDX environments.
+
 ## Testing of this plugin
 
 You can test this module itself (sadly not using markdown tests at the moment) using pytest:

pytest_markdown_docs-0.7.0/pyproject.toml

@@ -0,0 +1,32 @@
+[project]
+name = "pytest-markdown-docs"
+version = "0.7.0"
+description = "Run markdown code fences through pytest"
+readme = "README.md"
+authors = [
+    { name = "Modal Labs"},
+    { name = "Elias Freider", email = "elias@modal.com" } 
+]
+license = "MIT"
+requires-python = ">=3.8"
+dependencies = [
+    "markdown-it-py>=2.2.0,<4.0",
+    "pytest>=7.0.0",
+]
+include = ["LICENSE"]
+
+[project.entry-points.pytest11]
+pytest_markdown_docs = "pytest_markdown_docs.plugin"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.uv]
+package=true
+dev-dependencies = [
+    "mypy>=1.12.1",
+    "pre-commit>=3.5.0",
+    "pytest~=8.1.0",
+    "ruff>=0.7.0",
+]

pytest_markdown_docs-0.7.0/pytest-markdown-docs.iml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="WEB_MODULE" version="4">
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/src" isTestSource="false" />
+      <sourceFolder url="file://$MODULE_DIR$/tests" isTestSource="true" />
+      <excludeFolder url="file://$MODULE_DIR$/dist" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>