# syrupy

Logo

[![All Contributors](https://img.shields.io/github/all-contributors/syrupy-project/syrupy?color=ee8449&style=flat-square)](#contributors) [![Stage](https://img.shields.io/pypi/status/syrupy)](https://pypi.org/project/syrupy/) [![codecov](https://codecov.io/gh/syrupy-project/syrupy/graph/badge.svg?token=GB9EmYKPAl)](https://codecov.io/gh/syrupy-project/syrupy)

![Pytest>=8](https://img.shields.io/badge/pytest-%3E=8-green) [![Pypi](https://img.shields.io/pypi/v/syrupy)](https://pypi.org/project/syrupy/) [![Wheel](https://img.shields.io/pypi/wheel/syrupy)](https://pypi.org/project/syrupy/) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/syrupy) [![PyPI - Downloads](https://img.shields.io/pypi/dm/syrupy)](https://pypi.org/project/syrupy/) [![PyPI - License](https://img.shields.io/pypi/l/syrupy)](./LICENSE)

## Overview

Syrupy is a zero-dependency [pytest](https://docs.pytest.org/en/latest/) snapshot plugin. It enables developers to write tests which assert immutability of computed results.

## Motivation

Syrupy upholds three principles:

- Extensible: If a particular data type is not supported, users should be able to easily and quickly add support.
- Idiomatic: Snapshot testing should fit naturally among other test cases in pytest, e.g. `assert x == snapshot` vs. `snapshot.assert_match(x)`.
- Soundness: Snapshot tests should uncover even the most minute issues. Unlike other snapshot libraries, Syrupy will fail a test suite if a snapshot does not exist, not just on snapshot differences.

## Installation

```shell
python -m pip install syrupy
```

### Pytest and Python Compatibility

Syrupy will always be compatible with the latest version of Python and Pytest. If you're running an old version of Python or Pytest, you will need to use an older major version of Syrupy:

| Syrupy Version | Python Support | Pytest Support |
| -------------- | -------------- | -------------- |
| 5.x.x          | >=3.10         | >=8            |
| 4.x.x          | >=3.8.1,       | >=7,   <9      |
| 3.x.x          | >=3.7, <4      | >=5.1, <8      |
| 2.x.x          | >=3.6, <4      | >=5.1, <8      |

## Usage

### Basic Usage

In a pytest test file `test_file.py`:

```python
def test_foo(snapshot):
    actual = "Some computed value!"
    assert actual == snapshot
```

when you run `pytest`, the above test should fail due to a missing snapshot. Re-run pytest with the update snapshots flag like so:

```shell
pytest --snapshot-update
```

A snapshot file should be generated under a `__snapshots__` directory in the same directory as `test_file.py`. The `__snapshots__` directory and all its children should be committed along with your test code.

#### Usage in `unittest.TestCase` subclasses

[Due to limitations in `unittest` and `pytest`](https://docs.pytest.org/en/9.0.x/how-to/unittest.html#pytest-features-in-unittest-testcase-subclasses), the `snapshot` fixture is not directly usable in `TestCase` subclasses (including Django's `TestCase`).

Possible workarounds include using marks:

```python
from unittest import TestCase
import pytest

@pytest.fixture(scope="function")
def snapshot_in_class(request, snapshot):
    """
    Wraps snapshot fixture to provide instance snapshot property for
    unittest.TestCase tests
    """
    request.cls.snapshot = snapshot

class MyTest(TestCase):
    @pytest.mark.usefixtures("snapshot_in_class")
    def test_foo(self):
        actual = "Some computed value!"
        assert actual == self.snapshot
```

Or using a fixture with `autouse`:

```python
from unittest import TestCase
import pytest

class MyTest(TestCase):
    @pytest.fixture(autouse=True)
    def setupSnapshot(self, snapshot):
        self.snapshot = snapshot

    def test_foo(self):
        actual = "Some computed value!"
        assert actual == self.snapshot
```

#### Custom Objects

The default serializer supports all python built-in types and provides a sensible default for custom objects.

#### Representation

If you need to customise your object snapshot, it is as easy as overriding the default `__repr__` implementation.

```python
def __repr__(self) -> str:
    return "MyCustomClass(...)"
```

If you need to bypass a custom object representation to use the amber standard, it is easy using the following helpers.

```python
def test_object_as_named_tuple(snapshot):
    assert snapshot == AmberDataSerializer.object_as_named_tuple(obj_with_custom_repr)
```

> See `test_snapshot_object_as_named_tuple_class` for an example on automatically doing this for all nested properties

#### Attributes

If you want to limit what properties are serialized at a class type level you could either:

**A**. Provide a filter function to the snapshot [exclude](#exclude) configuration option.

```py
def limit_foo_attrs(prop, path):
    allowed_foo_attrs = {"do", "not", "serialize", "these", "attrs"}
    return isinstance(path[-1][1], Foo) and prop in allowed_foo_attrs

def test_bar(snapshot):
    actual = Foo(...)
    assert actual == snapshot(exclude=limit_foo_attrs)
```

**B**. Provide a filter function to the snapshot [include](#include) configuration option.

```py
def limit_foo_attrs(prop, path):
    allowed_foo_attrs = {"only", "serialize", "these", "attrs"}
    return isinstance(path[-1][1], Foo) and prop in allowed_foo_attrs

def test_bar(snapshot):
    actual = Foo(...)
    assert actual == snapshot(include=limit_foo_attrs)
```

**C**. Or override the `__dir__` implementation to control the attribute list.

```py
class Foo:
    def __dir__(self):
        return ["only", "serialize", "these", "attrs"]

def test_bar(snapshot):
    actual = Foo(...)
    assert actual == snapshot
```

Both options will generate equivalent snapshots but the latter is only viable when you have control over the class implementation and do not need to share the exclusion logic with other objects.

### CLI Options

These are the cli options exposed to `pytest` by the plugin.

| Option                         | Description                                                                                                                    | Default                                                                                                      |
| ------------------------------ |--------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|
| `--snapshot-update`            | Snapshots will be updated to match assertions and unused snapshots will be deleted.                                            | `False`                                                                                                      |
| `--snapshot-update-new-only`   | Snapshots that do not yet exist will be written, but existing snapshots are not modified or deleted on mismatch. | `False`                                                                                                      |
| `--snapshot-details`           | Includes details of unused, generated, and updated snapshots (test name and snapshot location) in the final report.                                    | `False`                                                                                                      |
| `--snapshot-warn-unused`       | Prints a warning on unused snapshots rather than fail the test suite.                                                          | `False`                                                                                                      |
| `--snapshot-no-cleanup`        | Do not delete unused snapshots when updating with `--snapshot-update`.                                                         | `False`                                                                                                      |
| `--snapshot-default-extension` | Use to change the default snapshot extension class.                                                                            | [AmberSnapshotExtension](https://github.com/syrupy-project/syrupy/blob/main/src/syrupy/extensions/amber/__init__.py) |
| `--snapshot-no-colors`         | Disable test results output highlighting. Equivalent to setting the environment variables `ANSI_COLORS_DISABLED` or `NO_COLOR` | Disabled by default if not in terminal.                                                                      |
| `--snapshot-patch-pycharm-diff`| Override PyCharm's default diffs viewer when looking at snapshot diffs. See [IDE Integrations](#ide-integrations)        | `False`                                                                                                      |
| `--snapshot-diff-mode` | Configures how diffs are displayed on assertion failure. If working with very large snapshots, disabling the diff can improve performance. | `detailed` |
| `--snapshot-ignore-file-extensions` | Comma separated list of file extensions to ignore when walking the file tree and discovering used/unused snapshots. | No extensions are ignored by default. |
| `--snapshot-dirname` | Directory name to store snapshots in. | `__snapshots__` |

### Assertion Options

These are the options available on the `snapshot` assertion fixture.
Use of these options are one shot and do not persist across assertions.
For more persistent options see [advanced usage](#advanced-usage).

#### `matcher`

This allows you to match on a property path and value to control how specific object shapes are serialized.

The matcher is a function that takes two keyword arguments.
It should return the replacement value to be serialized or the original unmutated value.

| Argument | Description                                                                                                        |
| -------- | ------------------------------------------------------------------------------------------------------------------ |
| `data`   | Current serializable value being matched on                                                                        |
| `path`   | Ordered path traversed to the current value e.g. `(("a", dict), ("b", dict))` from `{ "a": { "b": { "c": 1 } } }`} |

**NOTE:** Do not mutate the value received as it could cause unintended side effects.

##### Composing Matchers

Multiple matchers can be composed together using `compose_matchers`, e.g.:

```py
from syrupy.matchers import compose_matchers

def test_multiple_matchers(snapshot):
    data = {
        "number": 1,
        "datetime": datetime.datetime.now(),
        "float": 1.3
    }

    assert data == snapshot(
        matcher=compose_matchers(
            path_type(types=(int, float), replacer=lambda *_: "MATCHER_1"),
            path_type(types=(datetime.datetime,), replacer=lambda *_: "MATCHER_2"),
        ),
    )
```

##### Built-In Matchers

Syrupy comes with built-in helpers that can be used to make easy work of using property matchers.

###### `path_type(mapping=None, *, types=(), strict=True, regex=False, replacer=...)`

Easy way to build a matcher that uses the path and value type to replace serialized data.
When strict, this will raise a `ValueError` if the types specified are not matched.

| Argument   | Description                                                                                                                        |
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `mapping`  | Dict of path string to tuples of class types, including primitives e.g. (MyClass, UUID, datetime, int, str)                        |
| `types`    | Tuple of class types used if none of the path strings from the mapping are matched                                                 |
| `strict`   | If a path is matched but the value at the path does not match one of the class types in the tuple then a `PathTypeError` is raised |
| `regex`    | If true, the `mapping` key is treated as a regular expression when matching paths                                                  |
| `replacer` | Called with any matched value and result is used as the replacement that is serialized. Defaults to the object type when not given |

```py
from syrupy.matchers import path_type

def test_bar(snapshot):
    actual = {
      "date_created": datetime.now(),
      "value": "Some computed value!!",
    }
    assert actual == snapshot(matcher=path_type({
      "date_created": (datetime,),
      "nested.path.id": (int,),
    }))
```

```py
# name: test_bar
  dict({
    'date_created': datetime,
    'value': 'Some computed value!!',
  })
# ---
```

> NOTE: When `regex` is `True` all matcher mappings are treated as regex patterns

###### `path_value(mapping, *, types, replacer, **kwargs)`

Shares the same `kwargs` as `path_type` matcher, with the exception of the `mapping` argument type.
Only runs replacement for objects at a matching path where the value of the mapping also matches the object data string repr.

| Argument  | Description                                                |
| --------- | ---------------------------------------------------------- |
| `mapping` | Dict of path string to object value string representations |

> See `test_regex_matcher_str_value` for example usage.

#### `exclude`

This allows you to filter out object properties from the serialized snapshot.

The exclude parameter takes a filter function that accepts two keyword arguments.
It should return `true` if the property should be excluded, or `false` if the property should be included.

| Argument | Description                                                                                                                                   |
| -------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `prop`   | Current property on the object, could be any hashable value that can be used to retrieve a value e.g. `1`, `"prop_str"`, `SomeHashableObject` |
| `path`   | Ordered path traversed to the current value e.g. `(("a", dict), ("b", dict))` from `{ "a": { "b": { "c": 1 } } }`}                            |

##### Built-In Filters

Syrupy comes with built-in helpers that can be used to make easy work of using the filter options.

###### `props(prop_name, *prop_name)`

Easy way to build a filter that excludes based on string based property names.

Takes an argument list of property names, with support for indexed iterables.

```py
from syrupy.filters import props

def test_bar(snapshot):
    actual = {
      "id": uuid.uuid4(),
      "list": [1,2,3],
    }
    assert actual == snapshot(exclude=props("id", "1"))
```

```py
# name: test_bar
  dict({
    'list': list([
      1,
      3,
    ]),
  })
# ---
```

###### `paths(path_string, *path_strings)`

Easy way to build a filter that uses full path strings delimited with `.`.

Takes an argument list of path strings.

```py
from syrupy.filters import paths

def test_bar(snapshot):
    actual = {
      "date": datetime.now(),
      "list": [1,2,3],
    }
    assert actual == snapshot(exclude=paths("date", "list.1"))
```

```py
# name: test_bar
  dict({
    'list': list([
      1,
      3,
    ]),
  })
# ---
```

#### `include`

This allows you to filter an object's properties to a subset using a predicate. This is the opposite of [exclude](#exclude). All the same property filters supported by [exclude](#exclude) are supported for `include`.

The include parameter takes a filter function that accepts two keyword arguments.
It should return `true` if the property should be included, or `false` if the property should not be included.

| Argument | Description                                                                                                                                   |
| -------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `prop`   | Current property on the object, could be any hashable value that can be used to retrieve a value e.g. `1`, `"prop_str"`, `SomeHashableObject` |
| `path`   | Ordered path traversed to the current value e.g. `(("a", dict), ("b", dict))` from `{ "a": { "b": { "c": 1 } } }`}

Note that `include` has some caveats which make it a bit more difficult to use than `exclude`. Both `include` and `exclude` are evaluated for each key of an object before traversing down nested paths. This means if you want to include a nested path, you must include all parents of the nested path, otherwise the nested child will never be reached to be evaluated against the include predicate. For example:

```py
obj = {
    "nested": { "key": True }
}
assert obj == snapshot(include=paths("nested", "nested.key"))
```

The extra "nested" is required, otherwise the nested dictionary will never be searched -- it'd get pruned too early.

To avoid adding duplicate path parts, we provide a convenient `paths_include` which supports a list/tuple instead of a string for each path to match:

```py
obj = {
    "other": False,
    "nested": { "key": True }
}
assert obj == snapshot(include=paths_include(["other"], ["nested", "key"]))
```

#### `extension_class`

This is a way to modify how the snapshot matches and serializes your data in a single assertion.

```py
def test_foo(snapshot):
    actual_svg = "<svg></svg>"
    assert actual_svg == snapshot(extension_class=SVGImageSnapshotExtension)
```

#### `diff`

This is an option to snapshot only the diff between the actual object and a previous snapshot, with the `diff` argument being the previous snapshot `index`/`name`.

```py
def test_diff(snapshot):
    actual0 = [1,2,3,4]
    actual1 = [0,1,3,4]

    assert actual0 == snapshot
    assert actual1 == snapshot(diff=0)
    # This is equivalent to the lines above
    # Must use the index name to diff when given
    assert actual0 == snapshot(name='snap_name')
    assert actual1 == snapshot(diff='snap_name')
```

##### Built-In Extensions

Syrupy comes with a few built-in preset configurations for you to choose from. You should also feel free to extend the `AbstractSyrupyExtension` if your project has a need not captured by one our built-ins.

**Amber Extensions**

- **`AmberSnapshotExtension`**: This is the default extension which generates `.ambr` files. Serialization of most data types are supported.
  - Line control characters are normalised when snapshots are generated i.e. `\r` and `\n` characters are all written as `\n`. This is to allow interoperability of snapshots between operating systems that use disparate line control characters.
- **`SingleFileAmberSnapshotExtension`**: A variant of the `AmberSnapshotExtension` which writes 1 snapshot per file.

**Other Formats**

- **`SingleFileSnapshotExtension`**: This extension creates one `.raw` file per test case. Note that the default behaviour of the SingleFileSnapshotExtension is to write raw bytes to disk. There is no further "serialization" that happens. The `SingleFileSnapshotExtension` is mostly used as a building block for other extensions such as the image extensions, the JSON extension, as well as the `SingleFileAmberSnapshotExtension` extension. In the default "binary" mode, attempting to serialize a non-byte-like object will throw a TypeError.
- **`PNGImageSnapshotExtension`**: An extension of single file, this should be used to produce `.png` files from a byte string.
- **`SVGImageSnapshotExtension`**: Another extension of single file. This produces `.svg` files from an svg string.
- **`JSONSnapshotExtension`**: Another extension of single file. This produces `.json` files from dictionaries and lists.

#### `name`

By default, if you make multiple snapshot assertions within a single test case, an auto-increment identifier will be used to index the snapshots. You can override this behaviour by specifying a custom snapshot name to use in place of the auto-increment number.

```py
def test_case(snapshot):
    assert "actual" == snapshot(name="case_a")
    assert "other" == snapshot(name="case_b")
```

> _Warning_: If you use a custom name, you must make sure the name is not re-used within a test case.

### Advanced Usage

By overriding the provided [`AbstractSyrupyExtension`](https://github.com/syrupy-project/syrupy/tree/main/src/syrupy/extensions/base.py) you can implement varied custom behaviours.

See examples of how syrupy can be used and extended in the [test examples](https://github.com/syrupy-project/syrupy/tree/main/tests/examples).

#### Overriding defaults

It is possible to override `include`, `exclude`, `matchers` and `extension_class` on a more global level just once,
instead of every time per test. By default, after every assertion the modified values per snapshot assert are reverted
to their default values. However, it is possible to override those default values with ones you would like persisted,
which will be treated as the new defaults.

To achieve that you can use `snapshot.with_defaults`, which will create new instance of `SnapshotAssertion` with the provided values.

`snapshot.use_extension` is retained for compatibility. However, it is limited to only overriding the default extension class.

#### JSONSnapshotExtension

This extension can be useful when testing API responses, or when you have to deal with long dictionaries that are cumbersome to validate inside a test. For example:

```python
import pytest

from syrupy.extensions.json import JSONSnapshotExtension

@pytest.fixture
def snapshot_json(snapshot):
    return snapshot.with_defaults(extension_class=JSONSnapshotExtension)
    # or return snapshot.use_extension(JSONSnapshotExtension)


def test_api_call(client, snapshot_json):
    resp = client.post("/endpoint")
    assert resp.status_code == 200
    assert snapshot_json == resp.json()
```

API responses often contain dynamic data, like IDs or dates. You can still validate and store other data of a response by leveraging syrupy matchers. For example:

```py
from datetime import datetime

from syrupy.matchers import path_type

def test_api_call(client, snapshot_json):
    resp = client.post("/user", json={"name": "Jane"})
    assert resp.status_code == 201

    matcher = path_type({
      "id": (int,),
      "registeredAt": (datetime,)
    })
    assert snapshot_json(matcher=matcher) == resp.json()
```

The generated snapshot:

```json
{
  "id": "<class 'int'>",
  "registeredAt": "<class 'datetime'>",
  "name": "Jane"
}
```

Or a case where the value needs to be replaced using a condition e.g. file path string

```py
import re

from syrupy.matchers import path_type

def test_matches_generated_string_value(snapshot, tmp_file):
    matcher = path_value(
        mapping={"file_path": r"\w+://(.*/)+dir/filename.txt"},
        replacer=lambda _, match: match[0].replace(match[1], "<tmp-file-path>/"),
        types=(str,),
    )

    assert snapshot(matcher=matcher) == tmp_file
```

The generated snapshot:

```json
{
  "name": "Temp Files",
  "file_path": "scheme://<tmp-file-path>/dir/filename.txt"
}
```

#### Ignoring File Extensions (e.g. DVC Integration)

If using a tool such as [DVC](https://dvc.org/) or other tool where you need to ignore files by file extension, you can update your `pytest.ini` like so:

```ini
[pytest]
addopts = --snapshot-ignore-file-extensions dvc
```

A comma separated list is supported, like so:

```ini
[pytest]
addopts = --snapshot-ignore-file-extensions dvc,tmp,zip
```

### Extending Syrupy

- [Custom defaults](https://github.com/syrupy-project/syrupy/tree/main/tests/examples/test_custom_defaults.py)
- [Custom snapshot directory 1](https://github.com/syrupy-project/syrupy/tree/main/tests/examples/test_custom_snapshot_directory.py)
- [Custom snapshot directory 2](https://github.com/syrupy-project/syrupy/tree/main/tests/examples/test_custom_snapshot_directory_2.py)
- [Custom snapshot name](https://github.com/syrupy-project/syrupy/tree/main/tests/examples/test_custom_snapshot_name.py)
- [Custom object snapshots](https://github.com/syrupy-project/syrupy/tree/main/tests/examples/test_custom_object_repr.py)
- [Custom comparator](https://github.com/syrupy-project/syrupy/tree/main/tests/integration/test_custom_comparator.py)
- [JPEG image extension](https://github.com/syrupy-project/syrupy/tree/main/tests/examples/test_custom_image_extension.py)
- [Built-in image extensions](https://github.com/syrupy-project/syrupy/blob/main/tests/syrupy/extensions/image/test_image_svg.py)
- [Amber Serializer Plugins](https://github.com/syrupy-project/syrupy/blob/main/tests/syrupy/extensions/amber/test_amber_serializer_plugins.py) -- e.g. serializing attrs, dataclasses, Pydantic

### Inline Snapshots

Syrupy does not support inline snapshots. For inline snapshots, we recommend checking out the [inline-snapshot](https://github.com/15r10nk/inline-snapshot) library.

## IDE Integrations

### PyCharm

The [PyCharm](https://www.jetbrains.com/pycharm/) IDE comes with a built-in tool for visualizing differences between expected and actual results in a test. To properly render Syrupy snapshots in the PyCharm diff viewer, we need to apply a patch to the diff viewer library. To do this, use the `--snapshot-patch-pycharm-diff` flag, e.g.:

In your `pytest.ini`:

```ini
[pytest]
addopts = --snapshot-patch-pycharm-diff
```

See [#675](https://github.com/syrupy-project/syrupy/issues/675) for the original issue.

## Known Limitations

- `pytest-xdist`: unused snapshot detection and removal are supported when running with multiple processes. Each worker reports the snapshots it used and the controller combines them to determine which snapshots are unused. See [#535](https://github.com/syrupy-project/syrupy/issues/535) for more information.

_We welcome contributions to patch these known limitations._

## Migrating from another tool

### From snapshottest

You cannot use syrupy alongside snapshottest due to argument conflicts. To ease migration, we've made syrupy aware of snapshottest call syntax. Simply uninstall snapshottest and remove old snapshots:

```shell
pip uninstall snapshottest -y;
find . -type d ! -path '*/\.*' -name 'snapshots' | xargs rm -r
```

## Uninstalling

```shell
pip uninstall syrupy
```

If you have decided not to use Syrupy for your project after giving us a try, we'd love to get your feedback. Please create a GitHub issue if applicable.

## Contributing

Feel free to open a PR or GitHub issue. Contributions welcome!

To develop locally, clone this repository and run `. script/bootstrap` to install test dependencies. You can then use `invoke --list` to see available commands.

### See contributing [guide](https://github.com/syrupy-project/syrupy/tree/main/CONTRIBUTING.md)

## Contributors

       Noah
Noah (https://noahnu.com)
🚇 🤔 💻 (https://github.com/syrupy-project/syrupy/commits?author=noahnu) 📖 (https://github.com/syrupy-project/syrupy/commits?author=noahnu) ⚠️ (https://github.com/syrupy-project/syrupy/commits?author=noahnu)
       Emmanuel Ogbizi
Emmanuel Ogbizi (http://emmanuel.ogbizi.com)
💻 (https://github.com/syrupy-project/syrupy/commits?author=iamogbz) 🎨 🚇 📖 (https://github.com/syrupy-project/syrupy/commits?author=iamogbz) ⚠️ (https://github.com/syrupy-project/syrupy/commits?author=iamogbz)
       Adam Lazzarato
Adam Lazzarato (https://github.com/adamlazz)
📖 (https://github.com/syrupy-project/syrupy/commits?author=adamlazz)
       Marc Cataford
Marc Cataford (https://mcataford.github.io)
💻 (https://github.com/syrupy-project/syrupy/commits?author=mcataford) ⚠️ (https://github.com/syrupy-project/syrupy/commits?author=mcataford)
       Michael Rose
Michael Rose (http://msrose.github.io)
💻 (https://github.com/syrupy-project/syrupy/commits?author=msrose) ⚠️ (https://github.com/syrupy-project/syrupy/commits?author=msrose)
       Jimmy Jia
Jimmy Jia (http://fashionablenonsense.com/)
💻 (https://github.com/syrupy-project/syrupy/commits?author=taion) ⚠️ (https://github.com/syrupy-project/syrupy/commits?author=taion)
       Steven Loria
Steven Loria (https://stevenloria.com)
🚇

       Artur Balabanov
Artur Balabanov (https://github.com/arturbalabanov)
💻 (https://github.com/syrupy-project/syrupy/commits?author=arturbalabanov)
       Huon Wilson
Huon Wilson (http://huonw.github.io/)
💻 (https://github.com/syrupy-project/syrupy/commits?author=huonw) 🐛 (https://github.com/syrupy-project/syrupy/issues?q=author%3Ahuonw)
       Elizabeth Culbertson
Elizabeth Culbertson (https://github.com/eaculb)
💻 (https://github.com/syrupy-project/syrupy/commits?author=eaculb) ⚠️ (https://github.com/syrupy-project/syrupy/commits?author=eaculb)
       Joakim Nordling
Joakim Nordling (https://github.com/joakimnordling)
🐛 (https://github.com/syrupy-project/syrupy/issues?q=author%3Ajoakimnordling)
       Ouail
Ouail (https://github.com/bendidi)
💻 (https://github.com/syrupy-project/syrupy/commits?author=bendidi)
       Denis
Denis (https://github.com/fbjorn)
💻 (https://github.com/syrupy-project/syrupy/commits?author=fbjorn)
       N0124
N0124 (https://github.com/N0124)
💻 (https://github.com/syrupy-project/syrupy/commits?author=N0124)

       dtczest
dtczest (https://github.com/dtczest)
🐛 (https://github.com/syrupy-project/syrupy/issues?q=author%3Adtczest)
       Eddie Darling
Eddie Darling (https://github.com/spagh-eddie)
📖 (https://github.com/syrupy-project/syrupy/commits?author=spagh-eddie)
       darrenburns
darrenburns (https://github.com/darrenburns)
📖 (https://github.com/syrupy-project/syrupy/commits?author=darrenburns)
       Magnus Heskestad Waage
Magnus Heskestad Waage (https://github.com/mhwaage)
🐛 (https://github.com/syrupy-project/syrupy/issues?q=author%3Amhwaage)
       Herbert Ho
Herbert Ho (https://github.com/herb)
🐛 (https://github.com/syrupy-project/syrupy/issues?q=author%3Aherb)
       Tolga Eren
Tolga Eren (https://github.com/tolgaeren)
🐛 (https://github.com/syrupy-project/syrupy/issues?q=author%3Atolgaeren)
       John Kurkowski
John Kurkowski (https://johnkurkowski.com)
🐛 (https://github.com/syrupy-project/syrupy/issues?q=author%3Ajohn-kurkowski)

       Atharva Arya
Atharva Arya (https://www.atharvaarya.tech/)
💻 (https://github.com/syrupy-project/syrupy/commits?author=atharva-2001)
       Michał Jelonek
Michał Jelonek (https://github.com/michaljelonek)
💻 (https://github.com/syrupy-project/syrupy/commits?author=michaljelonek)
       ManiacDC
ManiacDC (https://github.com/ManiacDC)
💻 (https://github.com/syrupy-project/syrupy/commits?author=ManiacDC)
       Dmitry Dygalo
Dmitry Dygalo (https://schemathesis.io/)
📖 (https://github.com/syrupy-project/syrupy/commits?author=Stranger6667)
       Allan Chain
Allan Chain (https://allanchain.github.io/)
🐛 (https://github.com/syrupy-project/syrupy/issues?q=author%3AAllanChain)
       Nir Schulman
Nir Schulman (https://github.com/UltimateLobster)
💻 (https://github.com/syrupy-project/syrupy/commits?author=UltimateLobster)
       Joost Lekkerkerker
Joost Lekkerkerker (http://joostlek.dev)
💻 (https://github.com/syrupy-project/syrupy/commits?author=joostlek)

       epenet
epenet (https://github.com/epenet)
⚠️ (https://github.com/syrupy-project/syrupy/commits?author=epenet)
       Tom Sparrow
Tom Sparrow (http://about.me/tomsparrow)
🐛 (https://github.com/syrupy-project/syrupy/issues?q=author%3Asparrowt)
       Samy Laumonier
Samy Laumonier (https://github.com/samylaumonier)
🐛 (https://github.com/syrupy-project/syrupy/issues?q=author%3Asamylaumonier)
       Paul Ollis
Paul Ollis (https://github.com/paul-ollis)
🐛 (https://github.com/syrupy-project/syrupy/issues?q=author%3Apaul-ollis)
       Rahul Iyer
Rahul Iyer (https://rahuliyer.me)
🐛 (https://github.com/syrupy-project/syrupy/issues?q=author%3Arahuliyer95)
       Sergio Livi
Sergio Livi (http://serl.it/)
📖 (https://github.com/syrupy-project/syrupy/commits?author=serl)
       Bartosz Marcin Wróblewski
Bartosz Marcin Wróblewski (https://bwrob.github.io/)
💻 (https://github.com/syrupy-project/syrupy/commits?author=bwrob)

       David R. MacIver
David R. MacIver (http://www.drmaciver.com)
🐛 (https://github.com/syrupy-project/syrupy/issues?q=author%3ADRMacIver)
       Franck Nijhof
Franck Nijhof (https://frenck.dev)
🐛 (https://github.com/syrupy-project/syrupy/issues?q=author%3Afrenck)

This section is automatically generated via tagging the all-contributors bot in a PR:

```text
@all-contributors please add <username> for <contribution type>
```

## Benchmarks

See [Benchmarks](https://syrupy-project.github.io/syrupy/dev/bench/).

## License

Syrupy is licensed under [MIT](https://github.com/syrupy-project/syrupy/tree/main/LICENSE).
