[REST API source] adds function to check connection #357
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.
Tell us what you do here
Relevant issue
issue #313
More PR info
This PR adds a convenience function to test whether a configuration can connect to the API endpoint.
Possible usages
See demo in
rest_api_pipeline.py
for ways of using this function.Disadvantages of current implementation strategy
Requires awareness of the developer that it yields from the source. If a call to
check_connection()
is part of a pipeline run, it must be used with a separate source object to avoid losing data.I tried calling
copy.deepcopy
on the source argument, but it crashed withRecursionError: maximum recursion depth exceeded
Alternatives
Implement
check_connection
as a method on a subclass ofDltSource
, e.g.GenericApiSource