Metadata-Version: 2.1
Name: syrupy
Version: 0.2.0
Summary: PyTest Snapshot Test Utility
Home-page: https://github.com/tophat/syrupy
Author: Top Hat Open Source
Author-email: opensource@tophat.com
License: Apache License 2.0
Description: # syrupy
        
        <img align="right" width="100px" height="100px" src="https://user-images.githubusercontent.com/2528959/69500147-85d71400-0ec6-11ea-867a-277881278e57.png" alt="Logo">
        
        [![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors) [![Maturity badge - level 2](https://img.shields.io/badge/Maturity-Level%202%20--%20First%20Release-yellowgreen.svg)](https://github.com/tophat/getting-started/blob/master/scorecard.md) ![Stage](https://img.shields.io/pypi/status/syrupy) [![Slack workspace](https://slackinvite.dev.tophat.com/badge.svg)](https://opensource.tophat.com/slack)
        
        [![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)
        
        ![Build Status](https://github.com/tophat/syrupy/workflows/Syrupy%20CICD/badge.svg) [![codecov](https://codecov.io/gh/tophat/syrupy/branch/master/graph/badge.svg)](https://codecov.io/gh/tophat/syrupy)
        
        ## Overview
        
        Syrupy is a [pytest](https://docs.pytest.org/en/latest/) snapshot plugin. It enables developers to write tests which assert immutability of computed results.
        
        ## Motivation
        
        The most popular snapshot test plugin compatible with pytest has some core limitations which this package attempts to address by upholding some keys values:
        
        - 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 tests 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
        ```
        
        ### Migration
        
        Syrupy is a drop in replacement for `snapshottest`. If you already have snapshot tests written, it is as easy as:
        
        ```shell
        pip uninstall snapshottest
        ```
        
        This is neccessary to prevent argument conflicts.
        
        ![there can only be one](https://media.giphy.com/media/9Jmb2idg10qJSygvTQ/giphy.gif)
        
        ## 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 Demo](./assets/usage_demo.gif)
        
        #### Custom Objects
        
        The default serializer supports all python built-in types and provides a sensible default for custom objects.
        
        If you need to customise your object snapshot, is as easy as overriding the default `__repr__` implementation.
        
        ```python
        def __repr__(self) -> str:
          return "MyCustomClass(...)"
        ```
        
        ### Options
        
        These are the cli options exposed to `pytest` by the plugin.
        
        | Option                   | Description                                                                                                                  |
        | ------------------------ | ---------------------------------------------------------------------------------------------------------------------------- |
        | `--snapshot-update`      | When supplied updates existing snapshots of any run tests, as well as deleting unused and generating new snapshots.          |
        | `--snapshot-warn-unused` | Syrupy default behaviour is to fail the test session when there any unused snapshots. This instructs the plugin not to fail. |
        
        ### 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.
        
        - **`AmberSnapshotExtension`**: This is the default extension which generates `.ambr` files. Serialization of most data types are supported, however non-sortable types such as frozenset are experimental.
        - **`SingleFileSnapshotExtension`**: Unlike the `AmberSnapshotExtension`, which groups all tests within a single test file into a singular snapshot file, and creates one `.raw` file per test case.
        - **`PNGSnapshotExtension`**: An extension of single file, this should be used to produce `.png` files.
        - **`SVGSnapshotExtension`**: Another extension of single file. This produces `.svg` files from an svg string.
        
        ### Advanced Usage
        
        By overriding the provided [`AbstractSnapshotExtension`](./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](./tests/examples).
        
        ### Extending Syrupy
        
        - [Custom snapshot directory](./tests/examples/test_custom_snapshot_directory.py)
        - [Custom snapshot name](./tests/examples/test_custom_snapshot_name.py)
        - [Custom object snapshots](./tests/examples/test_custom_object_repr.py)
        - [JPEG image extension](./tests/examples/test_custom_image_extension.py)
        - [Built-in image extensions](./tests/test_extension_image.py)
        
        ## Uninstalling
        
        ```python
        pip uninstall syrupy
        ```
        
        ## Contributing
        
        Feel free to open a PR. This project is still in a very early stage, and we're still figuring out what direction we want to move towards.
        
        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](./CONTRIBUTING.md)
        
        ## Contributors
        
        <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
        <!-- prettier-ignore-start -->
        <!-- markdownlint-disable -->
        <table>
          <tr>
            <td align="center"><a href="https://noahnu.com"><img src="https://avatars0.githubusercontent.com/u/1297096?v=4" width="100px;" alt=""/><br /><sub><b>Noah</b></sub></a><br /><a href="#infra-noahnu" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#ideas-noahnu" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/tophat/syrupy/commits?author=noahnu" title="Code">💻</a> <a href="https://github.com/tophat/syrupy/commits?author=noahnu" title="Documentation">📖</a> <a href="https://github.com/tophat/syrupy/commits?author=noahnu" title="Tests">⚠️</a></td>
            <td align="center"><a href="http://emmanuel.ogbizi.com"><img src="https://avatars0.githubusercontent.com/u/2528959?v=4" width="100px;" alt=""/><br /><sub><b>Emmanuel Ogbizi</b></sub></a><br /><a href="https://github.com/tophat/syrupy/commits?author=iamogbz" title="Code">💻</a> <a href="#design-iamogbz" title="Design">🎨</a> <a href="#infra-iamogbz" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/tophat/syrupy/commits?author=iamogbz" title="Documentation">📖</a> <a href="https://github.com/tophat/syrupy/commits?author=iamogbz" title="Tests">⚠️</a></td>
          </tr>
        </table>
        
        <!-- markdownlint-enable -->
        <!-- prettier-ignore-end -->
        <!-- ALL-CONTRIBUTORS-LIST:END -->
        This section is automatically generated via tagging the all-contributors bot in a PR:
        
        ```text
        @all-contributors please add <username> for <contribution type>
        ```
        
        ## License
        
        Syrupy is licensed under [Apache License Version 2.0](./LICENSE).
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Pytest
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Libraries
Requires-Python: ~=3.6
Description-Content-Type: text/markdown
Provides-Extra: dev
Provides-Extra: test
