perf: memoise DataSerializer.read_file results #543
Merged
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
noahnu
approved these changes
Aug 20, 2021
|
@all-contributors add @huonw for code, bug |
|
I've put up a pull request to add @huonw! 🎉 |
tophat-opensource-bot
pushed a commit
that referenced
this pull request
Aug 20, 2021
## [1.4.4](v1.4.3...v1.4.4) (2021-08-20) ### Performance Improvements * memoise DataSerializer.read_file results ([#543](#543)) ([df5b516](df5b516))
|
🎉 This PR is included in version 1.4.4 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
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 applies the
functools.lru_cachememoising decorator to the low levelamber.DataSerializer.read_filemethod, which dramatically improves performance by avoiding re-reading a single snapshot file dozens of times, thus eliminating the quadratic behaviour observed in #539 in the common case of read-only interaction with amber snapshots.For the test in #539, with a single snapshot test parametrised with
SIZEinstances (note that doubling the size now doubles the time):For our real-world test suite, with 453 snapshots across 25 files:
This has to be on this
DataSerializerclass method, rather than the higher level methods inAmberSnapshotExtensionbecause the methods there are instance methods, with aselfargument, and it's called on different instances (and thus end up as differentlru_cacheentries).This optimisation is limited to only reading the amber file types, but I think images (and other single-file snapshots) will not have the same quadratic issues, and writing is arguably much less common than reading.
Related Issues
Checklist
Additional Comments
No additional comments.