Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Doc: Add documentation for parametrize_all_cases and get_all_cases #259

Merged
merged 5 commits into from Mar 21, 2022
Merged

Doc: Add documentation for parametrize_all_cases and get_all_cases #259

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
91aeaff
Doc: Add documentation for parametrize_all_cases and get_all_cases
eddiebergman Feb 21, 2022
4b2f771
Fix: typo
eddiebergman Feb 21, 2022
6c21d53
Update docs/api_reference.md
smarie Feb 22, 2022
2d7a63c
Update docs/api_reference.md
smarie Feb 22, 2022
8be8f12
Merge branch 'main' into update_parametrize_with_cases_docs
smarie Mar 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 5 additions & 3 deletions docs/api_reference.md
View file
Open in desktop
Expand Up @@ -257,8 +257,9 @@ CaseFilter(filter_function: Callable)
### `@parametrize_with_cases`

```python
CaseType = Union[Callable, Type, ModuleRef]
smarie marked this conversation as resolved.
Show resolved Hide resolved
@parametrize_with_cases(argnames: str,
cases: Union[Callable, Type, ModuleRef] = AUTO,
cases: Union[CaseType, List[CaseType]] = AUTO,
prefix: str = 'case_',
glob: str = None,
has_tag: Union[str, Iterable[str]] = None,
Expand All @@ -274,7 +275,7 @@ A decorator for test functions or fixtures, to parametrize them based on test ca

By default (`cases=AUTO`) the list of test cases is automatically drawn from the python module file named `test_<name>_cases.py` or if not found, `case_<name>.py`, where `test_<name>` is the current module name.

Finally, the `cases` argument also accepts an explicit case function, cases-containing class, module or module name; or a list of such elements. Note that both absolute and relative module names are suported.
Finally, the `cases` argument also accepts an explicit case function, cases-containing class, module or module name; or a list containing any mix of these elements. Note that both absolute and relative module names are supported.

Note that `@parametrize_with_cases` collection and parameter creation steps are strictly equivalent to [`get_all_cases`](#get_all_cases) + [`get_parametrize_args`](#get_parametrize_args). This can be handy for debugging purposes.

Expand Down Expand Up @@ -335,8 +336,9 @@ Note that you can get the same contents directly by using the [`current_cases`](
### `get_all_cases`

```python
CaseType = Union[Callable, Type, ModuleRef]
smarie marked this conversation as resolved.
Show resolved Hide resolved
def get_all_cases(parametrization_target: Callable,
cases: Union[Callable, Type, ModuleRef] = None,
cases: Union[CaseType, List[CaseType]] = None,
prefix: str = 'case_',
glob: str = None,
has_tag: Union[str, Iterable[str]] = None,
Expand Down
5 changes: 3 additions & 2 deletions src/pytest_cases/case_parametrizer_new.py
View file
Open in desktop
Expand Up @@ -56,6 +56,7 @@
from types import ModuleType # noqa

ModuleRef = Union[str, ModuleType, Literal[AUTO], Literal[THIS_MODULE]] # noqa
CaseType = Union[Callable, Type, ModuleRef]

except: # noqa
pass
Expand All @@ -65,7 +66,7 @@


def parametrize_with_cases(argnames, # type: Union[str, List[str], Tuple[str, ...]]
cases=AUTO, # type: Union[Callable, Type, ModuleRef]
cases=AUTO, # type: Union[CaseType, List[CaseType]]
prefix=CASE_PREFIX_FUN, # type: str
glob=None, # type: str
has_tag=None, # type: Any
Expand Down Expand Up @@ -206,7 +207,7 @@ def _glob_name_filter(case_fun):


def get_all_cases(parametrization_target, # type: Callable
cases=None, # type: Union[Callable, Type, ModuleRef]
cases=None, # type: Union[CaseType, List[CaseType]]
prefix=CASE_PREFIX_FUN, # type: str
glob=None, # type: str
has_tag=None, # type: Union[str, Iterable[str]]
Expand Down