Merge pull request #2655 from nkphysics/nist-kwarg-refactor

Refactor: Make NIST keyword only

Author: bsipocz

CHANGES.rst

@@ -145,6 +145,11 @@ mast
 - Expanding ``Cutouts`` functionality to support making Hubble Advanced Product (HAP)
   cutouts via HAPCut. [#2613]
 
+nist
+^^^^
+
+- Optional parameters in all methods are kwargs keyword only. [#2655]
+
 oac
 ^^^
 

astroquery/nist/core.py

@@ -125,7 +125,7 @@ def _args_to_payload(self, *args, **kwargs):
         return request_payload
 
     @prepend_docstr_nosections("\n" + _args_to_payload.__doc__)
-    def query_async(self, minwav, maxwav, linename="H I",
+    def query_async(self, minwav, maxwav, *, linename="H I",
                     energy_level_unit='eV', output_order='wavelength',
                     wavelength_type='vacuum', get_query_payload=False):
         """
@@ -145,7 +145,7 @@ def query_async(self, minwav, maxwav, linename="H I",
                                  timeout=Nist.TIMEOUT)
         return response
 
-    def _parse_result(self, response, verbose=False):
+    def _parse_result(self, response, *, verbose=False):
         """
         Parses the results from the HTTP response to `astropy.table.Table`.
 

astroquery/nist/tests/test_nist.py

@@ -42,13 +42,13 @@ def test_parse_wavelength():
 
 def test_query_async(patch_get):
     response = nist.core.Nist.query_async(4000 * u.nm, 7000 * u.nm,
-                                          "H I", get_query_payload=True)
+                                          linename="H I", get_query_payload=True)
     assert response['spectra'] == "H I"
     assert response['unit'] == nist.core.Nist.unit_code['nm']
-    response = nist.core.Nist.query_async(4000 * u.nm, 7000 * u.nm, "H I")
+    response = nist.core.Nist.query_async(4000 * u.nm, 7000 * u.nm, linename="H I")
     assert response is not None
 
 
 def test_query(patch_get):
-    result = nist.core.Nist.query(4000 * u.nm, 7000 * u.nm, "H I")
+    result = nist.core.Nist.query(4000 * u.nm, 7000 * u.nm, linename="H I")
     assert isinstance(result, Table)

astroquery/nist/tests/test_nist_remote.py

@@ -24,7 +24,7 @@ def test_query(self):
         assert set(result['TP']) == set(['T8637', 'T7771'])
 
     def test_unescape_html(self):
-        response = nist.core.Nist.query_async(4333 * u.AA, 4334 * u.AA, "V I")
+        response = nist.core.Nist.query_async(4333 * u.AA, 4334 * u.AA, linename="V I")
         assert '†' in response.text
         # check that Unicode characters have been properly unescaped from their
         # raw HTML code equivalents during parsing

docs/nist/nist.rst

@@ -69,7 +69,7 @@ or 'vac+air'. Here is an example with all these parameters.
 .. doctest-remote-data::
 
     >>> from astroquery.nist import Nist
-    >>> table = Nist.query(4000 * u.nm, 7000 * u.nm, 'H I',
+    >>> table = Nist.query(4000 * u.nm, 7000 * u.nm, linename='H I',
     ...                    energy_level_unit='eV', output_order='wavelength',
     ...                    wavelength_type='vacuum')
     >>> print(table)