refactor: write performance improvements, api clarity #645
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## next #645 +/- ##
==========================================
- Coverage 99.59% 99.58% -0.01%
==========================================
Files 17 17
Lines 1236 1216 -20
==========================================
- Hits 1231 1211 -20
Misses 5 5 |
noahnu
force-pushed
the
fix_write_performance
branch
from
fdb6dc5
to
3f762bb
Compare
added 5 commits
November 30, 2022 18:20
BREAKING CHANGE: PyTestLocation.filename has been renamed to .basename
BREAKING CHANGE: 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.
noahnu
force-pushed
the
fix_write_performance
branch
from
3f762bb
to
bbc7ef2
Compare
BREAKING CHANGE: The term 'fossil' has been replaced by the clearer term 'collection'.
noahnu
force-pushed
the
fix_write_performance
branch
from
7413123
to
6aa2f3f
Compare
added 7 commits
December 1, 2022 16:18
noahnu
changed the title
noahnu
added a commit
that referenced
this pull request
Dec 30, 2022
* fix: group snapshot writes by extension class * refactor: rename PyTestLocation.filename to .basename BREAKING CHANGE: 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 BREAKING CHANGE: 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. * refactor: rename Fossil to Collection BREAKING CHANGE: The term 'fossil' has been replaced by the clearer term 'collection'. * refactor: pass test_location to read_snapshot * refactor: remove singular write_snapshot method * refactor: dirname property to method * refactor: pass test_location to discover_snapshots * refactor: remove usage of self.test_location * refactor: make write_snapshot a classmethod * refactor: do not instantiate extension with test_location BREAKING CHANGE: Numerous instance methods have been refactored as classmethods.
noahnu
added a commit
that referenced
this pull request
Dec 30, 2022
* fix: group snapshot writes by extension class * refactor: rename PyTestLocation.filename to .basename BREAKING CHANGE: 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 BREAKING CHANGE: 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. * refactor: rename Fossil to Collection BREAKING CHANGE: The term 'fossil' has been replaced by the clearer term 'collection'. * refactor: pass test_location to read_snapshot * refactor: remove singular write_snapshot method * refactor: dirname property to method * refactor: pass test_location to discover_snapshots * refactor: remove usage of self.test_location * refactor: make write_snapshot a classmethod * refactor: do not instantiate extension with test_location BREAKING CHANGE: Numerous instance methods have been refactored as classmethods.
noahnu
added a commit
that referenced
this pull request
Dec 30, 2022
* fix: group snapshot writes by extension class * refactor: rename PyTestLocation.filename to .basename BREAKING CHANGE: 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 BREAKING CHANGE: 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. * refactor: rename Fossil to Collection BREAKING CHANGE: The term 'fossil' has been replaced by the clearer term 'collection'. * refactor: pass test_location to read_snapshot * refactor: remove singular write_snapshot method * refactor: dirname property to method * refactor: pass test_location to discover_snapshots * refactor: remove usage of self.test_location * refactor: make write_snapshot a classmethod * refactor: do not instantiate extension with test_location BREAKING CHANGE: Numerous instance methods have been refactored as classmethods.
noahnu
added a commit
that referenced
this pull request
Dec 30, 2022
* fix: group snapshot writes by extension class * refactor: rename PyTestLocation.filename to .basename BREAKING CHANGE: 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 BREAKING CHANGE: 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. * refactor: rename Fossil to Collection BREAKING CHANGE: The term 'fossil' has been replaced by the clearer term 'collection'. * refactor: pass test_location to read_snapshot * refactor: remove singular write_snapshot method * refactor: dirname property to method * refactor: pass test_location to discover_snapshots * refactor: remove usage of self.test_location * refactor: make write_snapshot a classmethod * refactor: do not instantiate extension with test_location BREAKING CHANGE: Numerous instance methods have been refactored as classmethods.
tophat-opensource-bot
pushed a commit
that referenced
this pull request
Feb 2, 2023
# [4.0.0](v3.0.6...v4.0.0) (2023-02-02) ### Bug Fixes * defer snapshot writes until end of session ([#606](#606)) ([68f1d5f](68f1d5f)) * ensure all pytest options are serializable ([#667](#667)) ([e8ed9f2](e8ed9f2)) * improve pytest-xdist compatibility ([9b9090f](9b9090f)) * lru_cache on snapshot reads ([#629](#629)) ([c1a675f](c1a675f)) * remove legacy path usage to support no:legacypath, closes [#677](#677) ([#684](#684)) ([6385979](6385979)) ### Code Refactoring * simplify data serializer for ambr ([#676](#676)) ([3d296e1](3d296e1)) * write performance improvements, api clarity ([#645](#645)) ([2c31c39](2c31c39)) ### Features * **json:** serialize None as null, close [#622](#622) ([c330680](c330680)) * numerically sort snapshots if possible, close [#657](#657) ([4ca0716](4ca0716)) * **serializer:** preserve key ordering of OrderedDict ([0a2289a](0a2289a)) * support overriding the amber serializer class ([#683](#683)) ([662c93f](662c93f)) * update python version, pytest version ([#658](#658)) ([c360b95](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. * refactor: rename Fossil to Collection * The term 'fossil' has been replaced by the clearer term 'collection'. * refactor: pass test_location to read_snapshot * refactor: remove singular write_snapshot method * refactor: dirname property to method * refactor: pass test_location to discover_snapshots * refactor: remove usage of self.test_location * refactor: make write_snapshot a classmethod * refactor: do not instantiate extension with test_location * Numerous instance methods have been refactored as classmethods.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR fixes the write perf regression in syrupy v4 prerelease. As part of the refactoring necessary to fix write perf for batch writes, I ended up simplifying some of the APIs. There are a number of breaking changes, from: