CASMCMS-9225: Create generic API client class #398
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
mharding-hpe
commented
Dec 17, 2024
mharding-hpe
force-pushed
the
casmcms-9225-03-api-clients
branch
from
c1ee966 to
5493a7d
Compare
mharding-hpe
requested review from
jsl-hpe,
jsollom-hpe,
rbak-hpe and
kumarrahul04
mharding-hpe
force-pushed
the
casmcms-9225-02-endpoints
branch
from
a92800f to
7c43912
Compare
mharding-hpe
force-pushed
the
casmcms-9225-03-api-clients
branch
from
5493a7d to
66b20d2
Compare
kumarrahul04
approved these changes
Dec 17, 2024
mharding-hpe
force-pushed
the
casmcms-9225-02-endpoints
branch
from
f6b566b to
90aa877
Compare
mharding-hpe
force-pushed
the
casmcms-9225-03-api-clients
branch
from
66b20d2 to
3b8b36c
Compare
mharding-hpe
force-pushed
the
casmcms-9225-02-endpoints
branch
from
90aa877 to
725d4a6
Compare
mharding-hpe
force-pushed
the
casmcms-9225-03-api-clients
branch
from
664a1a7 to
6268c27
Compare
mharding-hpe
force-pushed
the
casmcms-9225-02-endpoints
branch
from
725d4a6 to
fda1560
Compare
mharding-hpe
force-pushed
the
casmcms-9225-03-api-clients
branch
from
6268c27 to
36528e1
Compare
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 PR creates a generic API client class, built on top of the API endpoint classes from this PR. The
APIClientis a subclass ofRequestsRetryManagerfrombos.common.utils, and that is a subclasss of theRequestsRetryManagerclass from therequests-retry-sessionPython package.Basically, the
RetrySessionManagerclass can be used to turn any other class into a context manager that contains a requests session, one that is only initialized if it is used. And this request session (and its underlying HTTP adapter) will both be closed out automatically by the context manager.The
bos.common.utilssubclass just specified the default argument values that BOS uses for its requests sessions.The
APIClientsubclass includes a method (get_endpoint) which will be used to retrieve endpoints for specific API endpoints. It initializes them on demand, and passes in its managed request session. When used as a context manager, it clears its record of the endpoints that it initialized (because the session they are using is also cleaned up when the context manager exits).This will be used as the building block for the API clients coming in the next PRs. Right now, this PR does not modify anything to use this client class.