Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(deps-dev): bump syrupy from 1.7.0 to 4.0.1 #122

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

dependabot[bot]
Copy link

@dependabot dependabot bot commented on behalf of github Feb 24, 2023

Bumps syrupy from 1.7.0 to 4.0.1.

Release notes

Sourced from syrupy's releases.

v4.0.1

4.0.1 (2023-02-21)

Bug Fixes

  • serializer: handling of multi-part file extensions in SingleFileExtension (#710) (efe687e)

v4.0.0

4.0.0 (2023-02-02)

NOTE: You will need to regenerate snapshots if using the default Amber serializer. Run pytest --snapshot-update.

Performance

  • Writes no longer occur at assertion time, but are instead queued to happen at the end of the pytest session. This defers IO operations to the end of the test run, however it does increase memory usage. If this presents an issue, we can look at providing an opt-out mechanism for deferred writes. This should also improve pytest-xdist compatibility somewhat.

Breaking Changes

Requirements

  • Min. python version updated to 3.8.1. Since it's possible not everyone will be able to upgrade to Syrupy v4 because of the increase minimum python version, we will consider backporting critical bugs and security vulnerabilities on request (create a GitHub issue).
  • Min. pytest version updated to 7.0.0.

Bug Fixes

  • Removed legacy path usage to support no:legacypath. (#677)

Serializers

  • JSON: None is now serialized as null. (#622)
  • Amber/JSON: Key order of OrderedDicts are now preserved. (#618)
  • Amber: It's now possible to extend the default amber serializer to support numerical sorting of snapshot test cases. An experimental sorted data serializer is available. For an example of how to enable sorting, see test_amber_sort.py. Note that this currently has performance issues which is why it is not the default behaviour. (#657, #683)
  • Amber: A new "# serializer version: 1" line is now written to the top of each ambr file. Adopters of syrupy v4 will receive a message telling the user to regenerate snapshots. As with any major version update, you'll need to run pytest --snapshot-update. This version marker is being placed to make it simpler to support multiple versions of the amber serializer, and thus rollout what has previously been considered breaking changes, without queueing for a major version update.

Extensions API

  • For developers of custom Syrupy extensions, there are a number of changes to the public API of the various extension abstract classes:
    • pre/post read/write hooks have been removed. If you were using these hooks, please open a GitHub issue and we'll consider re-adding them (they had little usage and introduced maintenance complexity).
    • test_location is no longer passed to the constructor of extensions. Instead, it is now an explicit argument of most extension methods.
    • file_extension is now a class property rather than a property instance method.
    • dirname and various other filename related properties have been converted to class methods.
    • Renamed DataSerializer to AmberDataSerializer.
    • Serializers may now throw a TaintedSnapshotError which will tell the user to regenerate the snapshot even if the underlying data has not changed. This is to support rolling out more subtle changes to the serializers, such as the introduction of serializer metadata.

v3.0.6

3.0.6 (2022-12-30)

... (truncated)

Changelog

Sourced from syrupy's changelog.

4.0.1 (2023-02-21)

Bug Fixes

  • serializer: handling of multi-part file extensions in SingleFileExtension (#710) (efe687e)

4.0.0 (2023-02-02)

Bug Fixes

  • defer snapshot writes until end of session (#606) (68f1d5f)
  • ensure all pytest options are serializable (#667) (e8ed9f2)
  • improve pytest-xdist compatibility (9b9090f)
  • lru_cache on snapshot reads (#629) (c1a675f)
  • remove legacy path usage to support no:legacypath, closes #677 (#684) (6385979)

Code Refactoring

  • simplify data serializer for ambr (#676) (3d296e1)
  • write performance improvements, api clarity (#645) (2c31c39)

Features

  • json: serialize None as null, close #622 (c330680)
  • numerically sort snapshots if possible, close #657 (4ca0716)
  • serializer: preserve key ordering of OrderedDict (0a2289a)
  • support overriding the amber serializer class (#683) (662c93f)
  • update python version, pytest version (#658) (c360b95)

BREAKING CHANGES

  • Serializers may now throw a TaintedSnapshotError which will tell the user to regenerate the snapshot even if the underlying data has not changed. This is to support rolling out more subtle changes to the serializers, such as the introduction of serializer metadata.

  • Renamed DataSerializer to AmberDataSerializer.

  • serializer: Key order is now preserved if using OrderedDict in both the Amber serializer and JSON serializer.

  • json: The JSONSnapshotExtension now serializes Python's None as "null" rather than "None".

  • Raise minimum python version to 3.8.1 and min. pytest version to v7.

  • PyTestLocation.filename has been renamed to .basename

  • refactor: add test_location kwarg to get_snapshot_name

  • refactor: get_snapshot_name is now static as a classmethod

  • refactor: remove pre and post read/write hooks

  • Pre and post read/write hooks have been removed without replacement to make internal refactor simpler. Please open a GitHub issue if you have a use case for these hooks.

... (truncated)

Commits
  • 44539e9 chore(release): 4.0.1 [skip ci]
  • 5e8f86d chore: update dev dependencies (#713)
  • eb98ff1 docs: add tolgaeren as a contributor for bug (#712)
  • efe687e fix(serializer): handling of multi-part file extensions in SingleFileExtensio...
  • b831ee2 chore(deps): update dependency mypy to v1 (#706)
  • 266da13 chore(deps): bump cryptography from 39.0.0 to 39.0.1 (#702)
  • 03cc361 chore: consistency with dependabot (#708)
  • 3166746 Revert "chore: update python docker tag to v3.11.2 (#704)"
  • c4fd0d6 chore: update python docker tag to v3.11.2 (#704)
  • 967cab8 chore: update dependency invoke to v2 (#701)
  • Additional commits viewable in compare view

Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

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 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)

Bumps [syrupy](https://github.com/tophat/syrupy) from 1.7.0 to 4.0.1.
- [Release notes](https://github.com/tophat/syrupy/releases)
- [Changelog](https://github.com/tophat/syrupy/blob/main/CHANGELOG.md)
- [Commits](syrupy-project/syrupy@v1.7.0...v4.0.1)

---
updated-dependencies:
- dependency-name: syrupy
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot added dependencies Pull requests that update a dependency file python Pull requests that update Python code labels Feb 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file python Pull requests that update Python code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants