Metadata-Version: 2.1
Name: Jestspectation
Version: 0.7.0
Summary: Pattern matching helper classes designed to allow for testing of complex data structures in a readable and logical format.
Home-page: https://github.com/MiguelGuthridge/Jestspectation
Author: Miguel Guthridge
Author-email: hdsq@outlook.com.au
Project-URL: Online Documentation, https://github.com/MiguelGuthridge/Jestspectation
Project-URL: Bug Tracker, https://github.com/MiguelGuthridge/Jestspectation/issues
Keywords: jest,pattern,matching,pytest,equality
Classifier: Programming Language :: Python :: 3
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Other Environment
Classifier: Framework :: Pytest
Requires-Python: >=3.9.1
Description-Content-Type: text/markdown
License-File: LICENSE

# Jestspectation

Pattern matching helper classes designed to allow for testing of complex data
structures in a readable and logical format.

The design is inspired by the `expect` system from JavaScript's Jest testing
framework.

```py
import jestspectation as expect

assert {
    "a": 1,
    "b": 2,
    "c": 3.0,
} == {
    "a": 1,
    "b": expect.Any(int),
    "c": expect.FloatApprox(2.5, magnitude=0.5)
}
```

## Installation

```sh
pip install jestspectation
```

## Usage with Pytest

The library can be used as a pytest plugin, which can give access to much more
detailed error messages when assertions fail.

You can enable it by adding the following lines to your `conftest.py`

```py
pytest_plugins = ("jestspectation.pytest",)
```

This should result in output similar to the following

```
    def test_goodbye():
>       assert 1 == expect.Any(float)
E       assert Type mismatch
E         Expected any object of type float
E         Received 1 (int)
```

These advanced completions can also be used for most standard Python objects
by wrapping the expected values in an `Equals`. For example:

```
    def test_lists():
>       assert expect.Equals([1, 2, 3, 4]) == [1, 2, 3, 5, 6]
E       assert [1, 2, 3, 4] == [1, 2, 3, 5, 6]
E         !! [3] 4 == 5
E            Value mismatch
E            Expected 4
E            Received 5
E         ++ [4] 6
```
