This repository has been archived by the owner on Sep 14, 2020. It is now read-only.
Remove an abstraction leak of a Response object — for type-hinting #197
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
🤖 zincr found 0 problems , 0 warnings |
| items = [] | ||
| resource_version = rsp.get('metadata', {}).get('resourceVersion', None) | ||
| for item in rsp['items']: | ||
| # FIXME: fix in pykube to inject the missing item's fields from the list's metainfo. |
There was a problem hiding this comment.
I didn't find an issue on pykube for that, hasn't it been reported yet?
There was a problem hiding this comment.
Nope. Not sure it should be there either. It is the way how K8s API works.
jonathanbeber
approved these changes
Oct 4, 2019
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Refactor clients-to-reactor communication to prepare for the overall type-hinting.
Description
Since the switch to pykube-ng (#71 #110), there was an abstraction leak in the list-fetching client wrapper: the
requests.Responseobject was returned, thus exposing the internal implementation of a sibling module.In this PR, the leak is removed, and the function now exposes only the data needed. It also takes the hacky data recovery (missing
apiVersion&kindin the lists) from the Kopf's reactor into the client wrapper.Having this in place will also simplify future switch to other HTTP clients, such as asyncio (see #176), as there is no such a specific response object in other implementations.
The function is intentionally renamed: to break things if someone for some reason uses this private function in their code — since its signature is now different (another result type).
Types of Changes
There are no behavioural changes. Only the code refactoring. The tests show that all the protocols and interfaces are kept in place — except for the imports of the internal modules (not exposed via
kopf/__init__.py).