pytest-csv-params 2.2.5__tar.gz → 2.3.0__tar.gz

{pytest_csv_params-2.2.5 → pytest_csv_params-2.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: pytest-csv-params
-Version: 2.2.5
+Version: 2.3.0
 Summary: Pytest plugin for Test Case Parametrization with CSV files
 Project-URL: repository, https://git.codebau.dev/pytest-plugins/pytest-csv-params
 Project-URL: homepage, https://git.codebau.dev/pytest-plugins/pytest-csv-params
@@ -107,7 +107,8 @@ Simply decorate your test method with `@csv_params` (`pytest_csv_params.decorato
 | `reuse_id_col`                | `bool` (optional)        | Allows to re-use the ID column as test data column (since 1.3.0), defaults to `False` for backwards compatibility                      | `True`                                                                                         | 
 | `skip_when_missing_csv_file`  | `bool` (optional)        | When the CSV data cannot be loaded, the test will be skipped (since 2.1.0), defaults to `False` for backwards compatibility            | `True`                                                                                         |
 | `skip_when_empty_csv_file`    | `bool` (optional)        | When the CSV data file is empty, the test will be skipped (since 2.1.0), defaults to `False` for backwards compatibility               | `True`                                                                                         |
-| `parameters_as_dictionary`    | `str` (optional)         | Instead of using one method argument per column, all columns are provided in the dict named with this parameter (since 2.2.0)          | `test_data`                                                                                    |
+| `parameters_as_dictionary`    | `str` (optional)         | Instead of using one method argument per column, all columns are provided in the dict named with this parameter (since 2.2.0)          | `"test_data"`                                                                                    |
+| `parameters_as_object`        | `str` or `(str, pytest_csv_params.object.TestCaseDataObjectFactory)` (optional) | Instead of using one method argument per column, all columns are provided as a object, either just named by `str`, or named by `str` and prepared with the given factory (since 2.3.0) | `"test_data"`, `("test_data", my_obj_factory)`  |
 
 ## CSV Format
 

{pytest_csv_params-2.2.5 → pytest_csv_params-2.3.0}/README.md

@@ -71,7 +71,8 @@ Simply decorate your test method with `@csv_params` (`pytest_csv_params.decorato
 | `reuse_id_col`                | `bool` (optional)        | Allows to re-use the ID column as test data column (since 1.3.0), defaults to `False` for backwards compatibility                      | `True`                                                                                         | 
 | `skip_when_missing_csv_file`  | `bool` (optional)        | When the CSV data cannot be loaded, the test will be skipped (since 2.1.0), defaults to `False` for backwards compatibility            | `True`                                                                                         |
 | `skip_when_empty_csv_file`    | `bool` (optional)        | When the CSV data file is empty, the test will be skipped (since 2.1.0), defaults to `False` for backwards compatibility               | `True`                                                                                         |
-| `parameters_as_dictionary`    | `str` (optional)         | Instead of using one method argument per column, all columns are provided in the dict named with this parameter (since 2.2.0)          | `test_data`                                                                                    |
+| `parameters_as_dictionary`    | `str` (optional)         | Instead of using one method argument per column, all columns are provided in the dict named with this parameter (since 2.2.0)          | `"test_data"`                                                                                    |
+| `parameters_as_object`        | `str` or `(str, pytest_csv_params.object.TestCaseDataObjectFactory)` (optional) | Instead of using one method argument per column, all columns are provided as a object, either just named by `str`, or named by `str` and prepared with the given factory (since 2.3.0) | `"test_data"`, `("test_data", my_obj_factory)`  |
 
 ## CSV Format
 

{pytest_csv_params-2.2.5 → pytest_csv_params-2.3.0}/_ptcsvp/exception.py

@@ -17,3 +17,11 @@ class PytestVersionTooOldException(RuntimeError):
 
     See the exception message for more details.
     """
+
+
+class ParametrizationConfigurationException(RuntimeError):
+    """
+    This exception is thrown when the configuration is invalid.
+
+    See the exception message for more details.
+    """

{pytest_csv_params-2.2.5 → pytest_csv_params-2.3.0}/_ptcsvp/parametrize.py

@@ -10,6 +10,7 @@ from warnings import warn
 import pytest
 from _pytest.mark import MarkDecorator
 
+from _ptcsvp.exception import ParametrizationConfigurationException
 from _ptcsvp.plugin import BASE_DIR_KEY, SKIP_EMPTY_KEY, SKIP_MISSING_KEY, Plugin
 from _ptcsvp.varname import make_name_valid
 from pytest_csv_params.dialect import CsvParamsDefaultDialect
@@ -19,6 +20,7 @@ from pytest_csv_params.exception import (
     CsvParamsDataFileInvalid,
     CsvParamsDataFileNotFound,
 )
+from pytest_csv_params.object import TestCaseDataElementObject, TestCaseDataElementType
 from pytest_csv_params.types import (
     BaseDir,
     CsvDialect,
@@ -27,6 +29,7 @@ from pytest_csv_params.types import (
     DictionaryName,
     HeaderRenames,
     IdColName,
+    ParametersObjectConfiguration,
     SkipConfig,
 )
 from pytest_csv_params.warning import CsvParamsOnlyOneColumnIsUsedAsIdAndDataWarning
@@ -106,6 +109,7 @@ def add_parametrization(  # pylint: disable=too-many-arguments
     skip_when_missing_csv_file: SkipConfig = None,
     skip_when_empty_csv_file: SkipConfig = None,
     parameters_as_dictionary: DictionaryName = None,
+    parameters_as_object: ParametersObjectConfiguration = None,
 ) -> MarkDecorator:
     """
     Parametrize a test function with data from a CSV file.
@@ -122,6 +126,9 @@ def add_parametrization(  # pylint: disable=too-many-arguments
     :param skip_when_missing_csv_file: Let tests automatically skip when CSV source is missing (since 2.1.0)
     :param skip_when_empty_csv_file: Let tests automatically skip when CSV source does not contain any test data (since 2.1.0)
     :param parameters_as_dictionary: Instead of using one argument per field, all arguments are passed as a dictionary with the given name (since 2.2.0)
+    :param parameters_as_object: Instead of using one argument per field, all arguments are passed as an object with the given name, or with the given name and created by the given factory (since 2.5.0)
+
+    :raises ParametersObjectConfiguration: When parameters_as_dictionary and parameters_as_object are used at the same time
 
     :returns: :meth:`pytest.mark.parametrize` mark decorator, filled with all the data from the CSV.
     """
@@ -186,8 +193,26 @@ def add_parametrization(  # pylint: disable=too-many-arguments
     id_data = None
     if id_col is not None:
         id_data = [tc_data["test_id"] for tc_data in data]
+    if parameters_as_dictionary is not None and parameters_as_object is not None:
+        raise ParametrizationConfigurationException(
+            "it is not possible to use parameters_as_dictionary and parameters_as_object at the same time"
+        )
+    param_header_name = "_"
     if parameters_as_dictionary is not None:
         param_header_name = make_name_valid(parameters_as_dictionary)
+    elif parameters_as_object is not None:
+        if isinstance(parameters_as_object, str):
+            param_header_name = make_name_valid(parameters_as_object)
+        elif isinstance(parameters_as_object, tuple):
+            if len(parameters_as_object) != 2:
+                raise ParametrizationConfigurationException("parameters_as_object must be a tuple of length 2")
+            if isinstance(parameters_as_object[0], str):
+                param_header_name = make_name_valid(parameters_as_object[0])
+            else:
+                raise ParametrizationConfigurationException("parameters_as_object[0] must be a string")
+        else:
+            raise ParametrizationConfigurationException("parameters_as_object must be a string or a tuple")
+    if parameters_as_dictionary is not None:
         list_of_dicts: list[dict[str, Any]] = []
         for tc_element in [tc_data["data"] for tc_data in data]:
             list_of_dicts.append(dict(zip(headers, tc_element)))
@@ -196,4 +221,29 @@ def add_parametrization(  # pylint: disable=too-many-arguments
             [pytest.param(d) for d in list_of_dicts],
             ids=id_data,
         )
+    elif parameters_as_object is not None:
+        object_factory = lambda: TestCaseDataElementObject()
+        if isinstance(parameters_as_object, tuple):
+            object_factory = parameters_as_object[1]
+        list_of_objects: list[TestCaseDataElementType] = []
+        for tc_element in [tc_data["data"] for tc_data in data]:
+            try:
+                tc_obj = object_factory()
+            except TypeError:
+                raise ParametrizationConfigurationException(
+                    "parameters_as_object[1] must be a TestCaseDataObjectFactory"
+                )
+            for idx, element in enumerate(tc_element):
+                try:
+                    tc_obj.register_value(headers[idx], element)
+                except (AttributeError, TypeError):
+                    raise ParametrizationConfigurationException(
+                        "parameters_as_object[1] must be a TestCaseDataObjectFactory"
+                    )
+            list_of_objects.append(tc_obj)
+        return pytest.mark.parametrize(
+            param_header_name,
+            [pytest.param(o) for o in list_of_objects],
+            ids=id_data,
+        )
     return pytest.mark.parametrize(headers, [tc_data["data"] for tc_data in data], ids=id_data)

{pytest_csv_params-2.2.5 → pytest_csv_params-2.3.0}/_ptcsvp/version.py

@@ -26,7 +26,7 @@ def check_python_version(min_version: tuple[int, int] = (3, 10), deprecation_bel
         raise PythonVersionTooOldException(f"At least Python {'.'.join(map(str, min_version))} required")
 
     if sys.version_info < deprecation_below:
-        warnings.warn(f"Python {'.'.join(map(str, deprecation_below))} is deprecated", DeprecationWarning)
+        warnings.warn(f"Python <{'.'.join(map(str, deprecation_below))} is deprecated", DeprecationWarning)
 
 
 def check_pytest_version(min_version: tuple[int, int] = (8, 3), deprecation_below: tuple[int, int] = (9, 0)) -> None:
@@ -47,4 +47,4 @@ def check_pytest_version(min_version: tuple[int, int] = (8, 3), deprecation_belo
         raise PytestVersionTooOldException(f"At least Pytest {pytest_min_version} required")
 
     if parsed_actual_version < parse(".".join(map(str, deprecation_below))):
-        warnings.warn(f"Pytest {'.'.join(map(str, deprecation_below))} is deprecated", DeprecationWarning)
+        warnings.warn(f"Pytest <{'.'.join(map(str, deprecation_below))} is deprecated", DeprecationWarning)

{pytest_csv_params-2.2.5 → pytest_csv_params-2.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pytest-csv-params"
-version = "2.2.5"
+version = "2.3.0"
 description = "Pytest plugin for Test Case Parametrization with CSV files"
 authors = [
     { name = "Juergen Edelbluth", email = "csv_params@jued.de" },
@@ -75,8 +75,10 @@ homepage = "https://git.codebau.dev/pytest-plugins/pytest-csv-params"
 [tool.pytest.ini_options]
 addopts = "--cov --cov-report=term-missing --cov-report=xml --junitxml=test-reports/pytest_csv_params.xml"
 filterwarnings=[
-    "ignore:.*zipimport.*",
-    "ignore:Creating a LegacyVersion has been deprecated and will be removed in the next major release",
+    "ignore::_pytest.warning_types.PytestRemovedIn10Warning",
+    "ignore:Python <3.11 is deprecated",
+    "ignore:Pytest <9.0 is deprecated",
+    "ignore::pytest_csv_params.warning.CsvParamsOnlyOneColumnIsUsedAsIdAndDataWarning",
 ]
 junit_family = "xunit2"
 junit_logging = "all"

pytest_csv_params-2.3.0/pytest_csv_params/object.py

@@ -0,0 +1,43 @@
+"""
+This module defines the smart object as test case data object.
+"""
+
+from collections.abc import Callable
+from typing import Any
+
+
+class TestCaseDataElementType:
+    """
+    This class represents an abstract test case data element.
+    """
+
+    def register_value(self, key: str, value: Any):
+        """
+        This method registers a value for a given key and is called by the csv_params plugin in order to populate the
+        test case data object.
+        """
+        raise NotImplementedError("register_value is not implemented")
+
+
+class TestCaseDataElementObject(TestCaseDataElementType):
+    """
+    This class represents a test case data element.
+    """
+
+    def register_value(self, key: str, value: Any):
+        """
+        Simply add the value as an attribute to the instance.
+        """
+        setattr(self, key, value)
+
+    def __getattribute__(self, name: str, /) -> Any:
+        return object.__getattribute__(self, name)
+
+    def __getattr__(self, name: str) -> None:
+        raise AttributeError(f"Attribute '{name}' not found")
+
+
+TestCaseDataObjectFactory = Callable[[], TestCaseDataElementType]
+"""
+This is how a factory function has to look like to build a test case data object.
+"""

{pytest_csv_params-2.2.5 → pytest_csv_params-2.3.0}/pytest_csv_params/plugin.py

@@ -4,20 +4,32 @@ This module contains all the code to initialize the pytest plugin. This is the e
 `pyproject.toml` as `pytest11`.
 """
 
+from _pytest.config import Config
+
 from _ptcsvp.cmdline import pytest_addoption as _pytest_addoption
 from _ptcsvp.configure import pytest_configure as _pytest_configure
 from _ptcsvp.configure import pytest_unconfigure as _pytest_unconfigure
 from _ptcsvp.version import check_pytest_version, check_python_version
 
-# Fist at all, check if the python & pytest version matches
-check_python_version()
-check_pytest_version()
+
+# First at all, check if the python & pytest version matches
+def version_check():
+    """
+    Check if the python & pytest version matches the required versions
+    """
+    check_python_version()
+    check_pytest_version()
+
 
 # Basic config
-pytest_configure = _pytest_configure
-"""
-Hook our :meth:`_ptcsvp.configure.pytest_configure` method to setup the plugin setup
-"""
+def pytest_configure(config: Config, plugin_name: str = "csv_params"):
+    """
+    Hook our :meth:`_ptcsvp.configure.pytest_configure` method to setup the plugin setup,
+    after executing version checks.
+    """
+    version_check()
+    _pytest_configure(config, plugin_name)
+
 
 pytest_unconfigure = _pytest_unconfigure
 """

{pytest_csv_params-2.2.5 → pytest_csv_params-2.3.0}/pytest_csv_params/types.py

@@ -8,6 +8,8 @@ import csv
 from collections.abc import Callable
 from typing import Any
 
+from pytest_csv_params.object import TestCaseDataObjectFactory
+
 DataCast = Callable[[str], Any]
 """
 A :class:`DataCast` describes how a data casting callable must be implemented. It requires one parameter of the type
@@ -77,3 +79,13 @@ DictionaryName = str | None
 The :class:`DictionaryName` describes the type of the `parameters_as_dictionary` parameter of the
 :meth:`~pytest_csv_params.decorator.csv_params` decorator. It is just an optional :class:`str`.
 """
+
+ParametersObjectConfiguration = str | tuple[str, TestCaseDataObjectFactory] | None
+"""
+The :class:`ParametersObjectConfiguration` describes the type of the `parameters_as_object` parameter of the
+:meth:`~pytest_csv_params.decorator.csv_params` decorator.
+
+- It can be either a :class:`str` which describes only the parameter name.
+- It can be a :class:`tuple` of :class:`str` and :class:`TestCaseDataObjectFactory` to describe the name and the factory.
+- Default is :obj:`None`, to disable the feature.
+"""