pytest-csv-params 1.1.0__tar.gz → 1.3.2__tar.gz

{pytest_csv_params-1.1.0 → pytest_csv_params-1.3.2}/PKG-INFO

@@ -1,33 +1,70 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: pytest-csv-params
-Version: 1.1.0
+Version: 1.3.2
 Summary: Pytest plugin for Test Case Parametrization with CSV files
-Home-page: https://git.codebau.dev/pytest-plugins/pytest-csv-params
-License: MIT
+License: Copyright Juergen Edelbluth and other contributors, https://juergen.rocks/
+         
+         Permission is hereby granted, free of charge, to any person obtaining
+         a copy of this software and associated documentation files (the
+         "Software"), to deal in the Software without restriction, including
+         without limitation the rights to use, copy, modify, merge, publish,
+         distribute, sublicense, and/or sell copies of the Software, and to
+         permit persons to whom the Software is furnished to do so, subject to
+         the following conditions:
+         
+         The above copyright notice and this permission notice shall be
+         included in all copies or substantial portions of the Software.
+         
+         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+         EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+         MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+         NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+         LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+         OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+         WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 Keywords: py.test,pytest,csv,params,parametrize,pytest-plugin,ddt,data-driven
 Author: Juergen Edelbluth
 Author-email: csv_params@jued.de
-Requires-Python: >=3.8,<4.0
+Requires-Python: >=3.9,<3.14
 Classifier: Development Status :: 5 - Production/Stable
-Classifier: Environment :: Console
 Classifier: Environment :: Plugins
+Classifier: Environment :: Console
 Classifier: Framework :: Pytest
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: MacOS :: MacOS X
-Classifier: Operating System :: Microsoft :: Windows
-Classifier: Operating System :: POSIX
-Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: MacOS :: MacOS X
 Classifier: Topic :: Utilities
-Requires-Dist: pytest (>=7.4.0,<8.0.0)
+Provides-Extra: dev
+Requires-Dist: Sphinx (>=5.1.1,<6) ; extra == "dev"
+Requires-Dist: attrs (>=24.2)
+Requires-Dist: livereload (>=2.6.3) ; extra == "dev"
+Requires-Dist: myst-parser (>=0.18.0) ; extra == "dev"
+Requires-Dist: pytest (>=8.3,<9)
+Requires-Dist: pytest-bandit (>=0.6.1) ; extra == "dev"
+Requires-Dist: pytest-black (>=0.3.12) ; extra == "dev"
+Requires-Dist: pytest-clarity (>=1.0.1) ; extra == "dev"
+Requires-Dist: pytest-cov (>=4.1) ; extra == "dev"
+Requires-Dist: pytest-isort (>=3.0) ; extra == "dev"
+Requires-Dist: pytest-mock (>=3.8.2) ; extra == "dev"
+Requires-Dist: pytest-order (>=1.0.1,<2) ; extra == "dev"
+Requires-Dist: sphinx-autodoc-typehints (>=1.19.2,<2) ; extra == "dev"
+Requires-Dist: sphinx-material (>=0.0.35) ; extra == "dev"
+Requires-Dist: tomli (>=2.0.1) ; extra == "dev"
+Requires-Dist: tox (>=3.25.1,<4) ; extra == "dev"
+Requires-Dist: tox-poetry (>=0.4.1) ; extra == "dev"
 Project-URL: Changelog, https://docs.codebau.dev/pytest-plugins/pytest-csv-params/pages/changelog.html
 Project-URL: Documentation, https://docs.codebau.dev/pytest-plugins/pytest-csv-params/
+Project-URL: Homepage, https://git.codebau.dev/pytest-plugins/pytest-csv-params
 Project-URL: Issue Tracker, https://git.codebau.dev/pytest-plugins/pytest-csv-params/issues
 Project-URL: Repository, https://git.codebau.dev/pytest-plugins/pytest-csv-params
 Project-URL: Releases, https://git.codebau.dev/pytest-plugins/pytest-csv-params/releases
@@ -48,8 +85,8 @@ A pytest plugin to parametrize data-driven tests by CSV files.
 
 ## Requirements
  
-- Python 3.8, 3.9, 3.10, 3.11
-- pytest >= 7.4
+- Python 3.9, 3.10, 3.11, 3.12, 3.13
+- pytest >= 8.3
 
 There's no operating system dependent code in this plugin, so it should run anywhere where pytest runs.
 
@@ -64,7 +101,7 @@ pip install pytest-csv-params
 ... or poetry ...
 
 ```bash
-poetry add --dev pytest-csv-params
+poetry add --group dev pytest-csv-params
 ```
 
 ## Documentation / User Guide
@@ -90,6 +127,7 @@ Simply decorate your test method with `@csv_params` (`pytest_csv_params.decorato
 | `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`                                                                                         | 
 
 ## CSV Format
 

{pytest_csv_params-1.1.0 → pytest_csv_params-1.3.2}/README.md

@@ -12,8 +12,8 @@ A pytest plugin to parametrize data-driven tests by CSV files.
 
 ## Requirements
  
-- Python 3.8, 3.9, 3.10, 3.11
-- pytest >= 7.4
+- Python 3.9, 3.10, 3.11, 3.12, 3.13
+- pytest >= 8.3
 
 There's no operating system dependent code in this plugin, so it should run anywhere where pytest runs.
 
@@ -28,7 +28,7 @@ pip install pytest-csv-params
 ... or poetry ...
 
 ```bash
-poetry add --dev pytest-csv-params
+poetry add --group dev pytest-csv-params
 ```
 
 ## Documentation / User Guide
@@ -54,6 +54,7 @@ Simply decorate your test method with `@csv_params` (`pytest_csv_params.decorato
 | `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`                                                                                         | 
 
 ## CSV Format
 

{pytest_csv_params-1.1.0 → pytest_csv_params-1.3.2}/_ptcsvp/parametrize.py

@@ -1,9 +1,11 @@
 """
 Parametrize a test function by CSV file
 """
+
 import csv
 from pathlib import Path
 from typing import Any, List, Optional, TypedDict
+from warnings import warn
 
 import pytest
 from _pytest.mark import MarkDecorator
@@ -18,6 +20,7 @@ from pytest_csv_params.exception import (
     CsvParamsDataFileNotFound,
 )
 from pytest_csv_params.types import BaseDir, CsvDialect, DataCasts, DataFile, HeaderRenames, IdColName
+from pytest_csv_params.warning import CsvParamsOnlyOneColumnIsUsedAsIdAndDataWarning
 
 
 class TestCaseParameters(TypedDict):
@@ -92,6 +95,7 @@ def add_parametrization(  # pylint: disable=too-many-arguments
     data_casts: DataCasts = None,
     dialect: CsvDialect = CsvParamsDefaultDialect,
     header_renames: HeaderRenames = None,
+    reuse_id_col: bool = False,
 ) -> MarkDecorator:
     """
     Parametrize a test function with data from a CSV file.
@@ -104,6 +108,7 @@ def add_parametrization(  # pylint: disable=too-many-arguments
     :param data_casts: Methods to cast a column's data into a format that is required for the test
     :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
 
     :returns: :meth:`pytest.mark.parametrize` mark decorator, filled with all the data from the CSV.
     """
@@ -117,11 +122,18 @@ def add_parametrization(  # pylint: disable=too-many-arguments
     if id_col is not None:
         try:
             id_index = headers.index(id_col)
-            del headers[id_index]
+            if not reuse_id_col:
+                del headers[id_index]
         except ValueError as err:
             raise CsvParamsDataFileInvalid(f"Cannot find ID column '{id_col}'") from err
-    if len(headers) == 0:
-        raise CsvParamsDataFileInvalid("File seems only to have IDs") from None
+        if not reuse_id_col and len(headers) == 0:
+            raise CsvParamsDataFileInvalid("File seems only to have IDs") from None
+        elif reuse_id_col and len(headers) == 1:
+            warn(
+                f"it seems you're using only one column of data for this test, "
+                f"which is also used as ID column (col: '{id_col}', from file: '{data_file}')",
+                CsvParamsOnlyOneColumnIsUsedAsIdAndDataWarning,
+            )
     headers = clean_headers(headers, header_renames)
     data: List[TestCaseParameters] = []
     for data_line in csv_lines:
@@ -130,7 +142,10 @@ def add_parametrization(  # pylint: disable=too-many-arguments
             continue
         test_id = None
         if id_index >= 0:
-            test_id = line.pop(id_index)
+            if reuse_id_col:
+                test_id = line[id_index]
+            else:
+                test_id = line.pop(id_index)
         if len(headers) != len(line):
             raise CsvParamsDataFileInvalid("Header and Data length mismatch") from None
         if data_casts is not None:

{pytest_csv_params-1.1.0 → pytest_csv_params-1.3.2}/_ptcsvp/version.py

@@ -4,6 +4,7 @@ the pytest version is recent enough (:meth:`check_pytest_version`).
 
 During the setup phase of the plugin (see :mod:`pytest_csv_params.plugin`) these methods are called.
 """
+
 import sys
 from typing import Tuple
 

{pytest_csv_params-1.1.0 → pytest_csv_params-1.3.2}/pyproject.toml

@@ -1,15 +1,12 @@
-[tool.poetry]
+[project]
 name = "pytest-csv-params"
-version = "1.1.0"
+version = "1.3.2"
 description = "Pytest plugin for Test Case Parametrization with CSV files"
-authors = ["Juergen Edelbluth <csv_params@jued.de>"]
-license = "MIT"
-repository = "https://git.codebau.dev/pytest-plugins/pytest-csv-params"
-homepage = "https://git.codebau.dev/pytest-plugins/pytest-csv-params"
-readme = "README.md"
-keywords = [
-    "py.test", "pytest", "csv", "params", "parametrize", "pytest-plugin", "ddt", "data-driven"
+authors = [
+    { name = "Juergen Edelbluth", email = "csv_params@jued.de" },
 ]
+license = { file = "LICENSE.txt" }
+readme = "README.md"
 classifiers = [
     "Development Status :: 5 - Production/Stable",
     "Environment :: Plugins",
@@ -20,6 +17,9 @@ classifiers = [
     "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
     "Topic :: Software Development :: Testing",
     "Topic :: Software Development :: Quality Assurance",
     "Operating System :: POSIX",
@@ -27,32 +27,63 @@ classifiers = [
     "Operating System :: MacOS :: MacOS X",
     "Topic :: Utilities",
 ]
-packages = [
-    { include = "_ptcsvp" },
-    { include = "pytest_csv_params" },
+keywords = [
+    "py.test", "pytest", "csv", "params", "parametrize", "pytest-plugin", "ddt", "data-driven"
+]
+
+requires-python = ">=3.9,<3.14"
+
+dependencies = [
+    "pytest>=8.3,<9",
+    "attrs>=24.2",
+]
+
+[project.optional-dependencies]
+dev = [
+    "tox>=3.25.1,<4",
+    "tox-poetry>=0.4.1",
+    "pytest-black>=0.3.12",
+    "pytest-isort>=3.0",
+    "pytest-cov>=4.1",
+    "pytest-mock>=3.8.2",
+    "pytest-clarity>=1.0.1",
+    "pytest-bandit>=0.6.1",
+    "pytest-order>=1.0.1,<2",
+    "Sphinx>=5.1.1,<6",
+    "myst-parser>=0.18.0",
+    "sphinx-material>=0.0.35",
+    "sphinx-autodoc-typehints>=1.19.2,<2",
+    "livereload>=2.6.3",
+    "tomli>=2.0.1",
 ]
 
-[tool.poetry.urls]
+[project.urls]
+repository = "https://git.codebau.dev/pytest-plugins/pytest-csv-params"
+homepage = "https://git.codebau.dev/pytest-plugins/pytest-csv-params"
 "Issue Tracker" = "https://git.codebau.dev/pytest-plugins/pytest-csv-params/issues"
 "Wiki" = "https://git.codebau.dev/pytest-plugins/pytest-csv-params/wiki"
 "Releases" = "https://git.codebau.dev/pytest-plugins/pytest-csv-params/releases"
 "Documentation" = "https://docs.codebau.dev/pytest-plugins/pytest-csv-params/"
 "Changelog" = "https://docs.codebau.dev/pytest-plugins/pytest-csv-params/pages/changelog.html"
 
-[tool.poetry.plugins."pytest11"]
+[tool.poetry]
+packages = [
+    { include = "_ptcsvp" },
+    { include = "pytest_csv_params" },
+]
+
+[project.entry-points."pytest11"]
 "pytest-csv-params" = "pytest_csv_params.plugin"
 
 [tool.pytest.ini_options]
-addopts = "--mypy --black --isort --pylint --pylint-rcfile=.pylintrc --cov --cov-report=term-missing --cov-report=xml --junitxml=test-reports/pytest_csv_params.xml"
+addopts = "--black --isort --cov --cov-report=term-missing --cov-report=xml --junitxml=test-reports/pytest_csv_params.xml"
 filterwarnings=[
     "ignore:.*BlackItem.*:_pytest.warning_types.PytestDeprecationWarning",
-    "ignore:.*BlackItem.*:_pytest.warning_types.PytestRemovedIn8Warning",
-    "ignore:.*PyLintFile.*:_pytest.warning_types.PytestRemovedIn8Warning",
+    "ignore:.*BlackItem.*:_pytest.warning_types.PytestRemovedIn9Warning",
     "ignore:.*BlackItem.*:_pytest.warning_types.PytestWarning",
     "ignore:Using the __implements__ inheritance pattern for BaseReporter is no longer supported. Child classes should only inherit BaseReporter",
     "ignore:.*zipimport.*",
     "ignore:Creating a LegacyVersion has been deprecated and will be removed in the next major release",
-    "ignore:The hookimpl .* uses old-style configuration options.*",
 ]
 junit_family = "xunit2"
 junit_logging = "all"
@@ -102,7 +133,7 @@ exclude_lines = [
 ]
 
 [tool.mypy]
-python_version = "3.8"
+python_version = "3.9"
 strict = true
 ignore_missing_imports = true
 
@@ -110,7 +141,7 @@ ignore_missing_imports = true
 legacy_tox_ini = """
 [tox]
 minversion = 3.25.0
-envlist = clean,py38,py39,py310,py311
+envlist = clean,py39,py310,py311,py312,py313
 isolated_build = True
 
 [testenv]
@@ -125,7 +156,7 @@ commands =
 
 [tool.black]
 line-length = 120
-target-version = ['py38', 'py39', 'py310', 'py311']
+target-version = ['py39', 'py310', 'py311', 'py312', 'py313']
 include = '\.pyi?$'
 
 [tool.isort]
@@ -133,29 +164,6 @@ line_length = 120
 include_trailing_comma = true
 multi_line_output = 3
 
-[tool.poetry.dependencies]
-python = "^3.8"
-pytest = "^7.4.0"
-
-[tool.poetry.dev-dependencies]
-tox = "^3.25.1"
-tox-poetry = "^0.4.1"
-pytest-black = "^0.3.12"
-pytest-isort = "^3.0.0"
-pytest-cov = "^3.0.0"
-pytest-pylint = "^0.18.0"
-pytest-mock = "^3.8.2"
-pytest-clarity = "^1.0.1"
-pytest-bandit = "^0.6.1"
-pytest-mypy = "^0.9.1"
-pytest-order = "^1.0.1"
-Sphinx = "^5.1.1"
-myst-parser = "^0.18.0"
-sphinx-material = "^0.0.35"
-sphinx-autodoc-typehints = "^1.19.2"
-livereload = "^2.6.3"
-tomli = "^2.0.1"
-
 [build-system]
 requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"

{pytest_csv_params-1.1.0 → pytest_csv_params-1.3.2}/pytest_csv_params/decorator.py

@@ -1,6 +1,7 @@
 """
 This module defines/publishes the main decorator.
 """
+
 from _ptcsvp.parametrize import add_parametrization
 
 csv_params = add_parametrization

{pytest_csv_params-1.1.0 → pytest_csv_params-1.3.2}/pytest_csv_params/dialect.py

@@ -2,6 +2,7 @@
 Definition of CSV dialects (CSV file formats). At the moment, there is only the default dialect
 :class:`~pytest_csv_params.dialect.CsvParamsDefaultDialect`.
 """
+
 import csv
 
 

pytest_csv_params-1.3.2/pytest_csv_params/shortcut.py

@@ -0,0 +1,13 @@
+"""
+Shortcut decorators
+"""
+
+from pytest_csv_params.decorator import csv_params as default_csv_params
+
+
+def csv_params_reusing_id_col(**kwargs):
+    """
+    Shortcut decorator that allows to re-use ID columns as data columns
+    """
+    kwargs.setdefault("reuse_id_col", True)
+    return default_csv_params(**kwargs)

{pytest_csv_params-1.1.0 → pytest_csv_params-1.3.2}/pytest_csv_params/types.py

@@ -3,6 +3,7 @@ This module contains type definitions to ease the usage of the API and its docum
 
 Some types are somewhat complex, and it is easier to use a single word/reference instead of a complex typing construct.
 """
+
 import csv
 from typing import Any, Callable, Dict, Optional, Type
 

pytest_csv_params-1.3.2/pytest_csv_params/warning.py

@@ -0,0 +1,20 @@
+"""
+Definitions of all Warnings used in the Plugin
+"""
+
+from _pytest.warning_types import PytestWarning
+
+
+class CsvParamsWarning(PytestWarning):
+    """
+    Base class for all PytestCsvParams Plugin Warnings
+
+    Use this class if you want to filter out all the warnings of this Plugin
+    """
+
+
+class CsvParamsOnlyOneColumnIsUsedAsIdAndDataWarning(CsvParamsWarning):
+    """
+    Raised when only a single column is used for ID and test data, which is
+    most likely a configuration error, but might be valid in some scenarios.
+    """