feat: on-set callback #39
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
dgilland
requested changes
Nov 15, 2023
Comment on lines
+37
to
+41
| #: Callback that will be executed when a cache entry is set. | ||
|
|
||
| #: It is called with arguments ``(key, new_value, old_value)`` where `key` is the cache key, | ||
| #: `new_value` is the value is set, | ||
| #: and `old_value` is the value is replaced(if the key didn't exist before, it's ``UNSET``). |
There was a problem hiding this comment.
Some minor changes to comment:
#: Callback that will be executed when a cache entry is set. It is called with arguments
#: ``(key, new_value, old_value)`` where `key` is the cache key, `new_value` is the value is set,
#: and `old_value` is the value it replaced (if the key didn't exist before, it's :const:`UNSET`).
src/cacheout/cache.py
Outdated
|
|
||
| # Delete key before setting it so that it moves to the end of the OrderedDict key list. | ||
| # Needed for cache strategies that rely on the ordering of when keys were last inserted. | ||
| self._delete(key, RemovalCause.SET) | ||
| self._delete(key, RemovalCause._IGNORE) |
There was a problem hiding this comment.
Would rather make the cause argument cause: t.Optional[RemovalCause] = None instead of adding RemovalCause._IGNORE to the enum (it's not a valid value).
tests/test_cache.py
Outdated
| cache.on_set = on_set | ||
|
|
||
| cache.set("a", 1) | ||
| assert re.match(r"^a=1, old_value=<object object at 0x.*>$", log) |
There was a problem hiding this comment.
I think we can simplify the assertion by not using re.match. One suggestion would be to make log a dictionary and set it to something like log = {"key": key, "new_value": new_value, "old_value": old_value}. Then can do assert log == {"key": "a", "new_value": 1, "old_value": UNSET}.
dgilland
approved these changes
Nov 17, 2023
Closed
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.
Usage
set
on_setcallback.on_setis a callable object.keyis the cache key.new_valueis the value is set.old_valueis the value is replaced(if the key didn't exist before, it'sUNSET).