syrupy
Pytest Snapshot Test Utility
Decision gist · record as of 2026-08-14
Yes. Syrupy is actively maintained, has no security vulnerabilities, installs with minimal friction, and solves a real testing problem—regression detection on complex outputs. It's well-suited for projects that need to catch subtle changes in computed results. Install it if you're writing tests for data transformations, API responses, or any output where immutability matters but exact assertions are unwieldy.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python 3.10 or later and pytest 8 or later; snapshot fixture does not work directly in unittest.TestCase subclasses without a workaround.
- Installs with low friction as a pure Python wheel with only pytest as a runtime dependency.
- Actively maintained with a recent release; compatible with current Python versions (3.10+) and recent pytest versions (8+).
License · maintenance · safety
MIT (permissive) — MIT license permits free use, modification, and distribution with minimal restrictions, making it suitable for both open-source and proprietary projects.
last release 2026-07-11 (34 days) · last repo commit 2026-08-14 · 872 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 13,351,369 downloads/mo, #1,285 on PyPI
Alternatives
Verify before relying
pip install syrupy
# In test_example.py:
def test_foo(snapshot):
actual = "Some computed value!"
assert actual == snapshot
# Run: pytest --snapshot-update- Performance characteristics when handling very large snapshots or deeply nested object graphs.
- Exact extent of custom serializer extensibility beyond built-in types and __repr__ overrides.
What it is and what it does
Syrupy is a pytest plugin that implements snapshot testing—a pattern where test assertions compare computed output against stored reference snapshots to detect regressions. Instead of writing brittle assertions on exact values, you write `assert actual == snapshot`, and syrupy manages the stored snapshots for you. On first run, it fails and prompts you to generate snapshots; on subsequent runs, it compares against those stored files. If output changes, the test fails, alerting you to the difference. You can update snapshots with `pytest --snapshot-update` when changes are intentional.
The plugin is designed around three principles: extensibility (you can add custom serializers for unsupported types), idiomatic pytest style (snapshots work as natural assertions, not special methods), and soundness (tests fail if a snapshot is missing, not just on differences). It supports filtering object attributes via include/exclude functions, customizing serialization through `__repr__` overrides, and integrating with unittest TestCase subclasses through fixtures. Snapshots are stored in a `__snapshots__` directory alongside your tests and should be committed to version control.
Use it for
- Regression testing of complex data structures, API responses, or rendered output where exact values matter but are hard to predict.
- Validating that refactoring or optimization changes don't alter computed results unexpectedly.
- Testing serialization and deserialization of custom objects by comparing their snapshot representation.
- Detecting unintended changes to generated code, configuration, or formatted output in CI/CD pipelines.
- Documenting expected behavior by storing snapshots as living examples of what your code produces.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes.
Syrupy is actively maintained, has no security vulnerabilities, installs with minimal friction, and solves a real testing problem—regression detection on complex outputs. It's well-suited for projects that need to catch subtle changes in computed results. Install it if you're writing tests for data transformations, API responses, or any output where immutability matters but exact assertions are unwieldy.
Install
syrupy on PyPI
Before you install
Installs with low friction as a pure Python wheel with only pytest as a runtime dependency. Actively maintained with a recent release; compatible with current Python versions (3.10+) and recent pytest versions (8+).
Requires Python 3.10 or later and pytest 8 or later; snapshot fixture does not work directly in unittest.TestCase subclasses without a workaround.
License in practice
MIT license permits free use, modification, and distribution with minimal restrictions, making it suitable for both open-source and proprietary projects.
Quickstart
pip install syrupy
# In test_example.py:
def test_foo(snapshot):
actual = "Some computed value!"
assert actual == snapshot
# Run: pytest --snapshot-updateVerify before relying
- Performance characteristics when handling very large snapshots or deeply nested object graphs.
- Exact extent of custom serializer extensibility beyond built-in types and __repr__ overrides.
Package facts
| License | MIT permissive |
| Python support | Supports the current Python release >=3.10 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 1 packagepytest |
| Maintenance | Actively maintained 34 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 13,351,369 / month, #1,285 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 5 - Production/StableFramework :: PytestIntended Audience :: DevelopersOperating System :: OS IndependentProgramming Language :: Python :: 3Programming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.13Programming Language :: Python :: 3.14Topic :: Software Development :: LibrariesTopic :: Software Development :: TestingTopic :: Utilities |
Evidence: syrupy-5.5.3-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “assert immutability testing”
- syrupySyrupy is a pytest plugin that enables snapshot testing by letting…
- softestSoftest extends unittest.TestCase to allow multiple assertions to…
- assertsProvides stand-alone assertion functions for Python that work outside…
Give your agent the search over MCP, or paste the wish link into any chat.
More Libraries packages
urllib3 is an HTTP client library that provides thread-safe connection pooling, SSL/TLS verification, multipart file uploads, request retries, compression support, and proxy handling for Python applications.
Requests is a Python HTTP library that simplifies sending HTTP/1.1 requests with automatic handling of headers, authentication, cookies, and response parsing.
Pluggy provides a plugin system that lets you define hook specifications and register implementations to be called in sequence, enabling extensible Python applications without tight coupling.
Install it if you're building an extensible application or framework.
Provides parsing, arithmetic, and recurrence rule computation for dates and times, with timezone support and iCalendar RFC compliance.
Install it if you need to parse flexible date strings, compute relative dates, handle timezones, or work with recurrence rules—it's the de facto choice for these tasks.
Six provides utility functions to write Python code that runs on both Python 2.7 and Python 3.3+, smoothing over language differences between the two versions.
pytest is a testing framework that lets you write test functions using plain assert statements and automatically discovers and runs them, with detailed failure reporting.
See also pytest-snapshot · pytest-insta · snapshottest · inline-snapshot · pytest-clarity · pytest-textual-snapshot · pytest-subtests · pytest-ordering · pytest-order · pytest-catchlog