[Refactor] Extract index request factory #420
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
jhamon
commented
Dec 3, 2024
| @@ -0,0 +1,30 @@ | |||
| class IndexClientInstantiationError(Exception): | |||
There was a problem hiding this comment.
Since I was already in a mode of pulling things out of index.py, I decided to move this to a different file as well.
austin-denoble
approved these changes
Dec 3, 2024
|
|
||
| class IndexRequestFactory: | ||
| @staticmethod | ||
| def query_request( |
There was a problem hiding this comment.
Good idea 👍 , I like encapsulating all of these helpers into a specific 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.
Problem
With my asyncio client in progress (not in this diff), I found myself needing to reuse a lot of the openapi request-building boilerplate.
Solution
Rather than copy/paste and create a lot of duplication, I want to pull that logic out into a separate class for building request objects. This change should not break existing behavior in the Index client.
Todo
This was pretty much just a mechanical extraction. I'd like to cleanup and standardize some stuff regarding
_check_type, an openapi param that we're going to silly lengths to flip the default behavior on, in a follow-up diff.Type of Change
Test Plan
Should still have tests passing