Migrate existing code from other projects to package repository

Author: skeletorXVI

.gitignore

@@ -0,0 +1,80 @@
+# Python
+__pycache__/
+*.py[cod]
+*.pyd
+*.pyo
+*.pyz
+*.pyc
+*.so
+*.egg
+*.egg-info/
+dist/
+build/
+develop-eggs/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyCharm
+.idea/
+*.iml
+
+# VS Code
+.vscode/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# Environment
+.env
+.venv/
+env/
+venv/
+ENV/
+
+# Install
+*.log
+*.pot
+*.pyc
+*.pyo
+*.pyd
+*.so
+*.egg-info/
+dist/
+build/
+develop-eggs/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# Test
+.tox/
+coverage.xml
+.htmlcov/
+.pytest_cache/
+
+# OS
+.DS_Store
+Thumbs.db

LICENSE

@@ -0,0 +1,25 @@
+BSD 2-Clause License
+
+Copyright (c) 2024, Fabian Haenel
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -0,0 +1,74 @@
+[tool.poetry]
+name = "pytest-parametrization-annotations"
+version = "0.1.0"
+description = "A pytest library for parametrizing tests with type hints."
+authors = ["Fabian Haenel <contact@fabian-haenel.io>"]
+readme = "README.md"
+packages = [{include = "pytest_parametrization_annotation", from = "src"}]
+classifiers = [
+    # Status
+    "Development Status :: 4 - Beta",
+
+    # License
+    "License :: OSI Approved :: BSD License",
+
+    # Officially supported python versions
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+
+    # Topics
+    "Topic :: Software Development :: Testing",
+    "Topic :: Software Development :: Testing :: Unit",
+    "Topic :: Utilities",
+
+    # Misc
+    "Typing :: Typed",
+    "Framework :: Pytest",
+    "Intended Audience :: Developers",
+]
+
+[tool.poetry.plugins."pytest11"]
+pytest-parametrization-annotation = "pytest_parametrization_annotation.plugin"
+
+
+[tool.poetry.dependencies]
+python = ">=3.10"
+pytest = ">=7"
+
+
+[tool.poetry.group.linting.dependencies]
+ruff = "v0.3.4"
+black = "v24.3"
+mypy = "^1.9.0"
+
+[tool.poetry.group.testing.dependencies]
+pytest-cov = "*"
+jinja2 = ">=3"
+tox = "^4.14.2"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.pytest.ini_options]
+python_files = ["test_*.py"]
+pythonpath = ["src"]
+testpaths = ["tests/"]
+markers = [
+    "case: Define a test case based on type annotations",
+]
+
+[tool.ruff]
+src = ["src"]
+exclude = [".py.j2"]
+
+[tool.black]
+target-version = ["py310", "py311", "py312"]
+
+[tool.mypy]
+python_version = "3.10"
+warn_return_any = true
+warn_unused_configs = true
+files = ["src", "tests"]

poetry.lock

@@ -0,0 +1,7 @@
+from .annotation import Parametrized
+from .exceptions import ParameterValueUndefined
+
+__all__ = [
+    "Parametrized",
+    "ParameterValueUndefined",
+]

pyproject.toml

@@ -0,0 +1,12 @@
+from dataclasses import dataclass
+from typing import Any, Callable
+
+_Default = object()
+_DefaultCallable = lambda: None  # noqa: E731
+
+
+@dataclass(slots=True, kw_only=True, frozen=True)
+class Parametrized:
+    indirect: bool = False
+    default: Any = _Default
+    default_factory: Callable[[], Any] = _DefaultCallable

src/pytest_parametrization_annotation/__init__.py

@@ -0,0 +1,16 @@
+class ParameterValueUndefined(Exception):
+    def __init__(
+        self,
+        test: str,
+        case: int | str,
+        parameter: str,
+    ):
+        self.test = test
+        self.case = case
+        self.parameter = parameter
+
+    def __str__(self):
+        return f"{self.test} | Case '{self.case}': Failed to populate because the parameter '{self.parameter}' is not provided and default is not configured."  # noqa: E501
+
+    def __repr__(self):
+        return f"Test -> {self.test} | Case -> {self.case} | Field -> {self.parameter}"

src/pytest_parametrization_annotation/annotation.py

@@ -0,0 +1,85 @@
+from typing import Annotated, Any, Callable, Mapping, get_origin, get_type_hints
+
+from _pytest.python import Metafunc
+
+from pytest_parametrization_annotation.annotation import (
+    Parametrized,
+    _Default,
+    _DefaultCallable,
+)
+from pytest_parametrization_annotation.exceptions import ParameterValueUndefined
+
+
+def get_parameters_from_type_hints(func: Callable) -> dict[str, Parametrized]:
+    parameters = {}
+    for name, type_hint in get_type_hints(func, include_extras=True).items():
+        if get_origin(type_hint) is not Annotated:
+            continue
+
+        # Check if is annotated as a parameter
+        try:
+            parameter = next(
+                annotation
+                for annotation in type_hint.__metadata__
+                if annotation is Parametrized or isinstance(annotation, Parametrized)
+            )
+        except StopIteration:
+            continue
+
+        parameters[name] = (
+            parameter if isinstance(parameter, Parametrized) else Parametrized()
+        )
+    return parameters
+
+
+def get_parametrized_value(
+    kwargs: Mapping[str, Any], parameter: str, meta: Parametrized
+) -> Any:
+    if parameter in kwargs:
+        return kwargs[parameter]
+    if meta.default_factory is not _DefaultCallable:
+        return meta.default_factory()
+    if meta.default is not _Default:
+        return meta.default
+    raise KeyError(parameter)
+
+
+def register_parametrized_cases(metafunc: Metafunc):
+    function_definition = metafunc.definition
+    markers = [mark for mark in function_definition.iter_markers(name="case")]
+    if markers:
+        func = getattr(function_definition.module, function_definition.name)
+        parameters = get_parameters_from_type_hints(func)
+
+        # Exit early if no parameters are annotated to be parametrized
+        if not parameters:
+            return
+
+        cases = []
+        ids = []
+        for i, marker in enumerate(markers):
+            case_id = marker.args[0] if len(marker.args) > 0 else None
+            ids.append(case_id)
+
+            try:
+                cases.append(
+                    tuple(
+                        get_parametrized_value(marker.kwargs, parameter, meta)
+                        for parameter, meta in parameters.items()
+                    )
+                )
+            except KeyError as e:
+                raise ParameterValueUndefined(
+                    function_definition.nodeid,
+                    case_id or i,
+                    e.args[0],
+                ) from e
+
+        metafunc.parametrize(
+            tuple(parameters),
+            cases,
+            indirect=[
+                name for name, parameter in parameters.items() if parameter.indirect
+            ],
+            ids=ids,
+        )

src/pytest_parametrization_annotation/exceptions.py

@@ -0,0 +1,16 @@
+from __future__ import annotations
+
+from pytest_parametrization_annotation.functionality import register_parametrized_cases
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from _pytest.python import Metafunc
+    from _pytest.config import Config
+
+
+def pytest_configure(config: Config) -> None:
+    config.addinivalue_line("markers", "case: Parametrize the test with the provided values.")
+
+
+def pytest_generate_tests(metafunc: Metafunc) -> None:
+    register_parametrized_cases(metafunc)