pytest-csv-params 2.0.0__tar.gz → 2.1.0__tar.gz

{pytest_csv_params-2.0.0 → pytest_csv_params-2.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: pytest-csv-params
-Version: 2.0.0
+Version: 2.1.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
@@ -31,7 +31,7 @@ Classifier: Topic :: Software Development :: Quality Assurance
 Classifier: Topic :: Software Development :: Testing
 Classifier: Topic :: Utilities
 Requires-Python: <3.16,>=3.10
-Requires-Dist: pytest<9.2,>=8.3
+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)
@@ -79,23 +79,27 @@ uv add --group dev pytest-csv-params
 
 ## Usage: Command Line Argument
 
-| Argument                | Required      | Description                                                          | Example                                      |
-|-------------------------|---------------|----------------------------------------------------------------------|----------------------------------------------|
-| `--csv-params-base-dir` | no (optional) | Define a base dir for all relative-path CSV data files (since 0.1.0) | `pytest --csv-params-base-dir /var/testdata` |
+| Argument                    | Required      | Description                                                                               | Example                                      |
+|-----------------------------|---------------|-------------------------------------------------------------------------------------------|----------------------------------------------|
+| `--csv-params-base-dir`     | no (optional) | Define a base dir for all relative-path CSV data files (since 0.1.0)                      | `pytest --csv-params-base-dir /var/testdata` |
+| `--csv-params-skip-missing` | no (optional) | Let tests automatically skip when CSV source is missing (since 2.1.0)                     | `pytest --csv-params-skip-missing`           |
+| `--csv-params-skip-empty`   | no (optional) | Let tests automatically skip when CSV source does not contain any test data (since 2.1.0) | `pytest --csv-params-skip-empty`             |
 
 ## Usage: Decorator
 
 Simply decorate your test method with `@csv_params` (`pytest_csv_params.decorator.csv_params`) and the following parameters:
 
-| Parameter        | Type                     | Description                                                                                                                            | Example                                                                                        |
-|------------------|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|
-| `data_file`      | `str`                    | The CSV file to use, relative or absolute path                                                                                         | `"/var/testdata/test1.csv"`                                                                    |
-| `base_dir`       | `str` (optional)         | Directory to look up relative CSV files (see `data_file`); overrides the command line argument                                         | `join(dirname(__file__), "assets")`                                                            |
-| `id_col`         | `str` (optional)         | Column name of the CSV that contains test case IDs                                                                                     | `"ID#"`                                                                                        |
-| `dialect`        | `csv.Dialect` (optional) | CSV Dialect definition (see [Python CSV Documentation](https://docs.python.org/3/library/csv.html#dialects-and-formatting-parameters)) | `csv.excel_tab`                                                                                |
-| `data_casts`     | `dict` (optional)        | Cast Methods for the CSV Data (see "Data Casting" below)                                                                               | `{ "a": int, "b": float }`                                                                     |
-| `header_renames` | `dict` (optional)        | Replace headers from the CSV file, so that they can be used as parameters for the test function (since 0.3.0)                          | `{ "Annual Amount of Bananas": "banana_count", "Cherry export price": "cherry_export_price" }` | 
-| `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`                                                                                         | 
+| Parameter                     | Type                     | Description                                                                                                                            | Example                                                                                        |
+|-------------------------------|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|
+| `data_file`                   | `str`                    | The CSV file to use, relative or absolute path                                                                                         | `"/var/testdata/test1.csv"`                                                                    |
+| `base_dir`                    | `str` (optional)         | Directory to look up relative CSV files (see `data_file`); overrides the command line argument                                         | `join(dirname(__file__), "assets")`                                                            |
+| `id_col`                      | `str` (optional)         | Column name of the CSV that contains test case IDs                                                                                     | `"ID#"`                                                                                        |
+| `dialect`                     | `csv.Dialect` (optional) | CSV Dialect definition (see [Python CSV Documentation](https://docs.python.org/3/library/csv.html#dialects-and-formatting-parameters)) | `csv.excel_tab`                                                                                |
+| `data_casts`                  | `dict` (optional)        | Cast Methods for the CSV Data (see "Data Casting" below)                                                                               | `{ "a": int, "b": float }`                                                                     |
+| `header_renames`              | `dict` (optional)        | Replace headers from the CSV file, so that they can be used as parameters for the test function (since 0.3.0)                          | `{ "Annual Amount of Bananas": "banana_count", "Cherry export price": "cherry_export_price" }` | 
+| `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`                                                                                         |
 
 ## CSV Format
 

{pytest_csv_params-2.0.0 → pytest_csv_params-2.1.0}/README.md

@@ -43,23 +43,27 @@ uv add --group dev pytest-csv-params
 
 ## Usage: Command Line Argument
 
-| Argument                | Required      | Description                                                          | Example                                      |
-|-------------------------|---------------|----------------------------------------------------------------------|----------------------------------------------|
-| `--csv-params-base-dir` | no (optional) | Define a base dir for all relative-path CSV data files (since 0.1.0) | `pytest --csv-params-base-dir /var/testdata` |
+| Argument                    | Required      | Description                                                                               | Example                                      |
+|-----------------------------|---------------|-------------------------------------------------------------------------------------------|----------------------------------------------|
+| `--csv-params-base-dir`     | no (optional) | Define a base dir for all relative-path CSV data files (since 0.1.0)                      | `pytest --csv-params-base-dir /var/testdata` |
+| `--csv-params-skip-missing` | no (optional) | Let tests automatically skip when CSV source is missing (since 2.1.0)                     | `pytest --csv-params-skip-missing`           |
+| `--csv-params-skip-empty`   | no (optional) | Let tests automatically skip when CSV source does not contain any test data (since 2.1.0) | `pytest --csv-params-skip-empty`             |
 
 ## Usage: Decorator
 
 Simply decorate your test method with `@csv_params` (`pytest_csv_params.decorator.csv_params`) and the following parameters:
 
-| Parameter        | Type                     | Description                                                                                                                            | Example                                                                                        |
-|------------------|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|
-| `data_file`      | `str`                    | The CSV file to use, relative or absolute path                                                                                         | `"/var/testdata/test1.csv"`                                                                    |
-| `base_dir`       | `str` (optional)         | Directory to look up relative CSV files (see `data_file`); overrides the command line argument                                         | `join(dirname(__file__), "assets")`                                                            |
-| `id_col`         | `str` (optional)         | Column name of the CSV that contains test case IDs                                                                                     | `"ID#"`                                                                                        |
-| `dialect`        | `csv.Dialect` (optional) | CSV Dialect definition (see [Python CSV Documentation](https://docs.python.org/3/library/csv.html#dialects-and-formatting-parameters)) | `csv.excel_tab`                                                                                |
-| `data_casts`     | `dict` (optional)        | Cast Methods for the CSV Data (see "Data Casting" below)                                                                               | `{ "a": int, "b": float }`                                                                     |
-| `header_renames` | `dict` (optional)        | Replace headers from the CSV file, so that they can be used as parameters for the test function (since 0.3.0)                          | `{ "Annual Amount of Bananas": "banana_count", "Cherry export price": "cherry_export_price" }` | 
-| `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`                                                                                         | 
+| Parameter                     | Type                     | Description                                                                                                                            | Example                                                                                        |
+|-------------------------------|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|
+| `data_file`                   | `str`                    | The CSV file to use, relative or absolute path                                                                                         | `"/var/testdata/test1.csv"`                                                                    |
+| `base_dir`                    | `str` (optional)         | Directory to look up relative CSV files (see `data_file`); overrides the command line argument                                         | `join(dirname(__file__), "assets")`                                                            |
+| `id_col`                      | `str` (optional)         | Column name of the CSV that contains test case IDs                                                                                     | `"ID#"`                                                                                        |
+| `dialect`                     | `csv.Dialect` (optional) | CSV Dialect definition (see [Python CSV Documentation](https://docs.python.org/3/library/csv.html#dialects-and-formatting-parameters)) | `csv.excel_tab`                                                                                |
+| `data_casts`                  | `dict` (optional)        | Cast Methods for the CSV Data (see "Data Casting" below)                                                                               | `{ "a": int, "b": float }`                                                                     |
+| `header_renames`              | `dict` (optional)        | Replace headers from the CSV file, so that they can be used as parameters for the test function (since 0.3.0)                          | `{ "Annual Amount of Bananas": "banana_count", "Cherry export price": "cherry_export_price" }` | 
+| `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`                                                                                         |
 
 ## CSV Format
 

pytest_csv_params-2.1.0/_ptcsvp/cmdline.py

@@ -0,0 +1,56 @@
+"""
+This pytest plugin requires command line arguments that are parsed from the pytest framework. This module contains code
+to instruct pytest to deliver the required values.
+"""
+
+from _pytest.config.argparsing import Parser
+
+HELP_TEXT_BASE_DIR = "set base dir for getting CSV data files from"
+"""
+This is the help text for the base dir command line argument that is added by :meth:`pytest_addoption`.
+"""
+
+HELP_TEXT_SKIP_MISSING = "skip tests when csv source is missing"
+"""
+This is the help text for the skip missing command line argument that is added by :meth:`pytest_addoption`.
+"""
+
+HELP_TEXT_SKIP_EMPTY = "skip tests when csv source is empty"
+"""
+This is the help text for the skip empty command line argument that is added by :meth:`pytest_addoption`.
+"""
+
+
+def pytest_addoption(parser: Parser, plugin_name: str = "csv-params") -> None:
+    """
+    Entrypoint for pytest to extend the own :class:`Parser` with the things we need extra.
+
+    :param parser: The pytest command line argument parser
+    :param plugin_name: The name of our plugin, with default value
+    """
+
+    group = parser.getgroup(plugin_name)
+    group.addoption(
+        f"--{plugin_name}-base-dir",
+        action="store",
+        type=str,
+        default=None,
+        required=False,
+        help=HELP_TEXT_BASE_DIR,
+    )
+
+    group.addoption(
+        f"--{plugin_name}-skip-missing",
+        action="store_true",
+        default=False,
+        required=False,
+        help=HELP_TEXT_SKIP_MISSING,
+    )
+
+    group.addoption(
+        f"--{plugin_name}-skip-empty",
+        action="store_true",
+        default=False,
+        required=False,
+        help=HELP_TEXT_SKIP_EMPTY,
+    )

{pytest_csv_params-2.0.0 → pytest_csv_params-2.1.0}/_ptcsvp/parametrize.py

@@ -10,7 +10,7 @@ from warnings import warn
 import pytest
 from _pytest.mark import MarkDecorator
 
-from _ptcsvp.plugin import BASE_DIR_KEY, Plugin
+from _ptcsvp.plugin import BASE_DIR_KEY, Plugin, SKIP_MISSING_KEY, SKIP_EMPTY_KEY
 from _ptcsvp.varname import make_name_valid
 from pytest_csv_params.dialect import CsvParamsDefaultDialect
 from pytest_csv_params.exception import (
@@ -26,6 +26,7 @@ from pytest_csv_params.types import (
     DataFile,
     HeaderRenames,
     IdColName,
+    SkipConfig,
 )
 from pytest_csv_params.warning import CsvParamsOnlyOneColumnIsUsedAsIdAndDataWarning
 
@@ -107,6 +108,8 @@ def add_parametrization(  # pylint: disable=too-many-arguments
     dialect: CsvDialect = CsvParamsDefaultDialect,
     header_renames: HeaderRenames = None,
     reuse_id_col: bool = False,
+    skip_when_missing_csv_file: SkipConfig = None,
+    skip_when_empty_csv_file: SkipConfig = None,
 ) -> MarkDecorator:
     """
     Parametrize a test function with data from a CSV file.
@@ -120,13 +123,30 @@ def add_parametrization(  # pylint: disable=too-many-arguments
     :param dialect: The CSV file dialect (CSV file format) to use
     :param header_renames: A dictonary mapping the header names from the CSV file to usable names for the tests
     :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)
 
     :returns: :meth:`pytest.mark.parametrize` mark decorator, filled with all the data from the CSV.
     """
     if base_dir is None:
         base_dir = getattr(Plugin, BASE_DIR_KEY, None)
-    csv_lines = read_csv(base_dir, data_file, dialect)
+    if skip_when_missing_csv_file is None:
+        skip_when_missing_csv_file = getattr(Plugin, SKIP_MISSING_KEY, False)
+    if skip_when_empty_csv_file is None:
+        skip_when_empty_csv_file = getattr(Plugin, SKIP_EMPTY_KEY, False)
+    try:
+        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"
+            )
+        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

{pytest_csv_params-2.0.0 → pytest_csv_params-2.1.0}/_ptcsvp/plugin.py

@@ -8,6 +8,14 @@ BASE_DIR_KEY = "__pytest_csv_params__config__base_dir"
 """
 The class attribute key for :class:`Plugin` to store the base dir command line argument value.
 """
+SKIP_MISSING_KEY = "__pytest_csv_params__config__skip_missing"
+"""
+The class attribute key for :class:`Plugin` to store the skip missing command line argument value.
+"""
+SKIP_EMPTY_KEY = "__pytest_csv_params__config__skip_empty"
+"""
+The class attribute key for :class:`Plugin` to store the skip empty command line argument value.
+"""
 
 
 class Plugin:  # pylint: disable=too-few-public-methods
@@ -25,3 +33,5 @@ class Plugin:  # pylint: disable=too-few-public-methods
         :param config: Pytest configuration
         """
         setattr(Plugin, BASE_DIR_KEY, config.option.csv_params_base_dir)
+        setattr(Plugin, SKIP_MISSING_KEY, config.option.csv_params_skip_missing)
+        setattr(Plugin, SKIP_EMPTY_KEY, config.option.csv_params_skip_empty)

{pytest_csv_params-2.0.0 → pytest_csv_params-2.1.0}/docs/pages/changelog.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## Version 2.1.0
+
+<u>Breaking Changes:</u> ✓ None
+
+<u>New Feature:</u>
+
+This version adds two new features, both are disabled by default to avoid breaking changes and keeping up backward compatibility:
+
+- Skip test if the CSV data source file is missing
+- Skip test if the CSV data file exists, but does not contain test data
+
+Both features are activated globally by a command line flag, or for specific tests by setting an parameter in the decorator.
+Refer to the documentation for details.
+
+<u>Deprecation Notice:</u>
+
+- One of the next versions will **drop Pytest 8.x support**
+- One of the next versions will **drop Python 3.10 support**
+
 ## Version 2.0.0
 
 This release does not contain any new features, but it increases the major version number, as it includes breaking changes

{pytest_csv_params-2.0.0 → pytest_csv_params-2.1.0}/docs/pages/config.md

@@ -6,15 +6,17 @@ These are the parameters for the decorator {meth}`pytest_csv_params.decorator.cs
 
 ### Overview
 
-| Parameter        | Type                     | Description                                                                                                                            | Example                                                                                        |
-|------------------|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|
-| `data_file`      | `str`                    | The CSV file to use, relative or absolute path                                                                                         | `"/var/testdata/test1.csv"`                                                                    |
-| `base_dir`       | `str` (optional)         | Directory to look up relative CSV files (see `data_file`); overrides the command line argument                                         | `join(dirname(__file__), "assets")`                                                            |
-| `id_col`         | `str` (optional)         | Column name of the CSV that contains test case IDs                                                                                     | `"ID#"`                                                                                        |
-| `dialect`        | `csv.Dialect` (optional) | CSV Dialect definition (see [Python CSV Documentation](https://docs.python.org/3/library/csv.html#dialects-and-formatting-parameters)) | `csv.excel_tab`                                                                                |
-| `data_casts`     | `dict` (optional)        | Cast Methods for the CSV Data (see "Data Casting" below)                                                                               | `{ "a": int, "b": float }`                                                                     |
-| `header_renames` | `dict` (optional)        | Replace headers from the CSV file, so that they can be used as parameters for the test function (since 0.3.0)                          | `{ "Annual Amount of Bananas": "banana_count", "Cherry export price": "cherry_export_price" }` | 
-| `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`                                                                                         | 
+| Parameter                     | Type                     | Description                                                                                                                            | Example                                                                                        |
+|-------------------------------|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|
+| `data_file`                   | `str`                    | The CSV file to use, relative or absolute path                                                                                         | `"/var/testdata/test1.csv"`                                                                    |
+| `base_dir`                    | `str` (optional)         | Directory to look up relative CSV files (see `data_file`); overrides the command line argument                                         | `join(dirname(__file__), "assets")`                                                            |
+| `id_col`                      | `str` (optional)         | Column name of the CSV that contains test case IDs                                                                                     | `"ID#"`                                                                                        |
+| `dialect`                     | `csv.Dialect` (optional) | CSV Dialect definition (see [Python CSV Documentation](https://docs.python.org/3/library/csv.html#dialects-and-formatting-parameters)) | `csv.excel_tab`                                                                                |
+| `data_casts`                  | `dict` (optional)        | Cast Methods for the CSV Data (see "Data Casting" below)                                                                               | `{ "a": int, "b": float }`                                                                     |
+| `header_renames`              | `dict` (optional)        | Replace headers from the CSV file, so that they can be used as parameters for the test function (since 0.3.0)                          | `{ "Annual Amount of Bananas": "banana_count", "Cherry export price": "cherry_export_price" }` | 
+| `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`                                                                                         |
 
 ### Detailed Description
 
@@ -253,15 +255,35 @@ def test_something_with_reusing_id_col(flux_setting: str, power_level: str, test
     ...
 ```
 
+#### `skip_when_missing_csv_file`
+
+Under normal circumstances, your whole test run would break, if a CSV file is missing. Setting this parameter to `True`
+marks the test to be skipped in that case instead of breaking the run. Also adds a message to the test report.
+
+There's also a command line argument `--skip-missing-csv-file` to turn on this behaviour globally.
+
+**Available since 2.1.0.** For backwards compatibility, this parameter is `False` by default.
+
+#### `skip_when_empty_csv_file`
+
+Under normal circumstances, your whole test run would break, if a CSV file is empty. Setting this parameter to `True`
+marks the test to be skipped in that case instead of breaking the run. Also adds a message to the test report.
+
+There's also a command line argument `--skip-empty-csv-file` to turn on this behaviour globally.
+
+**Available since 2.1.0.** For backwards compatibility, this parameter is `False` by default.
+
 ## Command Line Arguments
 
 These are the command line arguments for the pytest run.
 
 ### Overview
 
-| Argument                | Required      | Description                                                          | Example                                      |
-|-------------------------|---------------|----------------------------------------------------------------------|----------------------------------------------|
-| `--csv-params-base-dir` | no (optional) | Define a base dir for all relative-path CSV data files (since 0.1.0) | `pytest --csv-params-base-dir /var/testdata` |
+| Argument                    | Required      | Description                                                                               | Example                                      |
+|-----------------------------|---------------|-------------------------------------------------------------------------------------------|----------------------------------------------|
+| `--csv-params-base-dir`     | no (optional) | Define a base dir for all relative-path CSV data files (since 0.1.0)                      | `pytest --csv-params-base-dir /var/testdata` |
+| `--csv-params-skip-missing` | no (optional) | Let tests automatically skip when CSV source is missing (since 2.1.0)                     | `pytest --csv-params-skip-missing`           |
+| `--csv-params-skip-empty`   | no (optional) | Let tests automatically skip when CSV source does not contain any test data (since 2.1.0) | `pytest --csv-params-skip-empty`             |
 
 ### Detailed Description
 
@@ -271,6 +293,24 @@ This is a convenience command line argument. It allows you to set a base directo
 cases. If you use relative `data_file`s, this can be automatically prepended. You can still override this setting per
 test by using the `base_dir` configuration.
 
+#### `--csv-params-skip-missing`
+
+This changes the behaviour during test case collection. If set, a test case that is decorated with a non-existing
+CSV file, will be automatically marked as "skipped", instead of breaking the collection phase completely.
+
+Since this can easily cover an error in your test setup, the default behaviour is breaking.
+
+Available since 2.1.0.
+
+#### `--csv-params-skip-empty`
+
+Like `--csv-params-skip-missing`, this also changes the behaviour during test case collection. If set, a test that is
+decorated with an empty CSV file, will be automatically marked as "skipped", instead of breaking the collection phase completely.
+
+Since this can easily cover an error in your test setup, the default behaviour is breaking.
+
+Available since 2.1.0.
+
 ## How a CSV file is found
 
 ```text

{pytest_csv_params-2.0.0 → pytest_csv_params-2.1.0}/docs/pages/install.md

@@ -5,8 +5,8 @@ recommended.
 
 The minimum requirements are:
 
-- Python >= 3.9, < 3.14
-- Pytest >= 8.3
+- Python >= 3.10, < 3.16
+- Pytest >= 8.3, <10
 
 The plugin should run anywhere where these two things can be used.
 
@@ -42,6 +42,12 @@ Alternatively, you can use the codebau.dev package repository with `poetry` also
 
 For more information about `poetry`, visit [python-poetry.org](https://python-poetry.org/)
 
+## Install via `uv`
+
+```bash
+uv add --group dev pytest-csv-params
+```
+
 ## For development
 
 Please checkout the repository from [git.codebau.dev](https://git.codebau.dev/pytest-plugins/pytest-csv-params).

{pytest_csv_params-2.0.0 → pytest_csv_params-2.1.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pytest-csv-params"
-version = "2.0.0"
+version = "2.1.0"
 description = "Pytest plugin for Test Case Parametrization with CSV files"
 authors = [
     { name = "Juergen Edelbluth", email = "csv_params@jued.de" },
@@ -34,7 +34,7 @@ keywords = [
 requires-python = ">=3.10,<3.16"
 
 dependencies = [
-    "pytest>=8.3,<9.2",
+    "pytest>=8.3,<10",
 ]
 
 [dependency-groups]
@@ -149,4 +149,4 @@ build-backend = "hatchling.build"
 packages = [
     "_ptcsvp",
     "pytest_csv_params",
-]
+]

{pytest_csv_params-2.0.0 → pytest_csv_params-2.1.0}/pytest_csv_params/types.py

@@ -64,3 +64,9 @@ HeaderRenames = Optional[HeaderRenamesDict]
 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]
+"""
+The :class:`SkipWhenMissingCSVFile` describes the type of the `skip_when_missing_csv_files` parameter of the
+:meth:`~pytest_csv_params.decorator.csv_params` decorator. It is just an optional :class:`bool`.
+"""

pytest_csv_params-2.1.0/tests/assets/empty1.csv

@@ -0,0 +1 @@
+"#ID", "Animal", "Color"

{pytest_csv_params-2.0.0 → pytest_csv_params-2.1.0}/tests/plugin/test_cmd_line.py

@@ -11,7 +11,11 @@ from typing import Callable
 import pytest
 from _pytest.pytester import Pytester
 
-from _ptcsvp.cmdline import HELP_TEXT
+from _ptcsvp.cmdline import (
+    HELP_TEXT_BASE_DIR,
+    HELP_TEXT_SKIP_MISSING,
+    HELP_TEXT_SKIP_EMPTY,
+)
 
 
 @pytest.mark.parametrize(
@@ -38,7 +42,7 @@ def test_base_dir_param(
 
     csv_file = str(pytester.makefile(".csv", simple_test_csv).absolute())
 
-    parameters = ["-p", "no:bandit"]
+    parameters = []
     if base_dir:
         path = Path(csv_file)
         parameters.extend(["--csv-params-base-dir", str(path.parent.absolute())])
@@ -58,18 +62,39 @@ def test_help(pytester: Pytester) -> None:
     """
 
     result = pytester.runpytest("--help")
-    index_csv_params = -1
-    index_minus_minus = -1
-    index_help = -1
+    start_of_relevant_help = -1
+
+    base_dir_param_index = -1
+    skip_missing_param_index = -1
+    skip_empty_param_index = -1
+
+    index_help_base_dir = -1
+    index_help_skip_missing = -1
+    index_help_skip_empty = -1
 
     for index, line in enumerate(result.stdout.lines):
-        if "csv-params:" in line and index_csv_params < 0:
-            index_csv_params = index
+        if "csv-params:" in line and start_of_relevant_help < 0:
+            start_of_relevant_help = index
             continue
-        if "--csv-params-base-dir" in line and index_minus_minus < 0:
-            index_minus_minus = index
-        if HELP_TEXT in line and index_help < 0:
-            index_help = index
-
-    assert index_csv_params >= 0
-    assert index_csv_params < index_minus_minus <= index_help
+        if start_of_relevant_help < 0:
+            continue
+        if "--csv-params-base-dir" in line:
+            base_dir_param_index = index
+        if "--csv-params-skip-missing" in line:
+            skip_missing_param_index = index
+        if "--csv-params-skip-empty" in line:
+            skip_empty_param_index = index
+        if HELP_TEXT_BASE_DIR in line and base_dir_param_index > 0:
+            index_help_base_dir = index
+        if HELP_TEXT_SKIP_MISSING in line and skip_missing_param_index > 0:
+            index_help_skip_missing = index
+        if HELP_TEXT_SKIP_EMPTY in line and skip_empty_param_index > 0:
+            index_help_skip_empty = index
+
+    assert start_of_relevant_help >= 0
+    assert base_dir_param_index > start_of_relevant_help
+    assert index_help_base_dir > base_dir_param_index
+    assert skip_missing_param_index > start_of_relevant_help
+    assert index_help_skip_missing > skip_missing_param_index
+    assert skip_empty_param_index > start_of_relevant_help
+    assert index_help_skip_empty > skip_empty_param_index

{pytest_csv_params-2.0.0 → pytest_csv_params-2.1.0}/tests/plugin/test_plugin.py

@@ -26,7 +26,7 @@ def test_plugin_test_multiplication(
 
     pytester.makepyfile(simple_fruit_test(csv_file))
 
-    result = pytester.runpytest("-p", "no:bandit")
+    result = pytester.runpytest()
     result.assert_outcomes(passed=3, failed=1)
 
 
@@ -45,7 +45,7 @@ def test_plugin_test_error(
 
     pytester.makepyfile(simple_fruit_test(csv_file))
 
-    result = pytester.runpytest("-p", "no:bandit")
+    result = pytester.runpytest()
     result.assert_outcomes(errors=1)
 
 
@@ -64,7 +64,7 @@ def test_plugin_test_text_shorthand(
 
     pytester.makepyfile(simple_text_test(csv_file))
 
-    result = pytester.runpytest("-p", "no:bandit")
+    result = pytester.runpytest()
     result.assert_outcomes(passed=2, failed=1)
 
 
@@ -102,8 +102,6 @@ def test_plugin_all_tests_at_once(  # pylint: disable=too-many-arguments
     )
 
     result = pytester.runpytest(
-        "-p",
-        "no:bandit",
         Path("test_plugin_test_all_one.py"),
         Path("test_plugin_test_all_three.py"),
     )

{pytest_csv_params-2.0.0 → pytest_csv_params-2.1.0}/tests/test_docs_example.py

@@ -53,7 +53,7 @@ def get_dimensions(dimensions_str: str) -> Tuple[int, int, int]:
     dimensions_tuple = tuple(map(lambda x: int(x.strip()), dimensions_str.split("x")))
     if len(dimensions_tuple) != 3:
         raise ValueError("Dimensions invalid") from None
-    return dimensions_tuple  # type: ignore
+    return dimensions_tuple
 
 
 @csv_params(

pytest_csv_params-2.1.0/tests/test_empty_csv_files.py

@@ -0,0 +1,70 @@
+from os.path import join, dirname
+
+import pytest
+
+from pytest_csv_params.decorator import csv_params
+from pytest_csv_params.exception import CsvParamsDataFileInvalid
+
+
+@csv_params(
+    data_file=join(dirname(__file__), "assets", "empty1.csv"),
+    id_col="ID#",
+    skip_when_empty_csv_file=True,
+)
+def test_no_element() -> None:
+    pass
+
+
+@csv_params(
+    data_file=join(dirname(__file__), "assets", "empty2.csv"),
+    id_col="ID#",
+    skip_when_empty_csv_file=True,
+)
+def test_no_data() -> None:
+    pass
+
+
+def test_throws_exception_with_param_no_element() -> None:
+    with pytest.raises(CsvParamsDataFileInvalid):
+
+        @csv_params(
+            data_file=join(dirname(__file__), "assets", "empty1.csv"),
+            id_col="ID#",
+            skip_when_empty_csv_file=False,
+        )
+        def _test() -> None:
+            pass
+
+
+def test_throws_exception_with_param_no_data() -> None:
+    with pytest.raises(CsvParamsDataFileInvalid):
+
+        @csv_params(
+            data_file=join(dirname(__file__), "assets", "empty2.csv"),
+            id_col="ID#",
+            skip_when_empty_csv_file=False,
+        )
+        def _test() -> None:
+            pass
+
+
+def test_throws_exception_without_param_no_element() -> None:
+    with pytest.raises(CsvParamsDataFileInvalid):
+
+        @csv_params(
+            data_file=join(dirname(__file__), "assets", "empty1.csv"),
+            id_col="ID#",
+        )
+        def _test() -> None:
+            pass
+
+
+def test_throws_exception_without_param_no_data() -> None:
+    with pytest.raises(CsvParamsDataFileInvalid):
+
+        @csv_params(
+            data_file=join(dirname(__file__), "assets", "empty2.csv"),
+            id_col="ID#",
+        )
+        def _test() -> None:
+            pass

pytest_csv_params-2.1.0/tests/test_non_existing_csv_files.py

@@ -0,0 +1,38 @@
+from os.path import join, dirname
+
+import pytest
+
+from pytest_csv_params.decorator import csv_params
+from pytest_csv_params.exception import CsvParamsDataFileNotFound
+
+
+@csv_params(
+    data_file=join(dirname(__file__), "assets", "does-not-exist.csv"),
+    id_col="ID#",
+    skip_when_missing_csv_file=True,
+)
+def test_simple_skip() -> None:
+    pass
+
+
+def test_throws_exception_with_param() -> None:
+    with pytest.raises(CsvParamsDataFileNotFound):
+
+        @csv_params(
+            data_file=join(dirname(__file__), "assets", "does-not-exist.csv"),
+            id_col="ID#",
+            skip_when_missing_csv_file=False,
+        )
+        def _test() -> None:
+            pass
+
+
+def test_throws_exception_without_param() -> None:
+    with pytest.raises(CsvParamsDataFileNotFound):
+
+        @csv_params(
+            data_file=join(dirname(__file__), "assets", "does-not-exist.csv"),
+            id_col="ID#",
+        )
+        def _test() -> None:
+            pass

{pytest_csv_params-2.0.0 → pytest_csv_params-2.1.0}/uv.lock

@@ -805,7 +805,7 @@ wheels = [
 
 [[package]]
 name = "pytest-csv-params"
-version = "2.0.0"
+version = "2.1.0"
 source = { editable = "." }
 dependencies = [
     { name = "pytest" },
@@ -833,7 +833,7 @@ dev = ">=3.11"
 docs = ">=3.11,<3.15"
 
 [package.metadata]
-requires-dist = [{ name = "pytest", specifier = ">=8.3,<9.2" }]
+requires-dist = [{ name = "pytest", specifier = ">=8.3,<10" }]
 
 [package.metadata.requires-dev]
 dev = [

pytest_csv_params-2.0.0/.devcontainer/Dockerfile

@@ -1,31 +0,0 @@
-FROM alpine:latest
-
-LABEL org.opencontainers.image.authors="Juergen Edelbluth <dev@juergen.rocks>"
-
-USER root
-
-RUN apk update && apk upgrade
-RUN apk add patch build-base gcc zip xz-dev bzip2-dev zlib-dev libffi-dev linux-headers readline-dev openssl-dev openssl sqlite sqlite-dev 
-
-RUN apk add git gpg wget curl bash bash-completion shadow nano starship openssh-client openssh-sftp-server just
-RUN chsh -s /bin/bash
-
-RUN echo 'eval "$(starship init bash)"' >> ~/.bashrc
-
-RUN curl -L https://github.com/pyenv/pyenv-installer/raw/master/bin/pyenv-installer | /bin/bash
-RUN echo 'export PYENV_ROOT="$HOME/.pyenv"' >> ~/.bashrc
-RUN echo 'command -v pyenv >/dev/null || export PATH="$PYENV_ROOT/bin:$PATH"' >> ~/.bashrc
-RUN echo 'eval "$(pyenv init -)"' >> ~/.bashrc
-
-RUN /bin/bash -c ". ~/.bashrc && pyenv update"
-
-RUN /bin/bash -c ". ~/.bashrc && pyenv install 3.9"
-RUN /bin/bash -c ". ~/.bashrc && pyenv install 3.10"
-RUN /bin/bash -c ". ~/.bashrc && pyenv install 3.11"
-RUN /bin/bash -c ". ~/.bashrc && pyenv install 3.12"
-RUN /bin/bash -c ". ~/.bashrc && pyenv install 3.13"
-RUN /bin/bash -c ". ~/.bashrc && pyenv install 3.14"
-
-RUN /bin/bash -c ". ~/.bashrc && pyenv global 3.14"
-
-RUN /bin/bash -c ". ~/.bashrc && python3 -m pip install pipx && python3 -m pipx ensurepath && pipx install poetry"

pytest_csv_params-2.0.0/.devcontainer/devcontainer.json

@@ -1,18 +0,0 @@
-{
-    "name": "pytest-csv-params",
-    "workspaceFolder": "/workspaces/${localWorkspaceFolderBasename}",
-    "customizations": {
-        "vscode": {
-            "extensions": [
-                "ms-python.python",
-                "ms-python.debugpy",
-                "zeshuaro.vscode-python-poetry",
-                "ms-azuretools.vscode-docker"
-            ]
-        }
-    },
-    "build": {
-        "dockerfile": "Dockerfile"
-    },
-    "remoteUser": "root"
-}

pytest_csv_params-2.0.0/_ptcsvp/cmdline.py

@@ -1,30 +0,0 @@
-"""
-This pytest plugin requires command line arguments that are parsed from the pytest framework. This module contains code
-to instruct pytest to deliver the required values.
-"""
-
-from _pytest.config.argparsing import Parser
-
-HELP_TEXT = "set base dir for getting CSV data files from"
-"""
-This is the help text for the command line arguments that is added by :meth:`pytest_addoption`.
-"""
-
-
-def pytest_addoption(parser: Parser, plugin_name: str = "csv-params") -> None:
-    """
-    Entrypoint for pytest to extend the own :class:`Parser` with the things we need extra.
-
-    :param parser: The pytest command line argument parser
-    :param plugin_name: The name of our plugin, with default value
-    """
-
-    group = parser.getgroup(plugin_name)
-    group.addoption(
-        f"--{plugin_name}-base-dir",
-        action="store",
-        type=str,
-        default=None,
-        required=False,
-        help=HELP_TEXT,
-    )