Merge pull request #2608 from bsipocz/xmatch_parse_error_from_votable

ENH: exposing error returned in a VOTable

Author: bsipocz

CHANGES.rst

@@ -155,6 +155,12 @@ svo_fps
 - The default wavelength range used by ``get_filter_index()`` was far too
   large. The user must now always specify both upper and lower limits. [#2509]
 
+xmatch
+^^^^^^
+
+- The reason for the query errors, as parsed from the returned VOTable is now
+  exposed as part of the traceback. [#2608]
+
 gaia
 ^^^^
 

astroquery/xmatch/core.py

@@ -1,15 +1,18 @@
 # Licensed under a 3-clause BSD style license - see LICENSE.rst
 
-from io import StringIO
+from io import StringIO, BytesIO
 
-from astropy.io import ascii
+from astropy.io import ascii, votable
 import astropy.units as u
 from astropy.table import Table
+from requests import HTTPError
 
-from . import conf
-from ..query import BaseQuery
-from ..utils import url_helpers, prepend_docstr_nosections, async_to_sync
 
+from astroquery.query import BaseQuery
+from astroquery.exceptions import InvalidQueryError
+from astroquery.utils import url_helpers, prepend_docstr_nosections, async_to_sync
+
+from . import conf
 try:
     from regions import CircleSkyRegion
 except ImportError:
@@ -106,7 +109,12 @@ def query_async(self, cat1, cat2, max_distance, colRA1=None, colDec1=None,
 
         response = self._request(method='POST', url=self.URL, data=payload,
                                  timeout=self.TIMEOUT, cache=cache, **kwargs)
-        response.raise_for_status()
+        try:
+            response.raise_for_status()
+        except HTTPError as err:
+            error_votable = votable.parse(BytesIO(response.content))
+            error_reason = error_votable.get_info_by_id('QUERY_STATUS').content
+            raise InvalidQueryError(error_reason) from err
 
         return response
 

astroquery/xmatch/tests/test_xmatch_remote.py

@@ -17,6 +17,7 @@
 except ImportError:
     pass
 
+from astroquery.exceptions import InvalidQueryError
 from ...xmatch import XMatch
 
 
@@ -111,3 +112,13 @@ def test_xmatch_query_with_cone_area(self, xmatch):
         except ReadTimeout:
             pytest.xfail("xmatch query timed out.")
         assert len(table) == 185
+
+    def test_xmatch_invalid_query(self, xmatch):
+        input_table = Table.read(DATA_DIR / "posList.csv", format="ascii.csv")
+        # columns in input table and kwargs are not matching
+
+        with pytest.raises(InvalidQueryError) as err:
+            xmatch.query(input_table, cat2='vizier:II/246/out', max_distance=5 * arcsec,
+                colRA1='ra', colDec1='DEC')
+
+            assert 'Column name "DEC" not found in table metadata' in str(err)