return_job_id option added to astrometry_net monitor_submission.

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):
+                           solve_timeout=TIMEOUT, verbose=True, return_job_id=False):
         """
         Monitor the submission for completion.
 
@@ -212,15 +212,19 @@ def monitor_submission(self, submission_id, *,
             Time, in seconds, to wait for the astrometry.net solver to find
             a solution.
         verbose : bool, optional
-            Whether to print out information about the solving
+            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).            
 
         Returns
         -------
 
-        None or `astropy.io.fits.Header`
+        None or `astropy.io.fits.Header` or (`astropy.io.fits.Header`, str)
             The contents of the returned object depend on whether the solve
             succeeds or fails. If the solve succeeds the header with
-            the WCS solution generated by astrometry.net is returned. If the solve
+            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
             fails then an empty dictionary is returned. See below for the outcome
             if the solve times out.
 
@@ -268,11 +272,15 @@ def monitor_submission(self, submission_id, *,
         else:
             # Try to future-proof a little bit
             raise RuntimeError('Unrecognized status {}'.format(status))
-        return wcs
+        if return_job_id == 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,
                                **settings
                                ):
         """
@@ -293,7 +301,9 @@ def solve_from_source_list(self, x, y, image_width, image_height, *,
             Time, in seconds, to wait for the astrometry.net solver to find
             a solution.
         verbose : bool, optional
-            Whether to print out information about the solving
+            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).              
 
         For a list of the remaining settings, use the method
         `~AstrometryNetClass.show_allowed_settings`.
@@ -318,14 +328,16 @@ def solve_from_source_list(self, x, y, image_width, image_height, *,
         submission_id = response_d['subid']
         return self.monitor_submission(submission_id,
                                        solve_timeout=solve_timeout,
-                                       verbose=verbose)
+                                       verbose=verbose,
+                                       return_job_id=return_job_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,
                          **settings):
         """
         Plate solve from an image, either by uploading the image to
@@ -367,7 +379,10 @@ def solve_from_image(self, image_file_path, *, force_image_upload=False,
             a solution.
 
         verbose : bool, optional
-            Whether to print out information about the solving
+            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).              
 
         For a list of the remaining settings, use the method
         `~AstrometryNetClass.show_allowed_settings`.
@@ -439,7 +454,8 @@ def solve_from_image(self, image_file_path, *, force_image_upload=False,
         submission_id = response_d['subid']
         return self.monitor_submission(submission_id,
                                        solve_timeout=solve_timeout,
-                                       verbose=verbose)
+                                       verbose=verbose,
+                                       return_job_id=return_job_id)
 
 
 # the default tool for users to interact with is an instance of the Class