Merge pull request #2661 from nkphysics/kwargs-keyword-only

Refactor: Make kwargs keyword only

Author: bsipocz

CHANGES.rst

@@ -21,7 +21,6 @@ esa.hubble
 
 - Update to TAP url to query data and download files, aligned with the new eHST Science Archive. [#2567][#2597]
 - Status and maintenance messages from eHST TAP when the module is instantiated. get_status_messages method to retrieve them. [#2597]
-- Optional parameters in all methods are kwargs keyword only. [#2597]
 
 solarsystem.neodys
 ^^^^^^^^^^^^^^^^^^
@@ -114,8 +113,6 @@ jplhorizons
 - Adding ``optional_setting`` kwarg to the ephemerides methods to allow
   passing additional settings. [#1802]
 
-- Optional keyword arguments are now keyword only. [#1802]
-
 - Topocentric coordinates can now be specified for both center and target in observer
   and vector queries. [#2625]
 
@@ -145,16 +142,6 @@ 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]
-
-nvas
-^^^^
-
-- Made NVAS optional kwargs keyword only. [#2656]
-
 oac
 ^^^
 
@@ -173,7 +160,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]
+
 - ``ROW_LIMIT`` is now respected when running region queries; previously, it
   was ignored for region queries but respected for all others.  A new warning,
   ``BlankResponseWarning``, is introduced for use when one or more query terms result
@@ -185,8 +172,6 @@ skyview
 
 - Fix bug for ``radius`` parameter to not behave as diameter. [#2601]
 
-- Optional keyword arguments are now keyword only. [#2601]
-
 svo_fps
 ^^^^^^^
 
@@ -222,9 +207,6 @@ sdss
 
 - The default data release has been changed to DR17. [#2478]
 
-- Optional keyword arguments are now keyword only. [#2477, #2532]
-
-
 mast
 ^^^^
 
@@ -241,6 +223,9 @@ xmatch
 Infrastructure, Utility and Other Changes and Additions
 -------------------------------------------------------
 
+- Optional keyword arguments are now keyword only. [#1802, #2477, #2532,
+  #2597, #2601, #2609, #2655, #2656, #2661]
+
 - New function, ``utils.cleanup_downloads.cleanup_saved_downloads``, is
   added to help the testcleanup narrative in narrative documentations. [#2384]
 

astroquery/alfalfa/core.py

@@ -88,7 +88,7 @@ def get_catalog(self):
 
         return catalog
 
-    def query_region(self, coordinates, radius=3. * u.arcmin,
+    def query_region(self, coordinates, *, radius=3. * u.arcmin,
                      optical_counterpart=False):
         """
         Perform object cross-ID in ALFALFA.

astroquery/astrometry_net/core.py

@@ -198,7 +198,7 @@ def _validate_settings(self, settings):
                 raise ValueError('Scale type {} requires '
                                  'values for {}'.format(scale_type, required_keys))
 
-    def monitor_submission(self, submission_id,
+    def monitor_submission(self, submission_id, *,
                            solve_timeout=TIMEOUT, verbose=True):
         """
         Monitor the submission for completion.
@@ -270,7 +270,7 @@ def monitor_submission(self, submission_id,
             raise RuntimeError('Unrecognized status {}'.format(status))
         return wcs
 
-    def solve_from_source_list(self, x, y, image_width, image_height,
+    def solve_from_source_list(self, x, y, image_width, image_height, *,
                                solve_timeout=TIMEOUT,
                                verbose=True,
                                **settings
@@ -320,7 +320,7 @@ def solve_from_source_list(self, x, y, image_width, image_height,
                                        solve_timeout=solve_timeout,
                                        verbose=verbose)
 
-    def solve_from_image(self, image_file_path, force_image_upload=False,
+    def solve_from_image(self, image_file_path, *, force_image_upload=False,
                          ra_key=None, dec_key=None,
                          ra_dec_units=None,
                          fwhm=3, detect_threshold=5,

astroquery/besancon/core.py

@@ -86,11 +86,11 @@ class BesanconClass(BaseQuery):
     # sample file name:  1340900648.230224.resu
     result_re = re.compile(r"[0-9]{10}\.[0-9]{6}\.resu")
 
-    def __init__(self, email=None):
+    def __init__(self, *, email=None):
         super().__init__()
         self.email = email
 
-    def get_besancon_model_file(self, filename, verbose=True, timeout=5.0):
+    def get_besancon_model_file(self, filename, *, verbose=True, timeout=5.0):
         """
         Download a Besancon model from the website.
 
@@ -145,7 +145,7 @@ def get_besancon_model_file(self, filename, verbose=True, timeout=5.0):
 
         return parse_besancon_model_string(results)
 
-    def _parse_result(self, response, verbose=False, retrieve_file=True):
+    def _parse_result(self, response, *, verbose=False, retrieve_file=True):
         """
         retrieve_file : bool
             If True, will try to retrieve the file every 30s until it shows up.
@@ -174,7 +174,7 @@ def _parse_result(self, response, verbose=False, retrieve_file=True):
         else:
             return filename
 
-    def _parse_args(self, glon, glat, email, smallfield=True, extinction=0.7,
+    def _parse_args(self, glon, glat, email, *, smallfield=True, extinction=0.7,
                     area=0.0001, verbose=True, clouds=None,
                     absmag_limits=(-7, 20), mag_limits=copy.copy(mag_limits),
                     colors_limits=copy.copy(colors_limits),

astroquery/casda/core.py

@@ -95,7 +95,7 @@ def _login(self, *, username=None, store_password=False,
 
         return authenticated
 
-    def query_region_async(self, coordinates, radius=1*u.arcmin, height=None, width=None,
+    def query_region_async(self, coordinates, *, radius=1*u.arcmin, height=None, width=None,
                            get_query_payload=False, cache=True):
         """
         Queries a region around the specified coordinates. Either a radius or both a height and a width
@@ -135,7 +135,7 @@ def query_region_async(self, coordinates, radius=1*u.arcmin, height=None, width=
 
     # Create the dict of HTTP request parameters by parsing the user
     # entered values.
-    def _args_to_payload(self, radius=1*u.arcmin, **kwargs):
+    def _args_to_payload(self, *, radius=1*u.arcmin, **kwargs):
         request_payload = dict()
 
         # Convert the coordinates to FK5
@@ -206,7 +206,7 @@ def _args_to_payload(self, radius=1*u.arcmin, **kwargs):
     # the methods above implicitly call the private _parse_result method.
     # This should parse the raw HTTP response and return it as
     # an `astropy.table.Table`.
-    def _parse_result(self, response, verbose=False):
+    def _parse_result(self, response, *, verbose=False):
         # if verbose is False then suppress any VOTable related warnings
         if not verbose:
             commons.suppress_vo_warnings()
@@ -284,7 +284,7 @@ def _complete_job(self, job_url, verbose):
 
         return fileurls
 
-    def stage_data(self, table, verbose=False):
+    def stage_data(self, table, *, verbose=False):
         """
         Request access to a set of data files. All requests for data must use authentication. If you have access to the
         data, the requested files will be brought online and a set of URLs to download the files will be returned.
@@ -367,7 +367,7 @@ def cutout(self, table, *, coordinates=None, radius=1*u.arcmin, height=None,
 
         return self._complete_job(job_url, verbose)
 
-    def download_files(self, urls, savedir=''):
+    def download_files(self, urls, *, savedir=''):
         """
         Download a series of files
 
@@ -445,7 +445,7 @@ def _parse_datalink_for_service_and_id(self, response, service_name):
 
         return async_url, authenticated_id_token
 
-    def _create_soda_job(self, authenticated_id_tokens, soda_url=None):
+    def _create_soda_job(self, authenticated_id_tokens, *, soda_url=None):
         """
         Creates the async job, returning the url to query the job status and details
 
@@ -488,7 +488,7 @@ def _add_cutout_params(self, job_location, verbose, cutout_spec):
         resp = self._request('POST', job_location + '/parameters', data=cutout_spec, cache=False)
         resp.raise_for_status()
 
-    def _run_job(self, job_location, verbose, poll_interval=20):
+    def _run_job(self, job_location, verbose, *, poll_interval=20):
         """
         Start an async job (e.g. TAP or SODA) and wait for it to be completed.
 

astroquery/cds/core.py

@@ -56,7 +56,7 @@ def __init__(self):
         self.path_moc_file = None
         self.return_moc = False
 
-    def query_region(self, region=None, get_query_payload=False, verbose=False, **kwargs):
+    def query_region(self, *, region=None, get_query_payload=False, verbose=False, **kwargs):
         """
         Query the `CDS MOCServer <http://alasky.unistra.fr/MocServer/query>`_ with a region.
 
@@ -123,11 +123,11 @@ def query_region(self, region=None, get_query_payload=False, verbose=False, **kw
         if get_query_payload:
             return response
 
-        result = self._parse_result(response, verbose)
+        result = self._parse_result(response, verbose=verbose)
 
         return result
 
-    def find_datasets(self, meta_data, get_query_payload=False, verbose=False, **kwargs):
+    def find_datasets(self, meta_data, *, get_query_payload=False, verbose=False, **kwargs):
         """
         Query the `CDS MOCServer <http://alasky.unistra.fr/MocServer/query>`_ to retrieve the data-sets based on their
         meta data values. This method does not need any region argument but it requires an expression on the meta datas.
@@ -179,11 +179,11 @@ def find_datasets(self, meta_data, get_query_payload=False, verbose=False, **kwa
         if get_query_payload:
             return response
 
-        result = self._parse_result(response, verbose)
+        result = self._parse_result(response, verbose=verbose)
 
         return result
 
-    def query_region_async(self, get_query_payload=False, **kwargs):
+    def query_region_async(self, *, get_query_payload=False, **kwargs):
         """
         Serves the same purpose as :meth:`~astroquery.cds.CdsClass.query_region` but only returns the HTTP response
         rather than the parsed result.
@@ -309,7 +309,7 @@ def _args_to_payload(self, **kwargs):
 
         return request_payload
 
-    def _parse_result(self, response, verbose=False):
+    def _parse_result(self, response, *, verbose=False):
         """
         Parsing of the response returned by the MOCServer.
 

astroquery/dace/core.py

@@ -42,7 +42,7 @@ def query_radial_velocities_async(self, object_name):
         return self._request("GET", ''.join([self.__DACE_URL, self.__RADIAL_VELOCITIES_ENDPOINT, object_name]),
                              timeout=self.__DACE_TIMEOUT, headers=self.__HEADERS)
 
-    def _parse_result(self, response, verbose=False):
+    def _parse_result(self, response, *, verbose=False):
         try:
             json_data = response.json()
             dace_dict = self.transform_data_as_dict(json_data)

astroquery/eso/core.py

@@ -48,7 +48,7 @@ def __init__(self):
         self._survey_list = None
         self.username = None
 
-    def _activate_form(self, response, form_index=0, form_id=None, inputs={},
+    def _activate_form(self, response, *, form_index=0, form_id=None, inputs={},
                        cache=True, method=None):
         """
         Parameters
@@ -191,7 +191,7 @@ def _activate_form(self, response, form_index=0, form_id=None, inputs={},
 
         return response
 
-    def _login(self, username=None, store_password=False,
+    def _login(self, *, username=None, store_password=False,
                reenter_password=False):
         """
         Login to the ESO User Portal.
@@ -257,7 +257,7 @@ def _login(self, username=None, store_password=False,
             keyring.set_password("astroquery:www.eso.org", username, password)
         return authenticated
 
-    def list_instruments(self, cache=True):
+    def list_instruments(self, *, cache=True):
         """ List all the available instrument-specific queries offered by the ESO archive.
 
         Returns
@@ -280,7 +280,7 @@ def list_instruments(self, cache=True):
                         self._instrument_list.append(instrument)
         return self._instrument_list
 
-    def list_surveys(self, cache=True):
+    def list_surveys(self, *, cache=True):
         """ List all the available surveys (phase 3) in the ESO archive.
 
         Returns
@@ -311,7 +311,7 @@ def list_surveys(self, cache=True):
                         self._survey_list.append(survey)
         return self._survey_list
 
-    def query_surveys(self, surveys='', cache=True,
+    def query_surveys(self, *, surveys='', cache=True,
                       help=False, open_form=False, **kwargs):
         """
         Query survey Phase 3 data contained in the ESO archive.
@@ -369,7 +369,7 @@ def query_surveys(self, surveys='', cache=True,
             else:
                 warnings.warn("Query returned no results", NoResultsWarning)
 
-    def query_main(self, column_filters={}, columns=[],
+    def query_main(self, *, column_filters={}, columns=[],
                    open_form=False, help=False, cache=True, **kwargs):
         """
         Query raw data contained in the ESO archive.
@@ -403,7 +403,7 @@ def query_main(self, column_filters={}, columns=[],
         return self._query(url, column_filters=column_filters, columns=columns,
                            open_form=open_form, help=help, cache=cache, **kwargs)
 
-    def query_instrument(self, instrument, column_filters={}, columns=[],
+    def query_instrument(self, instrument, *, column_filters={}, columns=[],
                          open_form=False, help=False, cache=True, **kwargs):
         """
         Query instrument-specific raw data contained in the ESO archive.
@@ -441,7 +441,7 @@ def query_instrument(self, instrument, column_filters={}, columns=[],
         return self._query(url, column_filters=column_filters, columns=columns,
                            open_form=open_form, help=help, cache=cache, **kwargs)
 
-    def _query(self, url, column_filters={}, columns=[],
+    def _query(self, url, *, column_filters={}, columns=[],
                open_form=False, help=False, cache=True, **kwargs):
 
         table = None
@@ -486,7 +486,7 @@ def _query(self, url, column_filters={}, columns=[],
             else:
                 warnings.warn("Query returned no results", NoResultsWarning)
 
-    def get_headers(self, product_ids, cache=True):
+    def get_headers(self, product_ids, *, cache=True):
         """
         Get the headers associated to a list of data product IDs
 
@@ -557,7 +557,7 @@ def get_headers(self, product_ids, cache=True):
         # Return as Table
         return Table(result)
 
-    def _check_existing_files(self, datasets, continuation=False,
+    def _check_existing_files(self, datasets, *, continuation=False,
                               destination=None):
         """Detect already downloaded datasets."""
 
@@ -628,7 +628,7 @@ def _download_file(self, url, local_filepath, **kwargs):
 
         return resp
 
-    def retrieve_data(self, datasets, continuation=False, destination=None,
+    def retrieve_data(self, datasets, *, continuation=False, destination=None,
                       with_calib='none', request_all_objects=False,
                       unzip=True, request_id=None):
         """
@@ -891,7 +891,7 @@ def verify_data_exists(self, dataset):
 
         return 'No data returned' not in content
 
-    def query_apex_quicklooks(self, project_id=None, help=False,
+    def query_apex_quicklooks(self, *, project_id=None, help=False,
                               open_form=False, cache=True, **kwargs):
         """
         APEX data are distributed with quicklook products identified with a
@@ -900,7 +900,7 @@ def query_apex_quicklooks(self, project_id=None, help=False,
 
         Examples
         --------
-        >>> tbl = Eso.query_apex_quicklooks('093.C-0144')
+        >>> tbl = Eso.query_apex_quicklooks(project_id='093.C-0144')
         >>> files = Eso.retrieve_data(tbl['Product ID'])
         """
 
@@ -944,7 +944,7 @@ def query_apex_quicklooks(self, project_id=None, help=False,
 
             return table
 
-    def _print_query_help(self, url, cache=True):
+    def _print_query_help(self, url, *, cache=True):
         """
         Download a form and print it in a quasi-human-readable way
         """
@@ -1006,7 +1006,7 @@ def _print_query_help(self, url, cache=True):
         log.info("\n".join(result_string))
         return result_string
 
-    def _print_surveys_help(self, url, cache=True):
+    def _print_surveys_help(self, url, *, cache=True):
         """
         Download a form and print it in a quasi-human-readable way
         """