pytest-csv-params 2.1.1__tar.gz → 2.2.0__tar.gz

{pytest_csv_params-2.1.1 → pytest_csv_params-2.2.0}/.gitignore

@@ -232,3 +232,9 @@ fabric.properties
 
 # Android studio 3.1+ serialized cache file
 .idea/caches/build_file_checksums.ser
+
+# Python formatter
+.ruff-cache/
+
+# Working on a Mac?
+.DS_Store

{pytest_csv_params-2.1.1 → pytest_csv_params-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: pytest-csv-params
-Version: 2.1.1
+Version: 2.2.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
@@ -34,12 +34,13 @@ Requires-Python: <3.16,>=3.10
 Requires-Dist: pytest<10,>=8.3
 Description-Content-Type: text/markdown
 
-![pytest-csv-params](https://docs.codebau.dev/pytest-plugins/pytest-csv-params/_images/pytest-csv-params.png)
+from typing import Dict![pytest-csv-params](https://docs.codebau.dev/pytest-plugins/pytest-csv-params/_images/pytest-csv-params.png)
 
 # pytest-csv-params
 
 A pytest plugin to parametrize data-driven tests by CSV files.
 
+![Build Status](https://build.codebau.dev/buildStatus/icon?job=pytest-csv-params&subject=CI+Pipeline)
 [![PyPI - Downloads](https://img.shields.io/pypi/dw/pytest-csv-params?label=PyPI%20downloads&style=flat&logo=pypi)](https://pypi.org/project/pytest-csv-params/)
 [![PyPI - Version](https://img.shields.io/pypi/v/pytest-csv-params?label=PyPI%20version&style=flat&logo=pypi)](https://pypi.org/project/pytest-csv-params/)
 [![PyPI - Status](https://img.shields.io/pypi/status/pytest-csv-params?label=PyPI%20status&style=flat&logo=pypi)](https://pypi.org/project/pytest-csv-params/)
@@ -100,6 +101,7 @@ 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`                                                                                    |
 
 ## CSV Format
 
@@ -140,6 +142,19 @@ def test_texts(text_a, text_b, text_c):
     assert f"{text_a}:{text_b}" == text_c
 ```
 
+Use a dictionary instead of multiple arguments:
+
+```python
+from pytest_csv_params.decorator import csv_params
+
+@csv_params(
+  data_file="/data/test-lib/cases/texts.csv",
+  parameters_as_dictionary="test_data",
+)
+def test_texts(test_data: dict):
+    assert f"{test_data['text_a']}:{test_data['text_b']}" == test_data['text_c']
+```
+
 ### More complex example
 
 This example features nearly all things the plugin has to offer. You find this example also in the test cases, see `tests/test_complex_example.py`.

{pytest_csv_params-2.1.1 → pytest_csv_params-2.2.0}/README.md

@@ -1,9 +1,10 @@
-![pytest-csv-params](https://docs.codebau.dev/pytest-plugins/pytest-csv-params/_images/pytest-csv-params.png)
+from typing import Dict![pytest-csv-params](https://docs.codebau.dev/pytest-plugins/pytest-csv-params/_images/pytest-csv-params.png)
 
 # pytest-csv-params
 
 A pytest plugin to parametrize data-driven tests by CSV files.
 
+![Build Status](https://build.codebau.dev/buildStatus/icon?job=pytest-csv-params&subject=CI+Pipeline)
 [![PyPI - Downloads](https://img.shields.io/pypi/dw/pytest-csv-params?label=PyPI%20downloads&style=flat&logo=pypi)](https://pypi.org/project/pytest-csv-params/)
 [![PyPI - Version](https://img.shields.io/pypi/v/pytest-csv-params?label=PyPI%20version&style=flat&logo=pypi)](https://pypi.org/project/pytest-csv-params/)
 [![PyPI - Status](https://img.shields.io/pypi/status/pytest-csv-params?label=PyPI%20status&style=flat&logo=pypi)](https://pypi.org/project/pytest-csv-params/)
@@ -64,6 +65,7 @@ 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`                                                                                    |
 
 ## CSV Format
 
@@ -104,6 +106,19 @@ def test_texts(text_a, text_b, text_c):
     assert f"{text_a}:{text_b}" == text_c
 ```
 
+Use a dictionary instead of multiple arguments:
+
+```python
+from pytest_csv_params.decorator import csv_params
+
+@csv_params(
+  data_file="/data/test-lib/cases/texts.csv",
+  parameters_as_dictionary="test_data",
+)
+def test_texts(test_data: dict):
+    assert f"{test_data['text_a']}:{test_data['text_b']}" == test_data['text_c']
+```
+
 ### More complex example
 
 This example features nearly all things the plugin has to offer. You find this example also in the test cases, see `tests/test_complex_example.py`.

{pytest_csv_params-2.1.1 → pytest_csv_params-2.2.0}/_ptcsvp/parametrize.py

@@ -4,7 +4,7 @@ Parametrize a test function by CSV file
 
 import csv
 from pathlib import Path
-from typing import Any, List, Optional, TypedDict
+from typing import Any, List, Optional, TypedDict, Dict
 from warnings import warn
 
 import pytest
@@ -27,6 +27,7 @@ from pytest_csv_params.types import (
     HeaderRenames,
     IdColName,
     SkipConfig,
+    DictionaryName,
 )
 from pytest_csv_params.warning import CsvParamsOnlyOneColumnIsUsedAsIdAndDataWarning
 
@@ -110,6 +111,7 @@ def add_parametrization(  # pylint: disable=too-many-arguments
     reuse_id_col: bool = False,
     skip_when_missing_csv_file: SkipConfig = None,
     skip_when_empty_csv_file: SkipConfig = None,
+    parameters_as_dictionary: DictionaryName = None,
 ) -> MarkDecorator:
     """
     Parametrize a test function with data from a CSV file.
@@ -125,6 +127,7 @@ def add_parametrization(  # pylint: disable=too-many-arguments
     :param reuse_id_col: Allows re-using the ID col as test data column; defaults to `False` for backwards compatibility
     :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)
 
     :returns: :meth:`pytest.mark.parametrize` mark decorator, filled with all the data from the CSV.
     """
@@ -195,6 +198,16 @@ 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:
+        param_header_name = make_name_valid(parameters_as_dictionary)
+        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)))
+        return pytest.mark.parametrize(
+            param_header_name,
+            [pytest.param(d) for d in list_of_dicts],
+            ids=id_data,
+        )
     return pytest.mark.parametrize(
         headers, [tc_data["data"] for tc_data in data], ids=id_data
     )

{pytest_csv_params-2.1.1 → pytest_csv_params-2.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pytest-csv-params"
-version = "2.1.1"
+version = "2.2.0"
 description = "Pytest plugin for Test Case Parametrization with CSV files"
 authors = [
     { name = "Juergen Edelbluth", email = "csv_params@jued.de" },

{pytest_csv_params-2.1.1 → pytest_csv_params-2.2.0}/pytest_csv_params/types.py

@@ -67,6 +67,12 @@ The :class:`HeaderRenames` describes the type of the `header_renames` parameter
 
 SkipConfig = Optional[bool]
 """
-The :class:`SkipWhenMissingCSVFile` describes the type of the `skip_when_missing_csv_files` parameter of the
+The :class:`SkipWhenMissingCSVFile` describes the type of the `skip_when_*_csv_files` parameter of the
 :meth:`~pytest_csv_params.decorator.csv_params` decorator. It is just an optional :class:`bool`.
 """
+
+DictionaryName = Optional[str]
+"""
+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`.
+"""