feat: add client cached_session
#327
Closed
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
jooola
changed the title
cached_session
jooola
commented
Nov 22, 2023
hcloud/_client.py
Outdated
Comment on lines
245
to
256
| @contextmanager | ||
| def cached_session(self) -> Generator[Client, None, None]: | ||
| """ | ||
| Provide a copy of the :class:`Client <hcloud.Client>` as context manager that | ||
| will cache all GET requests. | ||
|
|
||
| Cached response will not expire automatically, therefore the cached client must | ||
| not be used for long living scopes. | ||
| """ | ||
| client = copy.deepcopy(self) | ||
| client.session(CachedSession()) | ||
| yield client |
There was a problem hiding this comment.
I am not yet convinced about this implementation; I might only allow users to configure the session, and move the CachedSession code to the ansible inventory project for the time we need to iron it out.
apricote
approved these changes
Nov 22, 2023
jooola
force-pushed
the
bound_model_caching
branch
from
c11d5ff to
f2470f4
Compare
Use this cached session in short lived scopes. Prevent calling the API too often when iterating over a list of resource that contains the same objects.
Co-authored-by: Julian Tölle <[email protected]>
Co-authored-by: Julian Tölle <[email protected]>
If we copy the client, some bound models that where created during the cached session, will still hold the reference to the cached_client, even outside the scope of the context manager. By not copying the client, we ensure that the bound model client is not caching request outside the scope of the context.
jooola
force-pushed
the
bound_model_caching
branch
from
f2470f4 to
2dbf6e0
Compare
|
Closing as won't fix. Users can implement their own caching strategy by extending the Client class. |
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.
Use this cached session in short-lived scopes. Prevent calling the API too often when iterating over a list of resource that contains the same objects (e.g. servers with the same network).