Sourced from syrupy's releases.

v5.0.0

Syrupy 5.0.0

(2025-09-28)

This release introduces new features, bug fixes, and a major license change. It also includes several breaking changes, so please review those carefully before upgrading.

---

New Features ✨

• Add --snapshot-dirname option: A new option, --snapshot-dirname, is now available to change the default directory snapshots are stored in. ([#810](syrupy-project/syrupy#810))
• Remove private underscore prefix: The unnecessary underscore prefixes have been removed from public methods for better code clarity. ([8cfc905](syrupy-project/syrupy@8cfc905))

---

Bug Fixes 🐛

• Fix terminal summary for xdist workers: Resolves an issue where the terminal summary was not displayed correctly with xdist workers. ([#978](syrupy-project/syrupy#978))
• Ensure pytest_assertrepr_compare hook is called first: This change ensures that Syrupy's assertion hook takes precedence, improving compatibility with other plugins. ([#984](syrupy-project/syrupy#984))

---

Breaking Changes ⚠️

• License change: The project has switched to the more permissive MIT license. This change applies to all versions from 5.0.0 and beyond. If you need to use the previous Apache 2.0 license, you must continue to use Syrupy versions 4.x or earlier. ([#945](syrupy-project/syrupy#945))

• Python and pytest version requirements: Syrupy now requires Python 3.10 or higher. Support for Python 3.8 has been dropped as it reached its end of life in October 2024. The minimum required version of pytest is v8. ([#904](syrupy-project/syrupy#904), [#1024](syrupy-project/syrupy#1024))

• Method and constant name changes: Several methods and constants have been renamed for improved clarity and to align with public API standards.

  • SnapshotCollectionStorage

    • _read_snapshot_collection -> read_snapshot_collection
    • _read_snapshot_data_from_location -> read_snapshot_data_from_location
    • _write_snapshot_collection -> write_snapshot_collection
    • _get_file_basename -> get_file_basename
    • _file_extension -> file_extension

  • AmberDataSerializer

    • _snapshot_sort_key -> snapshot_sort_key

  • Constants

    • SNAPSHOT_EMPTY_FOSSIL_KEY -> SNAPSHOT_EMPTY_COLLECTION_KEY
    • SNAPSHOT_UNKNOWN_FOSSIL_KEY -> SNAPSHOT_UNKNOWN_COLLECTION_KEY
    • SNAPSHOT_DIRNAME has been removed in favour of the property on the SnapshotCollectionStorage class and associated CLI option.

New Contributors

• @​paul-ollis made their first contribution in syrupy-project/syrupy#978
• @​rahuliyer95 made their first contribution in syrupy-project/syrupy#984

Full Changelog: syrupy-project/syrupy@v4.9.1...v5.0.0

Sourced from syrupy's changelog.

5.0.0 (2025-09-28)

• Switch to MIT license (#945) (d74d340)

Bug Fixes

• Block terminal summary for xdist workers. (#978) (33a848d)
• ensure syrupy's pytest_assertrepr_compare hook is called first. (#984) (eb0024d)

Code Refactoring

• remove incorrect private underscore prefix from public methods (8cfc905)

Features

• add --snapshot-dirname option, close #810 (27135c7)
• drop support for py3.8, raise min. pytest to v8 (#904) (a879ff1)
• update min. python version to 3.10 (#1024) (16b4113)

BREAKING CHANGES

• The following methods have been renamed:

SnapshotCollectionStorage

• _read_snapshot_collection -> read_snapshot_collection
• _read_snapshot_data_from_location -> read_snapshot_data_from_location
• _write_snapshot_collection -> write_snapshot_collection
• _get_file_basename -> get_file_basename
• _file_extension -> file_extension

AmberDataSerializer

• _snapshot_sort_key -> snapshot_sort_key

Renamed constants to improve clarity:

constants

• SNAPSHOT_EMPTY_FOSSIL_KEY -> SNAPSHOT_EMPTY_COLLECTION_KEY
• SNAPSHOT_UNKNOWN_FOSSIL_KEY -> SNAPSHOT_UNKNOWN_COLLECTION_KEY

• Min. python version is now 3.10.
• The Syrupy project is switching from Apache 2.0 to a more permissive MIT license. By using Syrupy >=5, you agree to abide by this new license. You can continue to use Syrupy v1 through v4 under Apache 2.0.
• Drops support for Python 3.8 which is end of life as of October 2024. Raises the minimum version of pytest to v8.

• 9b4cc82 chore(release): 5.0.0 [skip ci]
• af15385 Merge pull request #1027 from syrupy-project/test_py_3_14
• 461ad22 chore: test against py3.14
• 95ffbcb Merge pull request #1026 from syrupy-project/rename_methods
• 27135c7 feat: add --snapshot-dirname option, close #810
• 8cfc905 refactor: remove incorrect private underscore prefix from public methods
• e1dbf5d chore(deps): update python docker tag to v3.13.7 (#1025)
• 16b4113 feat: update min. python version to 3.10 (#1024)
• 434c63f chore(deps): update codecov/codecov-action action to v5.5.1 (#1021)
• b2e49ba chore(deps): update dependency pytest to v8.4.2 (#1022)
• Additional commits viewable in compare view

You can trigger Dependabot actions by commenting on this PR:

• @dependabot rebase will rebase this PR
• @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
• @dependabot merge will merge this PR after your CI passes on it
• @dependabot squash and merge will squash and merge this PR after your CI passes on it
• @dependabot cancel merge will cancel a previously requested merge and block automerging
• @dependabot reopen will reopen this PR if it is closed
• @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
• @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
• @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)