pysnaptest 0.4.0

No project description provided

PySnapTest

pysnaptest is a Python wrapper for the powerful Insta library written in Rust. It brings the simplicity and performance of snapshot testing from Rust to Python, enabling developers to quickly and easily test complex outputs, including strings, JSON, and other serializable data.

Snapshot testing helps ensure that your code produces consistent outputs as you make changes. By capturing the output of your code and comparing it to a stored "snapshot," you can detect unintended changes with ease.

Features

• Fast and Lightweight: Leverages Rust's high performance through the Insta library.
• Simple Integration: Easy-to-use Python API for snapshot testing.
• Human-Readable Snapshots: Snapshots are stored in a clean, readable format.
• Flexible Matchers: Supports testing strings, JSON, and other data structures.
• Automatic Snapshot Updates: Conveniently update snapshots when intended changes are made.
• CI-Friendly: Great for continuous integration workflows.

Installation

You can install pysnaptest via pip:

pip install pysnaptest

Usage

The snapshot decorator makes it easy to capture the return value of a test function:

from pysnaptest import snapshot

@snapshot
def test_basic():
    return {"hello": "world"}

You can also assert snapshots directly without using a decorator:

from pysnaptest import assert_json_snapshot

def test_direct():
    data = {"hello": "world"}
    assert_json_snapshot(data)

For tests that call external APIs you can patch the function and snapshot its return value:

from pysnaptest import patch_json_snapshot, snapshot
from my_project.main import use_http_request

@patch_json_snapshot("my_project.main.http_request")
@snapshot
def test_use_http_request():
    return use_http_request()

Updating Snapshots

If the output changes intentionally, you can review and update snapshots using cargo-insta review. The tool used for this, cargo-insta, is distributed via Rust's package manager cargo.

Installing cargo-insta

1. Install Rust using rustup if it is not already present.
2. Install the CLI with:

cargo install cargo-insta

With the binary on your PATH you can review snapshots using:

cargo-insta review

This command presents an interactive diff viewer where you can approve or reject changes. Snapshot files are saved under a snapshots directory next to each test module. Set the environment variable INSTA_WORKSPACE_ROOT when running your tests so both the library and cargo-insta know where snapshots are stored. In the example project the tests are inside a tests folder, so pytest.ini sets INSTA_WORKSPACE_ROOT=tests, allowing the CLI to find examples/my_project/tests/snapshots.

Examples

To help you get started, we’ve included a collection of examples in the examples folder. These examples demonstrate how to use pysnaptest in projects and cover common use cases like snapshotting strings, JSON, and other data structures.

To try them out:

cd examples/my_project
pytest

Feel free to explore, modify, and build upon these examples for your own projects!

Contributing

We welcome contributions to pysnaptest! To get started:

1. Fork the repository.
2. Create a new branch for your feature or fix.
3. Submit a pull request with a clear description of your changes.

License

pysnaptest is licensed under the Apache License, Version 2.0. See the LICENSE file for details.

Acknowledgments

This library is inspired by and built upon the excellent Insta library. A big thank you to the Insta team for creating such a fantastic tool!