✨ Add yaml format (#4)

Author: chrisjsewell

.github/workflows/python-package.yml .github/workflows/tests.yml.github/workflows/python-package.yml renamed to .github/workflows/tests.yml

@@ -1,7 +1,7 @@
 # This workflow will install Python dependencies, run tests and lint with a variety of Python versions
 # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
 
-name: Python package
+name: Tests
 
 on:
   push:
@@ -16,7 +16,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.8", "3.9", "3.10"]
+        python-version: ["3.8", "3.9", "3.10", "3.11"]
 
     steps:
     - uses: actions/checkout@v3

.pre-commit-config.yaml

@@ -2,25 +2,25 @@
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.1.0
+    rev: v4.4.0
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer
       - id: check-yaml
       - id: check-added-large-files
 
   - repo: https://github.com/PyCQA/isort
-    rev: 5.10.1
+    rev: 5.12.0
     hooks:
       - id: isort
 
   - repo: https://github.com/psf/black
-    rev: 21.12b0
+    rev: 23.7.0
     hooks:
       - id: black
 
   - repo: https://github.com/PyCQA/flake8
-    rev: 4.0.1
+    rev: 6.0.0
     hooks:
       - id: flake8
         additional_dependencies:

README.md

@@ -4,22 +4,39 @@
 
 A small package to generate parametrized [pytests](https://docs.pytest.org) from external files.
 
-Simply create a text file with the following (`dot`) format:
+Simply create a text file with an available format:
 
+`dot` format (default):
 ```
 [name1] description
 .
 input content
 .
 expected output content
-,
+.
 
 [name2] description
 .
 input content
 .
 expected output content
-,
+.
+```
+
+`yaml` format:
+```yaml
+- title: name1
+  description: description
+  input: |-
+    input content
+  expected: |-
+    expected output content
+- title: name2
+  description: description
+  input: |-
+    input content
+  expected: |-
+    expected output content
 ```
 
 Then, use the `param_file` pytest marker to create a parametrized test:
@@ -85,10 +102,10 @@ $ pip install -e .
 
 ## Regenerating expected output on failures
 
-**EXPERIMENTAL**
-
 Running pytest with the `--regen-file-failure` option will regenerate the parameter file with actual output, if any test fails.
 
+Note, currently regeneration of YAML files may not provide the same formatting as the original file, and will not preserve comments.
+
 ## Other formats
 
 TODO ...

pyproject.toml

@@ -11,15 +11,15 @@ license = {file = "LICENSE"}
 classifiers = [
     "License :: OSI Approved :: MIT License",
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.7",
     "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
     "Framework :: Pytest"
-
 ]
 keywords = ["pytest", "parameterized"]
-requires-python = ">=3.7"
-dependencies = ["pytest"]
+requires-python = ">=3.8"
+dependencies = ["pytest", "pyyaml"]
 
 [project.urls]
 Home = "https://github.com/chrisjsewell/pytest-param-files"
@@ -28,7 +28,7 @@ Home = "https://github.com/chrisjsewell/pytest-param-files"
 pytest_param_files = "pytest_param_files.main"
 
 [project.optional-dependencies]
-develop = ["black"]
+codecov = ["pytest-cov"]
 
 [tool.isort]
 profile = "black"

pytest_param_files/__init__.py

@@ -1,4 +1,5 @@
 """Create pytest parametrize decorators from external files."""
-from .main import ParamTestData  # noqa: F401
+from .main import ParamTestData
 
-__version__ = "0.3.5"
+__version__ = "0.4.0"
+__all__ = ("ParamTestData",)