changed return_job_id to return_submission_id, added return_submission_id keyword to https://github.com/astropy/astroquery/pull/2685/files#diff-1b4e2fa6e8440300c09f3bd20ad98ddf812800e805a8b5bb3c480d64b6154f92R444-R450.

Author: prajwel

astroquery/astrometry_net/core.py

@@ -199,7 +199,7 @@ def _validate_settings(self, settings):
                                  'values for {}'.format(scale_type, required_keys))
 
     def monitor_submission(self, submission_id, *,
-                           solve_timeout=TIMEOUT, verbose=True, return_job_id=False):
+                           solve_timeout=TIMEOUT, verbose=True, return_submission_id=False):
         """
         Monitor the submission for completion.
 
@@ -213,8 +213,8 @@ def monitor_submission(self, submission_id, *,
             a solution.
         verbose : bool, optional
             Whether to print out information about the solving.
-        return_job_id : bool, optional
-            Whether to return the Submission ID number (called Job ID on Astrometry.net).
+        return_submission_id : bool, optional
+            Whether to return the Submission ID number.
 
         Returns
         -------
@@ -224,7 +224,7 @@ def monitor_submission(self, submission_id, *,
             succeeds or fails. If the solve succeeds the header with
             the WCS solution generated by astrometry.net is returned. A tuple
             containing WCS solution and Submission ID is return if the
-            return_job_id parameter is set True. If the solve
+            return_submission_id parameter is set True. If the solve
             fails then an empty dictionary is returned. See below for the outcome
             if the solve times out.
 
@@ -272,15 +272,15 @@ def monitor_submission(self, submission_id, *,
         else:
             # Try to future-proof a little bit
             raise RuntimeError('Unrecognized status {}'.format(status))
-        if return_job_id is False:
+        if return_submission_id is False:
             return wcs
         else:
             return (wcs, submission_id)
 
     def solve_from_source_list(self, x, y, image_width, image_height, *,
                                solve_timeout=TIMEOUT,
                                verbose=True,
-                               return_job_id=False,
+                               return_submission_id=False,
                                **settings
                                ):
         """
@@ -302,8 +302,8 @@ def solve_from_source_list(self, x, y, image_width, image_height, *,
             a solution.
         verbose : bool, optional
             Whether to print out information about the solving.
-        return_job_id : bool, optional
-            Whether to return the Submission ID number (called Job ID on Astrometry.net).
+        return_submission_id : bool, optional
+            Whether to return the Submission ID number.
 
         For a list of the remaining settings, use the method
         `~AstrometryNetClass.show_allowed_settings`.
@@ -329,15 +329,15 @@ def solve_from_source_list(self, x, y, image_width, image_height, *,
         return self.monitor_submission(submission_id,
                                        solve_timeout=solve_timeout,
                                        verbose=verbose,
-                                       return_job_id=return_job_id)
+                                       return_submission_id=return_submission_id)
 
     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,
                          solve_timeout=TIMEOUT,
                          verbose=True,
-                         return_job_id=False,
+                         return_submission_id=False,
                          **settings):
         """
         Plate solve from an image, either by uploading the image to
@@ -381,8 +381,8 @@ def solve_from_image(self, image_file_path, *, force_image_upload=False,
         verbose : bool, optional
             Whether to print out information about the solving.
 
-        return_job_id : bool, optional
-            Whether to return the Submission ID number (called Job ID on Astrometry.net).
+        return_submission_id : bool, optional
+            Whether to return the Submission ID number.
 
         For a list of the remaining settings, use the method
         `~AstrometryNetClass.show_allowed_settings`.
@@ -447,6 +447,7 @@ def solve_from_image(self, image_file_path, *, force_image_upload=False,
                                                ccd.header['naxis2'],
                                                solve_timeout=solve_timeout,
                                                verbose=verbose,
+                                               return_submission_id=return_submission_id,
                                                **settings)
         if response.status_code != 200:
             raise RuntimeError('Post of job failed')
@@ -455,7 +456,7 @@ def solve_from_image(self, image_file_path, *, force_image_upload=False,
         return self.monitor_submission(submission_id,
                                        solve_timeout=solve_timeout,
                                        verbose=verbose,
-                                       return_job_id=return_job_id)
+                                       return_submission_id=return_submission_id)
 
 
 # the default tool for users to interact with is an instance of the Class

astroquery/astrometry_net/tests/test_astrometry_net_remote.py

@@ -172,7 +172,7 @@ def test_solve_from_image_default_behaviour():
 
 @pytest.mark.skipif(not api_key, reason='API key not set.')
 @pytest.mark.remote_data
-def test_solve_from_image_with_return_job_id():
+def test_solve_from_image_with_return_submission_id():
     # Test that solving by uploading an image works
     a = AstrometryNet()
     a.api_key = api_key
@@ -182,6 +182,6 @@ def test_solve_from_image_with_return_job_id():
     result = a.solve_from_source_list(sources['X'], sources['Y'],
                                       4109, 4096,
                                       crpix_center=True,
-                                      return_job_id=True)
+                                      return_submission_id=True)
 
     assert isinstance(result, tuple)