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

{pytest_csv_params-2.1.1 → pytest_csv_params-2.2.2}/.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.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: pytest-csv-params
-Version: 2.1.1
+Version: 2.2.2
 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,14 @@ 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.
 
+![CI Pipeline Build Status](https://build.codebau.dev/buildStatus/icon?job=pytest-csv-params&subject=CI+Pipeline)
+![Carnary Build Status](https://build.codebau.dev/buildStatus/icon?job=pytest-csv-params_canary&subject=Carnary+Build)
 [![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 +102,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
 
@@ -117,6 +120,7 @@ This example uses the CSV example from above.
 ```python
 from pytest_csv_params.decorator import csv_params
 
+
 @csv_params(
     data_file="/data/test-lib/cases/addition.csv",
     id_col="ID#",
@@ -135,11 +139,26 @@ Shorthand example (no ID col, only string values):
 ```python
 from pytest_csv_params.decorator import csv_params
 
+
 @csv_params("/data/test-lib/cases/texts.csv")
 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`.
@@ -207,9 +226,12 @@ If you decide not to rename the columns, the test would look like this:
     },
 )
 def test_container_size_is_big_enough(
-    Bananas_Shipped: int, Single_Banana_Weight: float, Apples_Shipped: int, Single_Apple_Weight: float, Container_Size: int
-) -> None:
-    ...
+    Bananas_Shipped: int,
+    Single_Banana_Weight: float,
+    Apples_Shipped: int,
+    Single_Apple_Weight: float,
+    Container_Size: int,
+) -> None: ...
 ```
 
 ## Changelog

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

@@ -1,9 +1,11 @@
-![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.
 
+![CI Pipeline Build Status](https://build.codebau.dev/buildStatus/icon?job=pytest-csv-params&subject=CI+Pipeline)
+![Carnary Build Status](https://build.codebau.dev/buildStatus/icon?job=pytest-csv-params_canary&subject=Carnary+Build)
 [![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 +66,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
 
@@ -81,6 +84,7 @@ This example uses the CSV example from above.
 ```python
 from pytest_csv_params.decorator import csv_params
 
+
 @csv_params(
     data_file="/data/test-lib/cases/addition.csv",
     id_col="ID#",
@@ -99,11 +103,26 @@ Shorthand example (no ID col, only string values):
 ```python
 from pytest_csv_params.decorator import csv_params
 
+
 @csv_params("/data/test-lib/cases/texts.csv")
 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`.
@@ -171,9 +190,12 @@ If you decide not to rename the columns, the test would look like this:
     },
 )
 def test_container_size_is_big_enough(
-    Bananas_Shipped: int, Single_Banana_Weight: float, Apples_Shipped: int, Single_Apple_Weight: float, Container_Size: int
-) -> None:
-    ...
+    Bananas_Shipped: int,
+    Single_Banana_Weight: float,
+    Apples_Shipped: int,
+    Single_Apple_Weight: float,
+    Container_Size: int,
+) -> None: ...
 ```
 
 ## Changelog

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

@@ -4,13 +4,13 @@ Parametrize a test function by CSV file
 
 import csv
 from pathlib import Path
-from typing import Any, List, Optional, TypedDict
+from typing import Any, TypedDict
 from warnings import warn
 
 import pytest
 from _pytest.mark import MarkDecorator
 
-from _ptcsvp.plugin import BASE_DIR_KEY, Plugin, SKIP_MISSING_KEY, SKIP_EMPTY_KEY
+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
 from pytest_csv_params.exception import (
@@ -24,6 +24,7 @@ from pytest_csv_params.types import (
     CsvDialect,
     DataCasts,
     DataFile,
+    DictionaryName,
     HeaderRenames,
     IdColName,
     SkipConfig,
@@ -36,13 +37,11 @@ class TestCaseParameters(TypedDict):
     Type for a single test case. Contains the optional :attr:`test_id` and the test :attr:`data`.
     """
 
-    test_id: Optional[str]
-    data: List[Any]
+    test_id: str | None
+    data: list[Any]
 
 
-def read_csv(
-    base_dir: BaseDir, data_file: DataFile, dialect: CsvDialect
-) -> List[List[str]]:
+def read_csv(base_dir: BaseDir, data_file: DataFile, dialect: CsvDialect) -> list[list[str]]:
     """
     Get Data from CSV
 
@@ -57,27 +56,23 @@ def read_csv(
     if data_file is None:
         raise CsvParamsDataFileInvalid("Data file is None") from None
     csv_file = Path(data_file)
-    if not csv_file.is_absolute():
-        if base_dir is not None:
-            csv_file = Path(base_dir) / csv_file
+    if not csv_file.is_absolute() and base_dir is not None:
+        csv_file = Path(base_dir) / csv_file
     if not csv_file.exists() or not csv_file.is_file():
-        raise CsvParamsDataFileNotFound(f"Cannot find file: {str(csv_file)}") from None
+        raise CsvParamsDataFileNotFound(f"Cannot find file: {csv_file!s}") from None
     csv_lines = []
     try:
         with open(csv_file, newline="", encoding="utf-8") as csv_file_handle:
             csv_reader = csv.reader(csv_file_handle, dialect=dialect)
-            for row in csv_reader:
-                csv_lines.append(row)
-    except IOError as err:  # pragma: no cover
-        raise CsvParamsDataFileInaccessible(
-            f"Unable to read file: {str(csv_file)}"
-        ) from err
+            csv_lines.extend(csv_reader)
+    except OSError as err:  # pragma: no cover
+        raise CsvParamsDataFileInaccessible(f"Unable to read file: {csv_file!s}") from err
     except csv.Error as err:
         raise CsvParamsDataFileInvalid("Invalid data") from err
     return csv_lines
 
 
-def clean_headers(current_headers: List[str], replacing: HeaderRenames) -> List[str]:
+def clean_headers(current_headers: list[str], replacing: HeaderRenames) -> list[str]:
     """
     Clean the CSV file headers
 
@@ -110,6 +105,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 +121,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.
     """
@@ -138,18 +135,12 @@ def add_parametrization(  # pylint: disable=too-many-arguments
         csv_lines = read_csv(base_dir, data_file, dialect)
     except (CsvParamsDataFileNotFound, CsvParamsDataFileInaccessible):
         if skip_when_missing_csv_file:
-            return pytest.mark.skip(
-                reason=f"CSV file '{data_file}' not found, test needs to be skipped"
-            )
+            return pytest.mark.skip(reason=f"CSV file '{data_file}' not found, test needs to be skipped")
         raise
     if len(csv_lines) < 2:
         if skip_when_empty_csv_file:
-            return pytest.mark.skip(
-                reason=f"CSV file '{data_file}' has no test data in it, test needs to be skipped"
-            )
-        raise CsvParamsDataFileInvalid(
-            "File does not contain a single data row"
-        ) from None
+            return pytest.mark.skip(reason=f"CSV file '{data_file}' has no test data in it, test needs to be skipped")
+        raise CsvParamsDataFileInvalid("File does not contain a single data row") from None
     id_index = -1
     headers = csv_lines.pop(0)
     if id_col is not None:
@@ -168,7 +159,7 @@ def add_parametrization(  # pylint: disable=too-many-arguments
                 CsvParamsOnlyOneColumnIsUsedAsIdAndDataWarning,
             )
     headers = clean_headers(headers, header_renames)
-    data: List[TestCaseParameters] = []
+    data: list[TestCaseParameters] = []
     for data_line in csv_lines:
         line = list(map(str, data_line))
         if len(line) == 0:
@@ -195,6 +186,14 @@ 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]
-    return pytest.mark.parametrize(
-        headers, [tc_data["data"] for tc_data in data], ids=id_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.2}/_ptcsvp/varname.py

@@ -29,10 +29,7 @@ def is_valid_name(name: str) -> bool:
     """
     if (
         keyword.iskeyword(name)
-        or (
-            hasattr(keyword, "issoftkeyword")
-            and getattr(keyword, "issoftkeyword")(name)
-        )
+        or (hasattr(keyword, "issoftkeyword") and keyword.issoftkeyword(name))
         or getattr(builtins, name, None) is not None
     ):
         return False

{pytest_csv_params-2.1.1 → pytest_csv_params-2.2.2}/_ptcsvp/version.py

@@ -6,13 +6,13 @@ During the setup phase of the plugin (see :mod:`pytest_csv_params.plugin`) these
 """
 
 import sys
-from typing import Tuple
 
-from .exception import PythonVersionTooOldException, PytestVersionTooOldException
 from packaging.version import parse
 
+from .exception import PytestVersionTooOldException, PythonVersionTooOldException
 
-def check_python_version(min_version: Tuple[int, int] = (3, 10)) -> None:
+
+def check_python_version(min_version: tuple[int, int] = (3, 10)) -> None:
     """
     Check if the current version is at least 3.10
 
@@ -21,12 +21,10 @@ def check_python_version(min_version: Tuple[int, int] = (3, 10)) -> None:
     """
 
     if sys.version_info < min_version:
-        raise PythonVersionTooOldException(
-            f"At least Python {'.'.join(map(str, min_version))} required"
-        )
+        raise PythonVersionTooOldException(f"At least Python {'.'.join(map(str, min_version))} required")
 
 
-def check_pytest_version(min_version: Tuple[int, int] = (8, 3)) -> None:
+def check_pytest_version(min_version: tuple[int, int] = (8, 3)) -> None:
     """
     Check if the current version is at least 8.3
 
@@ -40,6 +38,4 @@ def check_pytest_version(min_version: Tuple[int, int] = (8, 3)) -> None:
     parsed_min_version = parse(pytest_min_version)
     parsed_actual_version = parse(pytest_version)
     if parsed_actual_version < parsed_min_version:
-        raise PytestVersionTooOldException(
-            f"At least Pytest {pytest_min_version} required"
-        )
+        raise PytestVersionTooOldException(f"At least Pytest {pytest_min_version} required")

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

@@ -1,6 +1,6 @@
 [project]
 name = "pytest-csv-params"
-version = "2.1.1"
+version = "2.2.2"
 description = "Pytest plugin for Test Case Parametrization with CSV files"
 authors = [
     { name = "Juergen Edelbluth", email = "csv_params@jued.de" },
@@ -43,6 +43,7 @@ dev = [
     "pytest-mock (>=3.16.0,<4.0.0)",
     "pytest-clarity>=1.0.1",
     "pytest-order>=1.0.1",
+    "ruff>=0.16.10",
 ]
 
 docs = [
@@ -82,12 +83,6 @@ junit_log_passing_tests = true
 junit_duration_report = "call"
 junit_suite_name = "pytest-csv-params"
 
-bandit_targets = [
-    "pytest_csv_params",
-    "_ptcsvp",
-]
-bandit_recurse = "True"
-
 [tool.coverage]
 
 [tool.coverage.run]
@@ -156,3 +151,61 @@ only-include = [
     "_ptcsvp",
     "pytest_csv_params",
 ]
+[tool.ruff]
+# Exclude a variety of commonly ignored directories.
+extend-exclude = [
+    ".ci",
+    ".junie",
+    ".venv",
+    "dist",
+    "docs",
+    "*.egg-info",
+    "test-reports",
+    ".coverage",
+    ".*_cacne",
+]
+
+# Same as Black.
+line-length = 120
+indent-width = 4
+
+# Assume Python 3.10
+target-version = "py310"
+
+[tool.ruff.lint]
+# select = [...]  # See the Default Rules page for the full listing.
+ignore = []
+
+# Allow fix for all enabled rules (when `--fix`) is provided.
+fixable = ["ALL"]
+unfixable = []
+
+# Allow unused variables when underscore-prefixed.
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+[tool.ruff.format]
+# Like Black, use double quotes for strings.
+quote-style = "double"
+
+# Like Black, indent with spaces, rather than tabs.
+indent-style = "space"
+
+# Like Black, respect magic trailing commas.
+skip-magic-trailing-comma = false
+
+# Like Black, automatically detect the appropriate line ending.
+line-ending = "auto"
+
+# Enable auto-formatting of code examples in docstrings. Markdown,
+# reStructuredText code/literal blocks and doctests are all supported.
+#
+# This is currently disabled by default, but it is planned for this
+# to be opt-out in the future.
+docstring-code-format = true
+
+# Set the line length limit used when formatting code snippets in
+# docstrings.
+#
+# This only has an effect when the `docstring-code-format` setting is
+# enabled.
+docstring-code-line-length = "dynamic"

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

@@ -5,7 +5,8 @@ Some types are somewhat complex, and it is easier to use a single word/reference
 """
 
 import csv
-from typing import Any, Callable, Dict, Optional, Type
+from collections.abc import Callable
+from typing import Any
 
 DataCast = Callable[[str], Any]
 """
@@ -13,26 +14,26 @@ A :class:`DataCast` describes how a data casting callable must be implemented. I
 :class:`str` and can return anything that is required.
 """
 
-DataCastDict = Dict[str, DataCast]
+DataCastDict = dict[str, DataCast]
 """
 A :class:`DataCastDict` describes how a dictionary of data casting callables must look like. The key is a :class:`str`
 describing the column name, the value is a :class:`DataCast`.
 """
 
-DataCasts = Optional[DataCastDict]
+DataCasts = DataCastDict | None
 """
 The :class:`DataCasts` type describes the type of the `data_casts` parameter of the
 :meth:`~pytest_csv_params.decorator.csv_params` decorator. An optional :class:`DataCastDict`.
 """
 
-BaseDir = Optional[str]
+BaseDir = str | None
 """
 The :class:`BaseDir` describes the type of the `base_dir` parameter of the
 :meth:`~pytest_csv_params.decorator.csv_params` decorator to search for non-absolute CSV files. It is simply an optional
 :class:`str`.
 """
 
-IdColName = Optional[str]
+IdColName = str | None
 """
 The :class:`IdColName` describes the type of the `id_col` parameter of the
 :meth:`~pytest_csv_params.decorator.csv_params` decorator to name the ID column from a CSV file. It is simply an
@@ -46,27 +47,33 @@ The :class:`DataFile` describes the type if the `data_file` parameter of the
 :class:`str`.
 """
 
-CsvDialect = Type[csv.Dialect]
+CsvDialect = type[csv.Dialect]
 """
 The :class:`CsvDialect` describes the type of the `dialect` parameter of the
 :meth:`~pytest_csv_params.decorator.csv_params` decorator. It is required, but it has an default value in
 :class:`pytest_csv_params.dialect.CsvParamsDefaultDialect`.
 """
 
-HeaderRenamesDict = Dict[str, str]
+HeaderRenamesDict = dict[str, str]
 """
 The :class:`HeaderRenamesDict` describes how a dictionary of header renames must look. Keys and values must both be of
 type :class:`str`.
 """
 
-HeaderRenames = Optional[HeaderRenamesDict]
+HeaderRenames = HeaderRenamesDict | None
 """
 The :class:`HeaderRenames` describes the type of the `header_renames` parameter of the
 :meth:`~pytest_csv_params.decorator.csv_params` decorator. It is just an optional :class:`HeaderRenamesDict`.
 """
 
-SkipConfig = Optional[bool]
+SkipConfig = bool | None
 """
-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 = 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`.
+"""