Add support for resolving instance attributes in the cache decorator #1235
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
2a9424f to
db97f03
Compare
This commit makes the documentation and typing around the utility cache decorator a bit more explicit. It also removes generic kwarg cache option in favour of the explicit timeout argument. The only other option accepted by the cache setter, other than `timeout`, is `version`, which we should avoid until there is an explicit reason to do so to keep the interface explicit.
The `skip_cache` option is currently unusued, and in order to use it, the decorated method would have to explicitly declare `skip_cache` as a kwarg option to control the decorator behavior, which is a pattern we should ideally avoid.
db97f03 to
19296c1
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #1235 +/- ##
===========================================
- Coverage 95.22% 95.22% -0.01%
===========================================
Files 968 969 +1
Lines 35249 35392 +143
===========================================
+ Hits 33566 33701 +135
- Misses 1683 1691 +8 ☔ View full report in Codecov by Sentry. |
19296c1 to
e26b691
Compare
pi-sigma
requested changes
Jun 3, 2024
|
Thanks @pi-sigma, useful improvements all.
I had those in |
This commit expands the cache decorator's key logic to interpolate instance attribute for methods, in addition to the regular arguments already supported. The typical use-case is an API client, where you will want to scope your method cache keys to instance specific attributes, like a specific endpoint, to avoid cache hits on cross-API calls.
e26b691 to
e883163
Compare
pi-sigma
approved these changes
Jun 3, 2024
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.
Taiga issue #2524.
This will be followed by a PR to actually use this in the ZGW clients (and will probably also remove a few tests that were really just testing the underlying caching logic, which I've included here in a more isolated form by testing the cache behavior directly).