added explicit download file functions #384
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
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.
Before, there was a single
web.download()function that grabbed the entire.hdf5.The private
web._download_file()could grab individual files from the server if the user knew the path.This file also didn't try to authenticate, and would fail without a useful warning if trying to do so without calling another webapi function first.
This PR adds
web.download_log(),web.download_json(),web.download_simulation() -> Simulationfunctions for explicitly grabbing the files a user would want. The last function is for convenience to avoid needing to then load the file intoSimulation(could remove it).Also, the authentication bits (and checking of task status) were moved into
_download_file()so they are always called.Note: Tested by importing and calling each of these functions on a specific task.
Also tested by running
WebAPI.ipynbnotebook.