initial commit

Author: okken

.coveragerc

@@ -0,0 +1,7 @@
+[run]
+branch = True
+
+[paths]
+source =
+   src
+   .tox/*/site-packages

.gitignore

@@ -0,0 +1,15 @@
+*.egg-info
+*.pyc
+.tox
+dist/
+__pycache__
+.coverage
+.idea/
+cov_html/
+venv/
+README.html
+build/
+htmlcov/
+*.swp
+.python-version
+.vscode/

LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023, Brian Okken
+
+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.

README.md

@@ -0,0 +1,108 @@
+# pytest-param-scope
+
+The pytest parametrize scope fixture workaround.
+
+----
+
+`pytest-param-scope` provides a `param_scope` marker to pass setup and teardown functions to a parametrized function.
+
+There's also a `param_scope` fixture to allow the return value of the setup function to be passed to the test.
+
+## Installation
+
+From PyPI:
+
+```
+$ pip install pytest-param-scope
+```
+
+## Example
+
+
+```python
+import pytest
+
+
+def param_setup():
+    print('\nparam setup')
+    return 'some data from setup'
+
+
+def param_teardown():
+    print('\nparam teardown')
+
+
+@pytest.mark.param_scope(param_setup, param_teardown)
+@pytest.mark.parametrize('x', ['a', 'b', 'c'])
+def test_param(x, param_scope):
+    """
+    mark.param_scope is used to pass
+    setup and teardown functions to fixture
+
+    param_scope fixture is necessary if you
+    want to use the value from setup
+    """
+    assert param_scope == 'some data from setup'
+```
+
+**Let's see it run:**
+
+```shell
+(venv) $ pytest -s -v test_param_scope.py::test_param
+================== test session starts ===================
+collected 3 items                                        
+
+test_param_scope.py::test_param[a] 
+param setup
+PASSED
+test_param_scope.py::test_param[b] PASSED
+test_param_scope.py::test_param[c] PASSED
+param teardown
+
+=================== 3 passed in 0.01s ====================
+
+```
+
+**What are we seeing?**
+
+1. Setup is run before the first parameter in a set.
+2. Teardown is run after the last parameter.
+3. The `param_scope` fixture holds the return value of the setup function.
+
+
+## Similarities to Fixtures
+
+* Teardown is not run if the setup fails.
+* Setup is run once, even though the value can be retrieved by all parametrized test cases.
+* If an exception occurs in setup, the test will report Error and not run. The teardown will also not run.
+* If an exception occurs in teardown, the LAST parametrized test case to run results in BOTH PASS and Error. This is weird, but consistent with pytest fixtures.
+
+## More examples
+
+Please see `examples` directory in the repo.
+
+
+## Limitations
+
+The implementation is a total hack and relies on global variables and looking up the next test to see when to run the teardown. There is undoubtedly room for improvement.
+
+* With `pytest-xdist`: I haven't come up with a failing case yet, but it seems like this will be sketchy with tests running in parallel.
+
+* With `pytest-repeat`: This actually works great with `pytest-repeat`, as repeat works by generating parametrized tests.
+
+
+## Contributing
+
+Contributions are very welcome. Tests can be run with [tox](https://tox.readthedocs.io/en/latest/).
+
+## License
+
+Distributed under the terms of the [MIT](http://opensource.org/licenses/MIT) license, "pytest-param-scope" is free and open source software
+
+## Issues
+
+If you encounter any problems, please [file an issue](https://github.com/okken/pytest-param-scope/issues) along with a detailed description.
+
+## Changelog
+
+See [changelog.md](https://github.com/okken/pytest-param-scope/blob/main/changelog.md)