Merge pull request #2563 from eerovaher/vizier-region-units

Test and refactor how `vizier` handles `query_region()` inputs with different units

Author: bsipocz

astroquery/vizier/core.py

@@ -426,39 +426,18 @@ def query_region_async(self, coordinates, radius=None, inner_radius=None,
             raise TypeError("Coordinates must be one of: string, astropy "
                             "coordinates, or table containing coordinates!")
 
-        # decide whether box or radius
         if radius is not None:
-            # is radius a disk or an annulus?
             if inner_radius is None:
-                radius = coord.Angle(radius)
-                unit, value = _parse_angle(radius)
-                key = "-c.r" + unit
-                center[key] = value
+                _, unit_str, o_radius = _parse_angle(radius)
+                center["-c.r" + unit_str] = str(o_radius)
             else:
-                i_radius = coord.Angle(inner_radius)
-                o_radius = coord.Angle(radius)
-                if i_radius.unit != o_radius.unit:
-                    o_radius = o_radius.to(i_radius.unit)
-                i_unit, i_value = _parse_angle(i_radius)
-                o_unit, o_value = _parse_angle(o_radius)
-                key = "-c.r" + i_unit
-                center[key] = ",".join([str(i_value), str(o_value)])
+                unit, unit_str, i_radius = _parse_angle(inner_radius)
+                o_radius = coord.Angle(radius).to_value(unit)
+                center["-c.r" + unit_str] = f"{i_radius},{o_radius}"
         elif width is not None:
-            # is box a rectangle or square?
-            if height is None:
-                width = coord.Angle(width)
-                unit, value = _parse_angle(width)
-                key = "-c.b" + unit
-                center[key] = "x".join([str(value)] * 2)
-            else:
-                w_box = coord.Angle(width)
-                h_box = coord.Angle(height)
-                if w_box.unit != h_box.unit:
-                    h_box = h_box.to(w_box.unit)
-                w_unit, w_value = _parse_angle(w_box)
-                h_unit, h_value = _parse_angle(h_box)
-                key = "-c.b" + w_unit
-                center[key] = "x".join([str(w_value), str(h_value)])
+            unit, unit_str, w_box = _parse_angle(width)
+            h_box = w_box if height is None else coord.Angle(height).to_value(unit)
+            center["-c.b" + unit_str] = f"{w_box}x{h_box}"
         else:
             raise Exception(
                 "At least one of radius, width/height must be specified")
@@ -806,17 +785,15 @@ def _parse_angle(angle):
 
     Returns
     -------
-    (unit, value) : tuple
-        formatted for Vizier.
+    (unit, unit_str, value) : tuple
     """
     angle = coord.Angle(angle)
-    if angle.unit == u.arcsec:
-        unit, value = 's', angle.value
-    elif angle.unit == u.arcmin:
-        unit, value = 'm', angle.value
+    if angle.unit is u.arcsec:
+        return u.arcsec, "s", angle.value
+    elif angle.unit is u.arcmin:
+        return u.arcmin, "m", angle.value
     else:
-        unit, value = 'd', angle.to(u.deg).value
-    return unit, value
+        return u.deg, "d", angle.to_value(u.deg)
 
 
 class VizierKeyword(list):

astroquery/vizier/tests/test_vizier.py

@@ -72,18 +72,16 @@ def patch_coords(request):
     return mp
 
 
-@pytest.mark.parametrize(('dim', 'expected_out'),
-                         [(5 * u.deg, ('d', 5)),
-                          (5 * u.arcmin, ('m', 5)),
-                          (5 * u.arcsec, ('s', 5)),
-                          (0.314 * u.rad, ('d', 18)),
-                          ('5d5m5.5s', ('d', 5.0846))
-                          ])
-def test_parse_angle(dim, expected_out):
-    actual_out = vizier.core._parse_angle(dim)
-    actual_unit, actual_value = actual_out
-    expected_unit, expected_value = expected_out
+@pytest.mark.parametrize("dim,expected_unit,expected_unit_str,expected_value",
+                         [(5 * u.deg, u.deg, "d", 5),
+                          (5 * u.arcmin, u.arcmin, "m", 5),
+                          (5 * u.arcsec, u.arcsec, "s", 5),
+                          (0.314 * u.rad, u.deg, "d", 18),
+                          ("5d5m5.5s", u.deg, "d", 5.0846)])
+def test_parse_angle(dim, expected_unit, expected_unit_str, expected_value):
+    actual_unit, actual_unit_str, actual_value = vizier.core._parse_angle(dim)
     assert actual_unit == expected_unit
+    assert actual_unit_str == expected_unit_str
     npt.assert_approx_equal(actual_value, expected_value, significant=2)
 
 
@@ -125,6 +123,26 @@ def test_query_region_async(patch_post):
     assert response is not None
 
 
+@pytest.mark.parametrize(
+    "inner_r,region_str",
+    [(1 * u.deg, "-c.rd=1.0,5.0"), (60 * u.arcmin, "-c.rm=60.0,300.0")])
+@pytest.mark.parametrize("outer_r", (5 * u.deg, 300 * u.arcmin))
+def test_query_region_async_with_inner_radius(inner_r, outer_r, region_str):
+    query = vizier.VizierClass().query_region_async(
+        scalar_skycoord, radius=outer_r, inner_radius=inner_r, get_query_payload=True)
+    assert region_str in query.splitlines()
+
+
+@pytest.mark.parametrize(
+    "width,region_str",
+    [(1 * u.deg, "-c.bd=1.0x5.0"), (60 * u.arcmin, "-c.bm=60.0x300.0")])
+@pytest.mark.parametrize("height", (5 * u.deg, 300 * u.arcmin))
+def test_query_region_async_rectangle(width, height, region_str):
+    query = vizier.VizierClass().query_region_async(
+        scalar_skycoord, width=width, height=height, get_query_payload=True)
+    assert region_str in query.splitlines()
+
+
 def test_query_region(patch_post):
     result = vizier.core.Vizier.query_region(
         scalar_skycoord, radius=5 * u.deg, catalog=["HIP", "NOMAD", "UCAC"])