This new commit implements the comments done on the pull request #2077 and implements ticket GAIAPCR-1040:C9APP-149 Astropy error when working with tables downloaded in plain votable, fits, json, and ecsv formats

Author: mhsarmiento

CHANGES.rst

@@ -4,6 +4,10 @@
 New Tools and Services
 ----------------------
 
+gaia
+^^^^
+- New method, rename_table, which allows the user to rename table and column names
+
 
 Service fixes and enhancements
 ------------------------------
@@ -29,6 +33,9 @@ gaia
   ``astroquery.gaia.Gaia`` no longer ignore their ``columns`` argument when
   ``radius`` is specified. [#2249]
 
+- Enhanced methods 'launch_job' and 'launch_job_async' to avoid issues with the name provided by the user for the
+  output file when the results are returned by the TAP in compressed format.
+
 mast
 ^^^^
 
@@ -38,6 +45,7 @@ mast
 
 - Adding the All-Sky PLATO Input Catalog ('plato') as a catalog option for methods of ``astroquery.mast.Catalogs``. [#2279]
 
+
 Infrastructure, Utility and Other Changes and Additions
 -------------------------------------------------------
 
@@ -1133,4 +1141,4 @@ Infrastructure, Utility and Other Changes and Additions
 0.1 (2013-09-19)
 ================
 
-- Initial release.  Includes features!
+- Initial release.  Includes features!

astroquery/gaia/core.py

@@ -12,7 +12,6 @@
 
 Created on 30 jun. 2016
 Modified on 18 Ene. 2022 by mhsarmiento
-
 """
 from requests import HTTPError
 
@@ -33,6 +32,7 @@
 from astropy.table import Table
 from astropy import units as u
 import warnings
+from astroquery.exceptions import InputWarning
 
 
 class GaiaClass(TapPlus):
@@ -78,9 +78,9 @@ def login(self, user=None, password=None, credentials_file=None,
               verbose=False):
         """Performs a login.
         User and password arguments can be used or a file that contains
-        user name and password
-        (2 lines: one for user name and the following one for the password).
-        If no arguments are provided, a prompt asking for user name and
+        username and password
+        (2 lines: one for username and the following one for the password).
+        If no arguments are provided, a prompt asking for username and
         password will appear.
 
         Parameters
@@ -199,7 +199,7 @@ def load_data(self, ids, data_release=None, data_structure='INDIVIDUAL', retriev
             By default, this value will be set to False. If it is set to 'true'
             the Datalink items tags will not be checked.
         format : str, optional, default 'votable'
-            loading format. Other available formats are 'csv', 'ecsv', 'votable_plain' and 'fits'
+            loading format. Other available formats are 'csv', 'ecsv','json','votable_plain' and 'fits'
         output_file : string, optional, default None
             file where the results are saved.
             If it is not provided, the http response contents are returned.
@@ -371,12 +371,11 @@ def __query_object(self, coordinate, radius=None, width=None, height=None,
         ----------
         coordinate : astropy.coordinate, mandatory
             coordinates center point
-        radius : astropy.units, required if no 'width' nor 'height' are
-        provided
+        radius : astropy.units if no 'width' nor 'height' are provided
             radius (deg)
-        width : astropy.units, required if no 'radius' is provided
+        width : astropy.units if no 'radius' is provided
             box width
-        height : astropy.units, required if no 'radius' is provided
+        height : astropy.units if no 'radius' is provided
             box height
         async_job : bool, optional, default 'False'
             executes the query (job) in asynchronous/synchronous mode (default
@@ -451,11 +450,11 @@ def query_object(self, coordinate, radius=None, width=None, height=None,
         ----------
         coordinate : astropy.coordinates, mandatory
             coordinates center point
-        radius : astropy.units, required if no 'width'/'height' are provided
+        radius : astropy.units if no 'width'/'height' are provided
             radius (deg)
-        width : astropy.units, required if no 'radius' is provided
+        width : astropy.units if no 'radius' is provided
             box width
-        height : astropy.units, required if no 'radius' is provided
+        height : astropy.units if no 'radius' is provided
             box height
         verbose : bool, optional, default 'False'
             flag to display information about the process
@@ -477,11 +476,11 @@ def query_object_async(self, coordinate, radius=None, width=None,
         ----------
         coordinate : astropy.coordinates, mandatory
             coordinates center point
-        radius : astropy.units, required if no 'width'/'height' are provided
+        radius : astropy.units if no 'width'/'height' are provided
             radius
-        width : astropy.units, required if no 'radius' is provided
+        width : astropy.units if no 'radius' is provided
             box width
-        height : astropy.units, required if no 'radius' is provided
+        height : astropy.units if no 'radius' is provided
             box height
         verbose : bool, optional, default 'False'
             flag to display information about the process
@@ -511,8 +510,7 @@ def __cone_search(self, coordinate, radius, table_name=None,
             coordinates center point
         radius : astropy.units, mandatory
             radius
-        table_name : str, optional, default main gaia table
-            table name doing the cone search against
+        table_name : str, optional, default main gaia table name doing the cone search against
         ra_column_name : str, optional, default ra column in main gaia table
             ra column doing the cone search against
         dec_column_name : str, optional, default dec column in main gaia table
@@ -539,6 +537,7 @@ def __cone_search(self, coordinate, radius, table_name=None,
         -------
         A Job object
         """
+        radiusDeg = None
         coord = self.__getCoordInput(coordinate, "coordinate")
         raHours, dec = commons.coord_to_radec(coord)
         ra = raHours * 15.0  # Converts to degrees
@@ -605,8 +604,7 @@ def cone_search(self, coordinate, radius=None,
             coordinates center point
         radius : astropy.units, mandatory
             radius
-        table_name : str, optional, default main gaia table
-            table name doing the cone search against
+        table_name : str, optional, default main gaia table name doing the cone search against
         ra_column_name : str, optional, default ra column in main gaia table
             ra column doing the cone search against
         dec_column_name : str, optional, default dec column in main gaia table
@@ -655,8 +653,7 @@ def cone_search_async(self, coordinate, radius=None,
             coordinates center point
         radius : astropy.units, mandatory
             radius
-        table_name : str, optional, default main gaia table
-            table name doing the cone search against
+        table_name : str, optional, default main gaia table name doing the cone search against
         ra_column_name : str, optional, default ra column in main gaia table
             ra column doing the cone search against
         dec_column_name : str, optional, default dec column in main gaia table
@@ -759,7 +756,7 @@ def cross_match(self, full_qualified_table_name_a=None,
                     radius=1.0,
                     background=False,
                     verbose=False):
-        """Performs a cross match between the specified tables
+        """Performs a cross-match between the specified tables
         The result is a join table (stored in the user storage area)
         with the identifies of both tables and the distance.
         TAP+ only
@@ -861,9 +858,9 @@ def launch_job(self, query, name=None, output_file=None,
             if output_format in format_with_results_compressed:
                 # In this case we will have to take also into account the .fits format
                 if not output_file.endswith(compressed_extension):
-                    warnings.warn('WARNING!!! By default, results in "votable" and "fits" format are returned in '
+                    warnings.warn('By default, results in "votable" and "fits" format are returned in '
                                   f'compressed format therefore your file {output_file} '
-                                  f'will be renamed to {output_file}.gz')
+                                  f'will be renamed to {output_file}.gz', InputWarning)
                     if output_format == 'votable':
                         if output_file.endswith('.vot'):
                             output_file_with_extension = output_file + '.gz'
@@ -925,7 +922,7 @@ def launch_job_async(self, query, name=None, output_file=None,
         A Job object
         """
         compressed_extension = ".gz"
-        format_with_results_compressed = ['votable', 'fits']
+        format_with_results_compressed = ['votable', 'fits', 'ecsv']
         output_file_with_extension = output_file
 
         if output_file is not None:
@@ -945,6 +942,16 @@ def launch_job_async(self, query, name=None, output_file=None,
                             output_file_with_extension = output_file + '.gz'
                         else:
                             output_file_with_extension = output_file + '.fits.gz'
+                    elif output_format == 'ecsv':
+                        if output_file.endswith('.ecsv'):
+                            output_file_with_extension = output_file + '.gz'
+                        else:
+                            output_file_with_extension = output_file + '.ecsv.gz'
+            # the output type is not compressed by default by the TAP SERVER but the users gives a .gz extension
+            elif output_file.endswith(compressed_extension):
+                output_file_renamed = output_file.removesuffix('.gz')
+                warnings.warn(f'WARNING!!! The output format selected is not compatible with compression. {output_file}'
+                              f' will be renamed to {output_file}')
 
         return TapPlus.launch_job_async(self, query=query,
                                         name=name,
@@ -957,25 +964,5 @@ def launch_job_async(self, query, name=None, output_file=None,
                                         upload_table_name=upload_table_name,
                                         autorun=autorun)
 
-    def rename_table(self, table_name=None, new_table_name=None, new_column_names_dict={},
-                     verbose=False):
-        """
-            This new method allows to update the column names of a user table.
-            header example: rename_table(table_name=old_table_name, new_table_name=new_table_name -optional-
-             , new_column_names_dict=[old_column1:new_column1, old_column2:new_colum2...])
-            Parameters
-            ----------
-            table_name: str, required
-                old name of the user's table
-            new_table_name: str, required
-                new name of the user's table
-            new_column_names_dict: dict str:str, required
-                dict with pairs "old_column1_name:new_column1_name"
-            verbose : bool, optional, default 'False'
-                flag to display information about the process
-        """
-        return TapPlus.rename_table(self, table_name=table_name, new_table_name=new_table_name,
-                                    new_column_names_dict=new_column_names_dict, verbose=verbose)
-
 
 Gaia = GaiaClass()