pytest-respect 0.0.1__tar.gz

pytest_respect-0.0.1/.github/workflows/python-package.yml

@@ -0,0 +1,42 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: Python package
+
+on:
+  - push
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [ "3.10", "3.11", "3.12", "3.13" ]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          curl -LsSf https://astral.sh/uv/install.sh | sh
+          uv sync --dev --all-extras
+        # TODO run subset of tests with no extras
+
+      - name: Lint with ruff
+        run: uv run ruff check
+
+      - name: Type-check with pyright
+        run: uv run pyright
+
+      - name: Test with pytest
+        run: |
+          mkdir junit
+          uv run pytest tests/ --junitxml=junit/test-results.xml --cov-report=term-missing:skip-covered --cov=src |
+            tee junit/pytest-coverage.txt

pytest_respect-0.0.1/.gitignore

@@ -0,0 +1,18 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+junit/
+.coverage
+
+# IDEs
+/.idea
+
+# Virtual environments
+.venv
+
+# Local secrets for e.g. direnv
+/.envrc

pytest_respect-0.0.1/.python-version

@@ -0,0 +1 @@
+3.10

pytest_respect-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Ankeri
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pytest_respect-0.0.1/PKG-INFO

@@ -0,0 +1,47 @@
+Metadata-Version: 2.4
+Name: pytest-respect
+Version: 0.0.1
+Summary: Pytest plugin to load resource files relative to test code and to expect values to match them.
+Project-URL: homepage, https://github.com/Ankeri/pytest-respect
+Project-URL: issues, https://github.com/Ankeri/pytest-respect/issues
+Author-email: Logi Ragnarsson <logi.ragnarsson@ankeri.is>
+License-Expression: MIT
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Requires-Python: >=3.10
+Requires-Dist: pytest>=8.0.0
+Provides-Extra: jsonyx
+Requires-Dist: jsonyx>=2.0.0; extra == 'jsonyx'
+Provides-Extra: numpy
+Requires-Dist: numpy>=2.0.0; extra == 'numpy'
+Provides-Extra: pydantic
+Requires-Dist: pydantic>=2.0.0; extra == 'pydantic'
+Description-Content-Type: text/markdown
+
+# pytest-respect
+
+Pytest plugin to load resource files relative to test code and to expect values to match them. The name is a contraction of `resources.expect`, which is frequently typed when using this plugin.
+
+The primary use-case is running tests over moderately large datasets where adding them as constants in the test code would be cumbersome. This happens frequently with integration tests or when retrofitting tests onto an existing code-base.
+
+## Example
+
+The absolute simplest example is the following test. If it is found in a file called `foo/test_stuff.py`, then it will load the content of `foo/test_stuff/test_computation__input.json`, run the `compute` function on it, and assert that the output exactly matches the content of the file `foo/test_stuff/test_computation__output.json`.
+
+```python
+def test_computation(resources):
+    """Running compute on input.json creates an output matching output.json"""
+    input = resources.load_json("input")
+    output = compute(input)
+    resources.expect_json(output, "output")
+```

pytest_respect-0.0.1/README.md

@@ -0,0 +1,17 @@
+# pytest-respect
+
+Pytest plugin to load resource files relative to test code and to expect values to match them. The name is a contraction of `resources.expect`, which is frequently typed when using this plugin.
+
+The primary use-case is running tests over moderately large datasets where adding them as constants in the test code would be cumbersome. This happens frequently with integration tests or when retrofitting tests onto an existing code-base.
+
+## Example
+
+The absolute simplest example is the following test. If it is found in a file called `foo/test_stuff.py`, then it will load the content of `foo/test_stuff/test_computation__input.json`, run the `compute` function on it, and assert that the output exactly matches the content of the file `foo/test_stuff/test_computation__output.json`.
+
+```python
+def test_computation(resources):
+    """Running compute on input.json creates an output matching output.json"""
+    input = resources.load_json("input")
+    output = compute(input)
+    resources.expect_json(output, "output")
+```

pytest_respect-0.0.1/pyproject.toml

@@ -0,0 +1,89 @@
+# METADATA
+
+[project]
+name = "pytest-respect"
+version = "0.0.1"
+description = "Pytest plugin to load resource files relative to test code and to expect values to match them."
+urls.homepage = "https://github.com/Ankeri/pytest-respect"
+urls.issues = "https://github.com/Ankeri/pytest-respect/issues"
+readme = "README.md"
+authors = [
+    { name = "Logi Ragnarsson", email = "logi.ragnarsson@ankeri.is" }
+]
+license = "MIT"
+license-files = ["LICENSE.md"]
+
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: Implementation :: CPython",
+    "Framework :: Pytest"
+]
+
+
+# DEPENDENCIES
+
+requires-python = ">=3.10"
+
+dependencies = [
+    "pytest>=8.0.0",
+]
+
+[project.optional-dependencies]
+pydantic = ["pydantic>=2.0.0"]
+numpy = ["numpy>=2.0.0"]
+jsonyx = ["jsonyx>=2.0.0"]
+
+[dependency-groups]
+dev = [
+    "pyright==1.1.*",
+    "pytest-cov==6.*",
+    "pytest-mock==3.*",
+    "ruff==0.*",
+]
+
+
+# PYTEST PLUGIN
+
+[project.entry-points.pytest11]
+respect = "pytest_respect.plugin"
+
+
+# BUILD
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/pytest_respect"]
+
+
+# LINTING
+
+[tool.ruff]
+line-length = 140
+
+[tool.ruff.lint]
+select = [
+    "E", # pycodestyle
+    "F", # Pyflakes
+    "UP", # pyupgrade
+    "B", # flake8-bugbear
+    "I", # isort
+    "N", # pep8-naming
+]
+
+[tool.ruff.lint.per-file-ignores]
+"test_*.py" = [
+    "D401", # imperative mode: tests are doc'd with statements and fixtures with nouns
+    "N802", # snake_case: Allow test_MyFancyClass_method
+]

pytest_respect-0.0.1/src/pytest_respect/__init__.py

@@ -0,0 +1,9 @@
+from pytest_respect.resources import PathMaker, TestResources, list_resources
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "TestResources",
+    "PathMaker",
+    "list_resources",
+]

pytest_respect-0.0.1/src/pytest_respect/ext/__init__.py

@@ -0,0 +1 @@
+"""Extensions to base pytest-respect functionality."""

pytest_respect-0.0.1/src/pytest_respect/ext/jsonyx.py

@@ -0,0 +1,49 @@
+"""
+JSON encoders and loaders using the jsonyx library.
+See https://github.com/nineteendo/jsonyx
+"""
+
+from typing import Any
+
+
+def jsonyx_encoder(obj: Any) -> str:
+    """JSONYX encoder in very verbose mode."""
+    import jsonyx.allow
+
+    return jsonyx.dumps(
+        obj,
+        sort_keys=True,
+        indent=2,
+        allow=jsonyx.allow.NON_STR_KEYS,
+    )
+
+
+def jsonyx_compactish_encoder(obj: Any) -> str:
+    """JSONYX encoder which encodes lists and objects of primitives in compact mode."""
+    import jsonyx.allow
+
+    return jsonyx.dumps(
+        obj,
+        sort_keys=True,
+        indent=2,
+        indent_leaves=False,
+        allow=jsonyx.allow.NON_STR_KEYS,
+    )
+
+
+def jsonyx_compact_encoder(obj: Any) -> str:
+    """JSONYX encoder in very compact mode."""
+    import jsonyx.allow
+
+    return jsonyx.dumps(
+        obj,
+        sort_keys=True,
+        allow=jsonyx.allow.NON_STR_KEYS,
+    )
+
+
+def jsonyx_permissive_loader(text: str) -> Any:
+    """JSONYX loader in very permissive mode."""
+    import jsonyx.allow
+
+    return jsonyx.loads(text, allow=jsonyx.allow.EVERYTHING)

pytest_respect-0.0.1/src/pytest_respect/plugin.py

@@ -0,0 +1,9 @@
+import pytest
+
+from pytest_respect.resources import TestResources
+
+
+@pytest.fixture
+def resources(request: pytest.FixtureRequest) -> TestResources:
+    """Load file resources relative to test functions and fixtures."""
+    return TestResources(request, ndigits=4)