Implement asyncio support, plus session optimizations #87
Conversation
This file contains hidden or 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
seandstewart
changed the title
added 9 commits
February 22, 2024 18:26
added 3 commits
February 28, 2024 14:34
…ll supported python interpreters.
|
@rubydog I'd appreciate a review when you have time, this is a major blocker for my company's onboarding. Here is the test output below: |
|
Hi @seandstewart, thanks for the PR. I will take a look at it and try to get back to you by next week. Cheers |
seandstewart
commented
Mar 6, 2024
Comment on lines
+152
to
+156
| def initialize(self): | ||
| raise NotImplementedError() | ||
|
|
||
| def teardown(self): | ||
| raise NotImplementedError() |
There was a problem hiding this comment.
Introduced an initializer method and a clean up method - these should be called by the developer at app startup and app shutdown.
Comment on lines
+158
to
+171
| def _get(self, url: str, query: QueryT | None = None): | ||
| """ | ||
| Wrapper for the HTTP Request, | ||
| Rate Limit Backoff is handled here, | ||
| Responses are Processed with ResourceBuilder. | ||
| """ | ||
| raise NotImplementedError() | ||
|
|
||
| def _cache_content_types(self): | ||
| """ | ||
| Updates the Content Type Cache. | ||
| """ | ||
|
|
||
| raise NotImplementedError() |
There was a problem hiding this comment.
Implementation details handled by subclasses.
Comment on lines
+173
to
+192
| @property | ||
| def client_info(self) -> ClientInfo: | ||
| if self._client_info is None: | ||
| self._client_info = self._get_client_info() | ||
|
|
||
| return self._client_info | ||
|
|
||
| @property | ||
| def headers(self) -> dict[str, str]: | ||
| if self._headers is None: | ||
| self._headers = self._request_headers() | ||
|
|
||
| return self._headers | ||
|
|
||
| @property | ||
| def proxy_info(self) -> abstract.ProxyInfo: | ||
| if self._proxy_info is None: | ||
| self._proxy_info = self._proxy_parameters() | ||
|
|
||
| return self._proxy_info |
There was a problem hiding this comment.
These were re-created with every request to Contentful. We're now only generating this information once, which is much more efficient.
Comment on lines
+194
to
+221
| @property | ||
| def transport(self) -> abstract.AbstractTransport: | ||
| if self._transport is None: | ||
| self._transport = self._get_transport() | ||
|
|
||
| return self._transport | ||
|
|
||
| def qualified_url(self) -> str: | ||
| scheme = "https://" if self.https else "http://" | ||
| hostname = self.api_url | ||
| if hostname.startswith("http"): | ||
| scheme = "" | ||
|
|
||
| path = f"/spaces/{self.space_id}/environments/{self.environment}/" | ||
| url = f"{scheme}{hostname}{path}" | ||
| return url | ||
|
|
||
| def _get_transport(self) -> abstract.AbstractTransport: | ||
| base_url = self.qualified_url() | ||
| transport = self.transport_cls( | ||
| base_url=base_url, | ||
| timeout_s=self.timeout_s, | ||
| proxy_info=self.proxy_info, | ||
| default_headers=self.headers, | ||
| max_retries=self.max_rate_limit_retries, | ||
| max_retry_wait_seconds=self.max_rate_limit_wait, | ||
| ) | ||
| return transport |
There was a problem hiding this comment.
We initialize the transport lazily and provide the fully-qualified URL to the targeted Contentful space/env as a base_url to the Transport.
Comment on lines
+313
to
+319
| def _format_params(self, query: QueryT | None) -> dict[str, str]: | ||
| query = query or {} | ||
| params = queries.normalize(**query) | ||
| if not self.authorization_as_header: | ||
| params["access_token"] = self.access_token | ||
|
|
||
| return params |
There was a problem hiding this comment.
Isolated query-string formatting into a more efficient, generic normalizer.
Comment on lines
+16
to
+35
| __all__ = ( | ||
| "Client", | ||
| "AsyncClient", | ||
| "Entry", | ||
| "Asset", | ||
| "Space", | ||
| "Locale", | ||
| "Link", | ||
| "ContentType", | ||
| "DeletedAsset", | ||
| "DeletedEntry", | ||
| "ContentTypeCache", | ||
| "ContentTypeField", | ||
| ) | ||
|
|
||
| _metadata = metadata.metadata(__package__) | ||
|
|
||
| __version__ = _metadata.get("version") | ||
| __author__ = _metadata.get("author") | ||
| __email__ = _metadata.get("author-email") |
There was a problem hiding this comment.
Defining an __all__ and using importlib.metadata to get package metadata.
| ) | ||
| logger.debug( | ||
| f"{prefix}{retry_message}", | ||
| extra={"tries": tries, "reset_time": reset_time}, |
There was a problem hiding this comment.
Passing in extra= will work well with structured logging for app developers.
Comment on lines
+36
to
+41
| def update_cache(cls, *, space_id: str, content_types: list[ContentType]): | ||
| """ | ||
| Updates the Cache with all Content Types from the Space. | ||
| """ | ||
|
|
||
| cls.__CACHE__[client.space_id] = client.content_types() | ||
| cls.__CACHE__[space_id] = content_types |
There was a problem hiding this comment.
Breaking change: Can't implicitly call the client - interface now requires that you call the client and pass in the result.
tests/test_async_client.py
Outdated
There was a problem hiding this comment.
Copied from test_client and updated for async.
Comment on lines
+129
to
+133
| error = errors.get_error_for_status_code( | ||
| response.status_code, | ||
| content=response.content, | ||
| headers=response.headers, | ||
| ) |
There was a problem hiding this comment.
Only major update was to migrate to the new function.
@rubydog Sounds good. I've gone through and added a self-review! |
|
Hello, any status update for this PR? |
|
Hi @pdelagrave, We are currently discussing internally whether we want to support asyncio. Given the scope of this PR, it will take me some time to review it thoroughly. Apologies for the delay. |
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.
This change adds support for asyncio. In order to do so, I made the following changes:
resolves #86