Merge pull request #2611 from bsipocz/vizier_fix_nonvo_return_type

BUG: Vizier fix non-VO return_type and minor maintenance

Author: bsipocz

CHANGES.rst

@@ -442,8 +442,11 @@ vizier
 
 - It is now possible to specify 'galatic' centers in region queries to
   have box queries oriented along the galactic axes. [#2152]
+
 - Optional keyword arguments are now keyword only. [#2610]
 
+- Fix parsing vizier_tsvfile returns. [#2611]
+
 
 Infrastructure, Utility and Other Changes and Additions
 -------------------------------------------------------

astroquery/vizier/core.py

@@ -45,7 +45,7 @@ class VizierClass(BaseQuery):
         schema.Or([_str_schema], _str_schema, None),
         error="catalog must be a list of strings or a single string")
 
-    def __init__(self, columns=["*"], column_filters={}, catalog=None,
+    def __init__(self, *, columns=["*"], column_filters={}, catalog=None,
                  keywords=None, ucd="", timeout=conf.timeout,
                  vizier_server=conf.server, row_limit=conf.row_limit):
         """
@@ -178,7 +178,7 @@ def keywords(self, value):
     def keywords(self):
         self._keywords = None
 
-    def find_catalogs(self, keywords, include_obsolete=False, verbose=False,
+    def find_catalogs(self, keywords, *, include_obsolete=False, verbose=False,
                       max_catalogs=None, return_type='votable'):
         """
         Search Vizier for catalogs based on a set of keywords, e.g. author name
@@ -244,7 +244,7 @@ def find_catalogs(self, keywords, include_obsolete=False, verbose=False,
 
         return result
 
-    def get_catalogs_async(self, catalog, verbose=False, return_type='votable',
+    def get_catalogs_async(self, catalog, *, verbose=False, return_type='votable',
                            get_query_payload=False):
         """
         Query the Vizier service for a specific catalog
@@ -677,7 +677,7 @@ def _parse_result(self, response, *, get_catalog_names=False, verbose=False,
         """
         if response.content[:5] == b'<?xml':
             try:
-                return parse_vizier_votable(
+                return _parse_vizier_votable(
                     response.content, verbose=verbose, invalid=invalid,
                     get_catalog_names=get_catalog_names)
             except Exception as ex:
@@ -691,7 +691,7 @@ def _parse_result(self, response, *, get_catalog_names=False, verbose=False,
                                       "self.parsed_result.\n Exception: " +
                                       str(self.table_parse_error))
         elif response.content[:5] == b'#\n#  ':
-            return parse_vizier_tsvfile(response.content, verbose=verbose)
+            return _parse_vizier_tsvfile(response.content, verbose=verbose)
         elif response.content[:6] == b'SIMPLE':
             return fits.open(BytesIO(response.content),
                              ignore_missing_end=True)
@@ -710,19 +710,19 @@ def valid_keywords(self):
         return self._valid_keyword_dict
 
 
-def parse_vizier_tsvfile(data, *, verbose=False):
+def _parse_vizier_tsvfile(data, *, verbose=False):
     """
     Parse a Vizier-generated list of tsv data tables into a list of astropy
     Tables.
 
     Parameters
     ----------
-    data : ascii str
-        An ascii string containing the vizier-formatted list of tables
+    data : response content bytes
+       Bytes containing the vizier-formatted list of tables
     """
 
     # http://stackoverflow.com/questions/4664850/find-all-occurrences-of-a-substring-in-python
-    split_indices = [m.start() for m in re.finditer('\n\n#', data)]
+    split_indices = [m.start() for m in re.finditer(b'\n\n#', data)]
     # we want to slice out chunks of the file each time
     split_limits = zip(split_indices[:-1], split_indices[1:])
     tables = [ascii.read(BytesIO(data[a:b]), format='fast_tab', delimiter='\t',
@@ -731,8 +731,8 @@ def parse_vizier_tsvfile(data, *, verbose=False):
     return tables
 
 
-def parse_vizier_votable(data, *, verbose=False, invalid='warn',
-                         get_catalog_names=False):
+def _parse_vizier_votable(data, *, verbose=False, invalid='warn',
+                          get_catalog_names=False):
     """
     Given a votable as string, parse it into dict or tables
     """

astroquery/vizier/tests/test_vizier_remote.py

@@ -49,9 +49,10 @@ def test_query_region_async_galactic(self):
         assert "-c=G" in payload
 
     def test_query_Vizier_instance(self):
-        v = vizier.core.Vizier(
-            columns=['_RAJ2000', 'DEJ2000', 'B-V', 'Vmag', 'Plx'],
-            column_filters={"Vmag": ">10"}, keywords=["optical", "xry"])
+        with pytest.warns(UserWarning, match="xry : No such keyword"):
+            v = vizier.core.Vizier(
+                columns=['_RAJ2000', 'DEJ2000', 'B-V', 'Vmag', 'Plx'],
+                column_filters={"Vmag": ">10"}, keywords=["optical", "xry"])
 
         result = v.query_object("HD 226868", catalog=["NOMAD", "UCAC"])
         assert isinstance(result, commons.TableList)
@@ -64,7 +65,7 @@ def test_vizier_column_restriction(self):
         # catalogs include Bmag's
         v = vizier.core.Vizier(
             columns=['_RAJ2000', 'DEJ2000', 'B-V', 'Vmag', 'Plx'],
-            column_filters={"Vmag": ">10"}, keywords=["optical", "xry"])
+            column_filters={"Vmag": ">10"}, keywords=["optical", "X-ray"])
 
         result = v.query_object("HD 226868", catalog=["NOMAD", "UCAC"])
         for table in result:
@@ -97,7 +98,8 @@ def test_regressiontest_invalidtable(self):
             keywords=['Radio', 'IR'], row_limit=5000)
         C = SkyCoord(359.61687 * u.deg, -0.242457 * u.deg, frame="galactic")
 
-        V.query_region(C, radius=2 * u.arcmin)
+        with pytest.warns(UserWarning, match="VOTABLE parsing raised exception"):
+            V.query_region(C, radius=2 * u.arcmin)
 
     def test_multicoord(self):
 
@@ -133,3 +135,10 @@ def test_findcatalog_ucd(self):
         assert len(result) >= 628
         # important part: we're testing that UCD is parsed and some catalogs are ruled out
         assert len(ucdresult) < len(result)
+
+    def test_asu_tsv_return_type(self):
+        V = vizier.core.Vizier()
+        result = V.query_object("HD 226868", catalog=["NOMAD", "UCAC"], return_type='asu-tsv', cache=False)
+
+        assert isinstance(result, list)
+        assert len(result) == 3

docs/vizier/vizier.rst

@@ -230,7 +230,6 @@ on the Vizier class.
 
     >>> v = Vizier(columns=['_RAJ2000', '_DEJ2000','B-V', 'Vmag', 'Plx'],
     ...            column_filters={"Vmag":">10"}, keywords=["optical", "xry"])
-
     WARNING: xry : No such keyword [astroquery.vizier.core]
 
 Note that whenever an unknown keyword is specified, a warning is emitted and