Merge pull request #2609 from keflavich/simbad_kwargonly

Refactor: SIMBAD keyword-only

Author: bsipocz

CHANGES.rst

@@ -135,6 +135,7 @@ simbad
 - It is now possible to specify multiple coordinates together with a single
   radius as a string in ``query_region()`` and ``query_region_async()``.
   [#2494]
+- Optional keyword arguments are now keyword only. [#2609]
 
 skyview
 ^^^^^^^

astroquery/simbad/core.py

@@ -500,7 +500,7 @@ def query_criteria_async(self, *args, **kwargs):
                                  timeout=self.TIMEOUT, cache=cache)
         return response
 
-    def query_object(self, object_name, wildcard=False, verbose=False,
+    def query_object(self, object_name, *, wildcard=False, verbose=False,
                      get_query_payload=False):
         """
         Queries Simbad for the given object and returns the result as a
@@ -531,7 +531,7 @@ def query_object(self, object_name, wildcard=False, verbose=False,
         return self._parse_result(response, SimbadVOTableResult,
                                   verbose=verbose)
 
-    def query_object_async(self, object_name, wildcard=False, cache=True,
+    def query_object_async(self, object_name, *, wildcard=False, cache=True,
                            get_query_payload=False):
 
         """
@@ -564,7 +564,7 @@ def query_object_async(self, object_name, wildcard=False, cache=True,
                                  timeout=self.TIMEOUT, cache=cache)
         return response
 
-    def query_objects(self, object_names, wildcard=False, verbose=False,
+    def query_objects(self, object_names, *, wildcard=False, verbose=False,
                       get_query_payload=False):
         """
         Queries Simbad for the specified list of objects and returns the
@@ -590,7 +590,7 @@ def query_objects(self, object_names, wildcard=False, verbose=False,
         return self.query_object('\n'.join(object_names), wildcard=wildcard,
                                  get_query_payload=get_query_payload)
 
-    def query_objects_async(self, object_names, wildcard=False, cache=True,
+    def query_objects_async(self, object_names, *, wildcard=False, cache=True,
                             get_query_payload=False):
         """
         Same as `query_objects`, but only collects the response from the
@@ -616,7 +616,7 @@ def query_objects_async(self, object_names, wildcard=False, cache=True,
                                        wildcard=wildcard, cache=cache,
                                        get_query_payload=get_query_payload)
 
-    def query_region_async(self, coordinates, radius=2*u.arcmin,
+    def query_region_async(self, coordinates, radius=2*u.arcmin, *,
                            equinox=2000.0, epoch='J2000', cache=True,
                            get_query_payload=False):
         """
@@ -627,9 +627,8 @@ def query_region_async(self, coordinates, radius=2*u.arcmin,
         ----------
         coordinates : str or `astropy.coordinates` object
             the identifier or coordinates around which to query.
-        radius : str or `~astropy.units.Quantity`, optional
-            the radius of the region. If missing, set to default
-            value of 2 arcmin.
+        radius : str or `~astropy.units.Quantity`
+            the radius of the region.  Defaults to 2 arcmin.
         equinox : float, optional
             the equinox of the coordinates. If missing set to
             default 2000.0.
@@ -646,14 +645,15 @@ def query_region_async(self, coordinates, radius=2*u.arcmin,
              Response of the query from the server.
         """
 
+        if radius is None:
+            # this message is specifically for deprecated use of 'None' to mean 'Default'
+            raise ValueError("Radius must be specified as an angle-equivalent quantity, not None")
+
         equinox = validate_equinox(equinox)
         epoch = validate_epoch(epoch)
 
         base_query_str = "query coo {ra} {dec} radius={rad} frame={frame} equi={equinox}"
 
-        if radius is None:
-            radius = 2*u.arcmin
-
         header = self._get_query_header()
         footer = self._get_query_footer()
 
@@ -698,7 +698,7 @@ def query_region_async(self, coordinates, radius=2*u.arcmin,
                                  timeout=self.TIMEOUT, cache=cache)
         return response
 
-    def query_catalog(self, catalog, verbose=False, cache=True,
+    def query_catalog(self, catalog, *, verbose=False, cache=True,
                       get_query_payload=False):
         """
         Queries a whole catalog.
@@ -727,7 +727,7 @@ def query_catalog(self, catalog, verbose=False, cache=True,
         return self._parse_result(response, SimbadVOTableResult,
                                   verbose=verbose)
 
-    def query_catalog_async(self, catalog, cache=True, get_query_payload=False):
+    def query_catalog_async(self, catalog, *, cache=True, get_query_payload=False):
         """
         Serves the same function as `query_catalog`, but
         only collects the response from the Simbad server and returns.
@@ -755,7 +755,7 @@ def query_catalog_async(self, catalog, cache=True, get_query_payload=False):
                                  timeout=self.TIMEOUT, cache=cache)
         return response
 
-    def query_bibobj(self, bibcode, verbose=False, get_query_payload=False):
+    def query_bibobj(self, bibcode, *, verbose=False, get_query_payload=False):
         """
         Query all the objects that are contained in the article specified by
         the bibcode, and return results as a `~astropy.table.Table`.
@@ -781,7 +781,7 @@ def query_bibobj(self, bibcode, verbose=False, get_query_payload=False):
         return self._parse_result(response, SimbadVOTableResult,
                                   verbose=verbose)
 
-    def query_bibobj_async(self, bibcode, cache=True, get_query_payload=False):
+    def query_bibobj_async(self, bibcode, *, cache=True, get_query_payload=False):
         """
         Serves the same function as `query_bibobj`, but only collects the
         response from the Simbad server and returns.
@@ -809,7 +809,7 @@ def query_bibobj_async(self, bibcode, cache=True, get_query_payload=False):
                                  timeout=self.TIMEOUT, cache=cache)
         return response
 
-    def query_bibcode(self, bibcode, wildcard=False, verbose=False,
+    def query_bibcode(self, bibcode, *, wildcard=False, verbose=False,
                       cache=True, get_query_payload=False):
         """
         Queries the references corresponding to a given bibcode, and returns
@@ -843,7 +843,7 @@ def query_bibcode(self, bibcode, wildcard=False, verbose=False,
         return self._parse_result(response, SimbadBibcodeResult,
                                   verbose=verbose)
 
-    def query_bibcode_async(self, bibcode, wildcard=False, cache=True,
+    def query_bibcode_async(self, bibcode, *, wildcard=False, cache=True,
                             get_query_payload=False):
         """
         Serves the same function as `query_bibcode`, but
@@ -878,7 +878,7 @@ def query_bibcode_async(self, bibcode, wildcard=False, cache=True,
 
         return response
 
-    def query_objectids(self, object_name, verbose=False, cache=True,
+    def query_objectids(self, object_name, *, verbose=False, cache=True,
                         get_query_payload=False):
         """
         Query Simbad with an object name, and return a table of all
@@ -906,7 +906,7 @@ def query_objectids(self, object_name, verbose=False, cache=True,
         return self._parse_result(response, SimbadObjectIDsResult,
                                   verbose=verbose)
 
-    def query_objectids_async(self, object_name, cache=True,
+    def query_objectids_async(self, object_name, *, cache=True,
                               get_query_payload=False):
         """
         Serves the same function as `query_objectids`, but

astroquery/simbad/tests/test_simbad.py

@@ -234,10 +234,10 @@ def test_query_catalog(patch_post):
 
 
 @pytest.mark.parametrize(('coordinates', 'radius', 'equinox', 'epoch'),
-                         [(ICRS_COORDS, None, 2000.0, 'J2000'),
+                         [(ICRS_COORDS, 2*u.arcmin, 2000.0, 'J2000'),
                           (GALACTIC_COORDS, 5 * u.deg, 2000.0, 'J2000'),
                           (FK4_COORDS, '5d0m0s', 2000.0, 'J2000'),
-                          (FK5_COORDS, None, 2000.0, 'J2000'),
+                          (FK5_COORDS, 2*u.arcmin, 2000.0, 'J2000'),
                           (multicoords, 0.5*u.arcsec, 2000.0, 'J2000'),
                           (multicoords, "0.5s", 2000.0, 'J2000'),
                           ])
@@ -253,10 +253,10 @@ def test_query_region_async(patch_post, coordinates, radius, equinox, epoch):
 
 
 @pytest.mark.parametrize(('coordinates', 'radius', 'equinox', 'epoch'),
-                         [(ICRS_COORDS, None, 2000.0, 'J2000'),
+                         [(ICRS_COORDS, 2*u.arcmin, 2000.0, 'J2000'),
                           (GALACTIC_COORDS, 5 * u.deg, 2000.0, 'J2000'),
                           (FK4_COORDS, '5d0m0s', 2000.0, 'J2000'),
-                          (FK5_COORDS, None, 2000.0, 'J2000')
+                          (FK5_COORDS, 2*u.arcmin, 2000.0, 'J2000')
                           ])
 def test_query_region(patch_post, coordinates, radius, equinox, epoch):
     result1 = simbad.core.Simbad.query_region(coordinates, radius=radius,