Feature: Yield Results

[SpicyGarlicAlbacoreRoll]

• search_generator() yields results page by page from CMR
• search() is now a wrapper for search_generator()
• Removes Jinja as a dependency for csv/metalink/kml output templating
• Search output formats now work with complete ASFSearchResults object, as well as the generator provided by search_generator()
• Adds a geojson stream array (unused by ASFSearchResults)

import asf_search as asf
from typing import Generator
from time import sleep

def as_csv(search_gen: Generator):
   csv_stream = asf.export.results_to_csv(search_gen)

   # begin querying cmr with search generator, 
   #yields each line of a csv formatted string
   for page in csv_stream:
      yield page

result_gen = asf.search_generator(platform=asf.SENTINEL1, maxResults=250)
for line in as_csv(result_gen):
   print(line)

[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 #164 (fe956f9) into master (7588598) will increase coverage by 0.97%. The diff coverage is 96.52%.

@@            Coverage Diff             @@
##           master     #164      +/-   ##
==========================================
+ Coverage   88.23%   89.21%   +0.97%     
==========================================
  Files          49       51       +2     
  Lines        1692     1920     +228     
==========================================
+ Hits         1493     1713     +220     
- Misses        199      207       +8     

Flag	Coverage Δ
unittests	89.21% <96.52%> (+0.97%)	:arrow_up:

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

Impacted Files	Coverage Δ
asf_search/export/export_translators.py	100.00% <ø> (ø)
asf_search/search/product_search.py	100.00% <ø> (ø)
asf_search/export/jsonlite.py	79.43% <93.93%> (-0.18%)	:arrow_down:
asf_search/export/csv.py	95.55% <95.45%> (-0.45%)	:arrow_down:
asf_search/search/search_generator.py	95.79% <95.79%> (ø)
asf_search/export/geojson.py	96.66% <96.66%> (ø)
asf_search/export/kml.py	96.90% <96.84%> (+1.07%)	:arrow_up:
asf_search/export/metalink.py	97.01% <97.01%> (-2.99%)	:arrow_down:
asf_search/ASFSearchResults.py	74.00% <100.00%> (+2.26%)	:arrow_up:
asf_search/WKT/validate_wkt.py	95.23% <100.00%> (ø)
... and 5 more

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