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 update #159

Merged
merged 1 commit into from
Jan 18, 2024
Merged

doc update #159

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 57 additions & 24 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,28 +65,33 @@ def test_httpx_get(check):
`check` also helper functions for common checks.
These methods do NOT need to be inside of a `with check:` block.

- **check.equal** - *a == b*
- **check.not_equal** - *a != b*
- **check.is_** - *a is b*
- **check.is_not** - *a is not b*
- **check.is_true** - *bool(x) is True*
- **check.is_false** - *bool(x) is False*
- **check.is_none** - *x is None*
- **check.is_not_none** - *x is not None*
- **check.is_in** - *a in b*
- **check.is_not_in** - *a not in b*
- **check.is_instance** - *isinstance(a, b)*
- **check.is_not_instance** - *not isinstance(a, b)*
- **check.almost_equal** - *a == pytest.approx(b, rel, abs)* see at: [pytest.approx](https://docs.pytest.org/en/latest/reference.html#pytest-approx)
- **check.not_almost_equal** - *a != pytest.approx(b, rel, abs)* see at: [pytest.approx](https://docs.pytest.org/en/latest/reference.html#pytest-approx)
- **check.greater** - *a > b*
- **check.greater_equal** - *a >= b*
- **check.less** - *a < b*
- **check.less_equal** - *a <= b*
- **check.between(b, a, c, ge=False, le=False)** - *a < b < c*
- **check.between_equal(b, a, c)** - *a <= b <= c*
- **check.raises** - *func raises given exception* similar to [pytest.raises](https://docs.pytest.org/en/latest/reference/reference.html#pytest-raises)
- **check.fail(msg)** - *Log a failure*
| Function | Meaning | Notes |
|------------------------------------------------------|-----------------------------------|------------------------------------------------------------------------------------------------------|
| `equal(a, b, msg="")` | `a == b` | |
| `not_equal(a, b, msg="")` | `a != b` | |
| `is_(a, b, msg="")` | `a is b` | |
| `is_not(a, b, msg="")` | `a is not b` | |
| `is_true(x, msg="")` | `bool(x) is True` | |
| `is_false(x, msg="")` | `bool(x) is False` | |
| `is_none(x, msg="")` | `x is None` | |
| `is_not_none(x, msg="")` | `x is not None` | |
| `is_in(a, b, msg="")` | `a in b` | |
| `is_not_in(a, b, msg="")` | `a not in b` | |
| `is_instance(a, b, msg="")` | `isinstance(a, b)` | |
| `is_not_instance(a, b, msg="")` | `not isinstance(a, b)` | |
| `almost_equal(a, b, rel=None, abs=None, msg="")` | `a == pytest.approx(b, rel, abs)` | [pytest.approx](https://docs.pytest.org/en/latest/reference.html#pytest-approx) |
| `not_almost_equal(a, b, rel=None, abs=None, msg="")` | `a != pytest.approx(b, rel, abs)` | [pytest.approx](https://docs.pytest.org/en/latest/reference.html#pytest-approx) |
| `greater(a, b, msg="")` | `a > b` | |
| `greater_equal(a, b, msg="")` | `a >= b` | |
| `less(a, b, msg="")` | `a < b` | |
| `less_equal(a, b, msg="")` | `a <= b` | |
| `between(b, a, c, msg="", ge=False, le=False)` | `a < b < c` | |
| `between_equal(b, a, c, msg="")` | `a <= b <= c` | same as `between(b, a, c, msg, ge=True, le=True)` |
| `raises(expected_exception, *args, **kwargs)` | *Raises given exception* | similar to [pytest.raises](https://docs.pytest.org/en/latest/reference/reference.html#pytest-raises) |
| `fail(msg)` | *Log a failure* | |

**Note: This is a list of relatively common logic operators. I'm reluctant to add to the list too much, as it's easy to add your own.**


The httpx example can be rewritten with helper functions:

Expand All @@ -103,8 +108,9 @@ Which you use is personal preference.

## Defining your own check functions

The `@check.check_func` decorator allows you to wrap any test helper that has an assert
statement in it to be a non-blocking assert function.
### Using `@check.check_func`

The `@check.check_func` decorator allows you to wrap any test helper that has an assert statement in it to be a non-blocking assert function.


```python
Expand All @@ -121,6 +127,33 @@ def test_all_four():
is_four(4)
```


### Using `check.fail()`

Using `@check.check_func` is probably the easiest.
However, it does have a bit of overhead in the passing cases
that can affect large loops of checks.

If you need a bit of a speedup, use the following style with the help of `check.fail()`.

```python
from pytest_check import check

def is_four(a):
__tracebackhide__ = True
if a == 4:
return True
else:
check.fail(f"check {a} == 4")
return False

def test_all_four():
is_four(1)
is_four(2)
is_four(3)
is_four(4)
```

## Using raises as a context manager

`raises` is used as context manager, much like `pytest.raises`. The main difference being that a failure to raise the right exception won't stop the execution of the test method.
Expand Down
7 changes: 7 additions & 0 deletions changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,13 @@ All notable changes to this project be documented in this file.

-->

## [2.3.1] - 2024-Jan-18

### Modified
- Documentation Update, README.md
- Turn help function list into a table with param lists
- Show an alternative method of creating a helper function using `check.fail()`

## [2.3.0] - 2024-Jan-17

### Added
Expand Down
2 changes: 1 addition & 1 deletion examples/test_example_fail_func.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import pytest_check as check
from pytest_check import check


def test_one_failure():
Expand Down
2 changes: 1 addition & 1 deletion examples/test_example_fail_in_thread.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
from threading import Thread


import pytest_check as check
from pytest_check import check


def force_fail(comparison):
Expand Down
2 changes: 1 addition & 1 deletion examples/test_example_pass_in_thread.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
from threading import Thread


import pytest_check as check
from pytest_check import check


def always_pass():
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ authors = [{name = "Brian Okken"}]
readme = "README.md"
license = {file = "LICENSE.txt"}
description="A pytest plugin that allows multiple failures per test."
version = "2.3.0"
version = "2.3.1"
requires-python = ">=3.7"
classifiers = [
"License :: OSI Approved :: MIT License",
Expand Down