fix: Allows clients to pass in an HTTP Session #59
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 pull request introduces changes to the
__init__
method of thecompass.py
module, which is responsible for initializing a compass client to interact with the Compass API. The modifications primarily involve updating the handling of thedefault_timeout
and introducing a newhttp_session
parameter.Changes:
default_timeout
parameter's type hint has been updated fromint
toint | None
, indicating that it can now acceptNone
as a valid value.http_session
, has been added to the__init__
method, allowing for the specification of an HTTP session with a custom timeout.SessionWithDefaultTimeout
class has been replaced with a conditional assignment, settingself.session
to either the providedhttp_session
or a new instance ofrequests.Session()
.default_timeout
is notNone
, indicating that the variable is deprecated and will not have any effect. This message also provides guidance on using thehttp_session
parameter for specifying HTTP request timeouts.