V6.0.0 Release: RemoteZip, Automated Error Reporting, raise_if_incomplete()

[SpicyGarlicAlbacoreRoll]

v6.0.0

Added

• Search errors are now automatically reported to ASF, users can opt out by changing asf_search.REPORT_ERRORS after import
  • Example and information available in "Usage" section of /examples/1-Basic_Overview.ipynb
• ASFSearchResults now has raise_if_incomplete() method, raises ASFSearchError() if a search encountered an error and was unable to return all results from CMR
• ASFProduct now has a remotezip() method, which takes a user's pre-authenticated ASFSession and returns a RemoteZip object. This can be used to list and download specific files from a product's zip archive, rather than the whole zip file.
  • Example available in /examples/5-Download.ipynb
  • see https://github.com/gtsystem/python-remotezip for further details on how to use the RemoteZip class.
• Adds GRD_FD, PROJECTED_ML3X3, THREEFP product type constants.

Changed

• While returning results, search() will no longer throw. Instead, search() will retry the request 3 times. If all 3 attempts fail:
  • search() will return the results it found before the search error
  • An error will be logged warning the user, and the returned results will be marked as incomplete. Use raise_if_incomplete() to raise an error when the returned ASFSearchResults are incomplete.

[review-notebook-app[bot]]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[codecov-commenter]

Codecov Report

Merging #160 (75b6937) into stable (8a1f000) will decrease coverage by 0.09%. The diff coverage is 84.14%.

@@            Coverage Diff             @@
##           stable     #160      +/-   ##
==========================================
- Coverage   89.26%   89.16%   -0.10%     
==========================================
  Files          47       48       +1     
  Lines        1574     1634      +60     
==========================================
+ Hits         1405     1457      +52     
- Misses        169      177       +8     

Flag	Coverage Δ
unittests	89.16% <84.14%> (-0.10%)	:arrow_down:

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
asf_search/download/download.py	54.90% <40.00%> (-0.42%)	:arrow_down:
asf_search/ASFProduct.py	81.81% <50.00%> (-3.19%)	:arrow_down:
asf_search/search/error_reporting.py	76.19% <76.19%> (ø)
asf_search/ASFSearchResults.py	75.00% <100.00%> (+3.57%)	:arrow_up:
asf_search/constants/PRODUCT_TYPE.py	100.00% <100.00%> (ø)
asf_search/download/__init__.py	100.00% <100.00%> (ø)
asf_search/exceptions.py	100.00% <100.00%> (ø)
asf_search/search/baseline_search.py	95.74% <100.00%> (+0.18%)	:arrow_up:
asf_search/search/search.py	96.36% <100.00%> (+1.91%)	:arrow_up:
asf_search/search/search_count.py	100.00% <100.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.