Merge pull request #3318 from nkphysics/skyview-add-get_query_payload

Added `get_query_payload` kwarg to skyview

Author: bsipocz

CHANGES.rst

@@ -51,6 +51,13 @@ SIMBAD
   mode. It provides slower to start, but more robust queries for which the timeout can
   be increased (with the ``timeout`` property or with the configuration file) [#3305]
 
+skyview
+^^^^^^^
+
+
+- Added ``get_query_payload`` kwarg to ``Skyview.get_images()`` and ``Skyview.get_images_list()``
+  to return the query payload [#3318]
+
 utils.tap
 ^^^^^^^^^
 

astroquery/skyview/core.py

@@ -79,16 +79,18 @@ def _generate_payload(self, input=None):
         url = urlparse.urljoin(self.URL, form.get('action'))
         return url, payload
 
-    def _submit_form(self, input=None, cache=True):
+    def _submit_form(self, input=None, cache=True, get_query_payload=False):
         url, payload = self._generate_payload(input=input)
+        if get_query_payload:
+            return payload
         response = self._request('GET', url, params=payload, cache=cache)
         response.raise_for_status()
         return response
 
     def get_images(self, position, survey, *, coordinates=None, projection=None,
                    pixels=None, scaling=None, sampler=None, resolver=None,
                    deedger=None, radius=None, height=None, width=None, cache=True,
-                   show_progress=True):
+                   show_progress=True, get_query_payload=False):
         """
         Query the SkyView service, download the FITS file that will be
         found and return a generator over the local paths to the
@@ -197,15 +199,18 @@ def get_images(self, position, survey, *, coordinates=None, projection=None,
                                                  projection=projection, pixels=pixels, scaling=scaling,
                                                  sampler=sampler, resolver=resolver, deedger=deedger,
                                                  radius=radius, height=height, width=width,
-                                                 cache=cache, show_progress=show_progress)
+                                                 cache=cache, show_progress=show_progress,
+                                                 get_query_payload=get_query_payload)
+        if get_query_payload:
+            return readable_objects
         return [obj.get_fits() for obj in readable_objects]
 
     @prepend_docstr_nosections(get_images.__doc__)
     def get_images_async(self, position, survey, *, coordinates=None,
                          projection=None, pixels=None, scaling=None,
                          sampler=None, resolver=None, deedger=None,
                          radius=None, height=None, width=None,
-                         cache=True, show_progress=True):
+                         cache=True, show_progress=True, get_query_payload=False):
         """
         Returns
         -------
@@ -214,16 +219,19 @@ def get_images_async(self, position, survey, *, coordinates=None,
         image_urls = self.get_image_list(position, survey, coordinates=coordinates,
                                          projection=projection, pixels=pixels, scaling=scaling, sampler=sampler,
                                          resolver=resolver, deedger=deedger, radius=radius,
-                                         height=height, width=width, cache=cache)
-        return [commons.FileContainer(url, encoding='binary',
-                                      show_progress=show_progress)
+                                         height=height, width=width, cache=cache,
+                                         get_query_payload=get_query_payload)
+        if get_query_payload:
+            return image_urls
+        return [commons.FileContainer(url, encoding='binary', show_progress=show_progress)
                 for url in image_urls]
 
     @prepend_docstr_nosections(get_images.__doc__, sections=['Returns', 'Examples'])
     def get_image_list(self, position, survey, *, coordinates=None,
                        projection=None, pixels=None, scaling=None,
                        sampler=None, resolver=None, deedger=None,
-                       radius=None, width=None, height=None, cache=True):
+                       radius=None, width=None, height=None, cache=True,
+                       get_query_payload=False):
         """
         Returns
         -------
@@ -263,7 +271,9 @@ def get_image_list(self, position, survey, *, coordinates=None,
             'imscale': size_deg,
             'size': size_deg,
             'pixels': pixels}
-        response = self._submit_form(input, cache=cache)
+        response = self._submit_form(input, cache=cache, get_query_payload=get_query_payload)
+        if get_query_payload:
+            return response
         urls = self._parse_response(response)
         return urls
 

astroquery/skyview/tests/test_skyview.py

@@ -76,6 +76,18 @@ def test_get_image_list_local(patch_get, patch_fromname):
         assert url.startswith('../../tempspace/fits/')
 
 
+def test_get_image_list_payload(patch_get, patch_fromname):
+    surveys = ['Fermi 5', 'HRI', 'NVSS']
+    payload = SkyView.get_image_list(position='Eta Carinae',
+                                     survey=surveys,
+                                     get_query_payload=True)
+    assert len(payload) == 14
+    assert payload["Position"] == '161.265 -59.6844'
+    assert len(payload["survey"]) == 3
+    for survey in surveys:
+        assert survey in payload["survey"]
+
+
 def test_survey_validation(patch_get):
     with pytest.raises(ValueError) as ex:
         SkyView.get_image_list(position='doesnt matter',