This new commit adds a new functionality to the TAP+. With this new

mhsarmiento · mhsarmiento · commit f9317a452028 · 2022-02-24T15:18:15.000+01:00
development now it is possible to rename the name of the user table
and/or its columns
diff --git a/astroquery/gaia/core.py b/astroquery/gaia/core.py
@@ -900,5 +900,25 @@ 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()
diff --git a/astroquery/utils/tap/conn/tapconn.py b/astroquery/utils/tap/conn/tapconn.py
@@ -391,6 +391,32 @@ def execute_table_edit(self, data,
         context = self.__get_table_edit_context()
         return self.__execute_post(context, data, content_type, verbose)
 
+    def execute_table_tool(self, data,
+                           content_type=CONTENT_TYPE_POST_DEFAULT,
+                           verbose=False):
+        """Executes a POST upload request
+        The connection is done through HTTP or HTTPS depending on the login
+        status (logged in -> HTTPS)
+
+        Parameters
+        ----------
+        data : str, mandatory
+            POST data
+        content_type: str, optional, default: application/x-www-form-urlencoded
+            HTTP(s) content-type header value
+        verbose : bool, optional, default 'False'
+            flag to display information about the process
+
+        Returns
+        -------
+        An HTTP(s) response object
+        """
+        context = self.__get_table_edit_context()
+        return self.__execute_post(context, data, content_type, verbose)
+
+
+
+
     def __execute_post(self, context, data,
                        content_type=CONTENT_TYPE_POST_DEFAULT,
                        verbose=False):
diff --git a/astroquery/utils/tap/conn/tests/DummyConnHandler.py b/astroquery/utils/tap/conn/tests/DummyConnHandler.py
@@ -170,3 +170,9 @@ def execute_table_edit(self, data,
                            verbose=False):
         return self.__execute_post(subcontext="tableEdit", data=data,
                                    content_type=content_type, verbose=verbose)
+
+    def execute_table_tool(self, data,
+                           content_type="application/x-www-form-urlencoded",
+                           verbose=False):
+        return self.__execute_post(subcontext="TableTool", data=data,
+                                   content_type=content_type, verbose=verbose)
diff --git a/astroquery/utils/tap/core.py b/astroquery/utils/tap/core.py
@@ -32,7 +32,6 @@
 from astropy.table.table import Table
 import tempfile
 
-
 __all__ = ['Tap', 'TapPlus']
 
 VERSION = "20200428.1"
@@ -571,7 +570,7 @@ def __launchJobMultipart(self, query, uploadResource, uploadTableName,
             "FORMAT": str(outputFormat),
             "tapclient": str(TAP_CLIENT_ID),
             "QUERY": str(query),
-            "UPLOAD": ""+str(uploadValue)}
+            "UPLOAD": "" + str(uploadValue)}
         if autorun is True:
             args['PHASE'] = 'RUN'
         if name is not None:
@@ -657,7 +656,7 @@ def __parseUrl(self, url, verbose=False):
         if urlInfoPos < 0:
             raise ValueError("Invalid URL format")
 
-        urlInfo = url[(urlInfoPos+3):]
+        urlInfo = url[(urlInfoPos + 3):]
 
         items = urlInfo.split("/")
 
@@ -672,7 +671,7 @@ def __parseUrl(self, url, verbose=False):
         if portPos > 0:
             # port found
             host = hostPort[0:portPos]
-            port = int(hostPort[portPos+1:])
+            port = int(hostPort[portPos + 1:])
         else:
             # no port found
             host = hostPort
@@ -693,10 +692,10 @@ def __parseUrl(self, url, verbose=False):
             tapContext = f"/{items[2]}"
         else:
             data = []
-            for i in range(1, itemsSize-1):
+            for i in range(1, itemsSize - 1):
                 data.append(f"/{items[i]}")
             serverContext = utils.util_create_string_from_buffer(data)
-            tapContext = f"/{items[itemsSize-1]}"
+            tapContext = f"/{items[itemsSize - 1]}"
         if verbose:
             print(f"protocol: '{protocol}'")
             print(f"host: '{host}'")
@@ -713,6 +712,7 @@ class TapPlus(Tap):
     """TAP plus class
     Provides TAP and TAP+ capabilities
     """
+
     def __init__(self, url=None,
                  host=None,
                  server_context=None,
@@ -1532,7 +1532,7 @@ def __uploadTableMultipart(self, resource, table_name=None,
                     chunk = f.read()
                 files = [['FILE', os.path.basename(resource), chunk]]
                 contentType, body = connHandler.encode_multipart(args, files)
-            else:    # upload from URL
+            else:  # upload from URL
                 args = {
                     "TASKID": str(-1),
                     "TABLE_NAME": str(table_name),
@@ -1628,14 +1628,14 @@ def delete_user_table(self, table_name=None, force_removal=False,
             raise ValueError("Table name cannot be null")
         if force_removal is True:
             args = {
-                    "TABLE_NAME": str(table_name),
-                    "DELETE": "TRUE",
-                    "FORCE_REMOVAL": "TRUE"}
+                "TABLE_NAME": str(table_name),
+                "DELETE": "TRUE",
+                "FORCE_REMOVAL": "TRUE"}
         else:
             args = {
-                    "TABLE_NAME": str(table_name),
-                    "DELETE": "TRUE",
-                    "FORCE_REMOVAL": "FALSE"}
+                "TABLE_NAME": str(table_name),
+                "DELETE": "TRUE",
+                "FORCE_REMOVAL": "FALSE"}
         connHandler = self.__getconnhandler()
         data = connHandler.url_encode(args)
         response = connHandler.execute_upload(data, verbose=verbose)
@@ -1648,6 +1648,145 @@ def delete_user_table(self, table_name=None, force_removal=False,
         msg = f"Table '{table_name}' deleted."
         print(msg)
 
+    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
+        """
+        args = {}
+
+        if table_name is None:
+            raise ValueError("Table name cannot be null")
+        if (new_table_name is None or new_table_name == '') and \
+                (new_column_names_dict is None or not new_column_names_dict):
+            raise ValueError("Please introduce as minimum a new table tame or a new name for a column with format "
+                             "old_column1_name:new_column1_name, ... ,old_columnN_name:new_columnN_name")
+
+        # Now we will check that the table exist
+        table = self.load_table(table=table_name, verbose=verbose)
+
+        # Check now if the table exist and contains values
+        if table is None:
+            raise ValueError("Table name not found")
+        columns = table.columns
+        if len(columns) == 0:
+            raise ValueError("Table has no columns")
+
+        if new_table_name is not None or new_table_name != '':
+            if new_column_names_dict is None or not new_column_names_dict:
+                # case 1: We only need to rename the table
+                args = self.get_args_4_rename_table_only_table_name(table_name, new_table_name)
+            else:
+                # case 2: We need to rename both, columns and column name
+                args = self.get_args_4_rename_table_all(table_name, new_table_name, new_column_names_dict)
+            # __end_if
+        # __end_if
+
+        if new_table_name is None or new_table_name == '':
+            if new_column_names_dict is not None or new_column_names_dict:
+                # case 3: We only need to rename the columns but same column name
+                args = self.get_args_4_rename_table_only_columns(table_name, new_column_names_dict)
+
+        connHandler = self.__getconnhandler()
+        data = connHandler.url_encode(args)
+        response = connHandler.execute_table_tool(data, verbose=verbose)
+        if verbose:
+            print(response.status, response.reason)
+            print(response.getheaders())
+        connHandler.check_launch_response_status(response,
+                                                 verbose,
+                                                 200)
+        msg = f"Table '{table_name}' updated."
+        print(msg)
+
+    # __end_of_rename_table
+
+    def get_args_4_rename_table_only_table_name(self, table_name, new_table_name):
+
+        args = {
+            "action": "rename",
+            "new_table_name": new_table_name,
+            "table_name": table_name
+        }
+        return args
+
+    # __end_of_rename_table_only_table_name
+
+    def get_args_4_rename_table_all(self, table_name, new_table_name, new_column_names_dict):
+        count = 0
+        new_column_names = ""
+        # check if the changes proposed for the columns are correct.
+        for key, value in new_column_names_dict.items():
+            if key == '':
+                raise ValueError(f" Old column name introduced "f"{key}"f" cannot be empty")
+            if key == value:
+                raise ValueError(f" Old column name introduced "f"{key}"f" and new column name introduced "
+                                 f" "f"{key}"f" cannot be the same")
+            if value == "":
+                raise ValueError(f" New column name introduced "f"{value}"f" cannot be empty")
+
+            # Converting dict into a string with the format expected by the TAP server
+            new_pair = key + ":" + value
+            new_column_names = new_column_names + new_pair
+            count = count + 1
+            if count < len(new_column_names_dict):
+                new_column_names = new_column_names + ','
+        # __end_for_loop
+
+        args = {
+            "action": "rename",
+            "new_column_names": new_column_names,
+            "new_table_name": new_table_name,
+            "table_name": table_name
+        }
+        return args
+
+    # __end_of_rename_table_all
+
+    def get_args_4_rename_table_only_columns(self, table_name, new_column_names_dict):
+        # check if the changes proposed for the columns are correct.
+
+        new_column_names = ""
+
+        count = 0
+        for key, value in new_column_names_dict.items():
+            if key == '':
+                raise ValueError(f" Old column name introduced "f"{key}"f" cannot be empty")
+            if key == value:
+                raise ValueError(f" Old column name introduced "f"{key}"f" and new column name introduced "
+                                 f" "f"{key}"f" cannot be the same")
+            if value == "":
+                raise ValueError(f" New column name introduced "f"{value}"f" cannot be empty")
+
+            # Converting dict into a string with the format expected by the TAP server
+            new_pair = key + ":" + value
+            new_column_names = new_column_names + new_pair
+            count = count + 1
+            if count < len(new_column_names_dict):
+                new_column_names = new_column_names + ','
+        # __end_for_loop
+
+        args = {
+            "action": "rename",
+            "new_column_names": new_column_names,
+            "table_name": table_name
+        }
+        return args
+
+    # __end_of_rename_table_only_columns
+
     def update_user_table(self, table_name=None, list_of_changes=[],
                           verbose=False):
         """Updates a user table
@@ -1738,11 +1877,11 @@ def update_user_table(self, table_name=None, list_of_changes=[],
     def get_table_update_arguments(table_name, columns, list_of_changes):
         num_cols = len(columns)
         args = {
-                "ACTION": "edit",
-                "NUMTABLES": str(1),
-                "TABLE0_NUMCOLS": str(num_cols),
-                "TABLE0": str(table_name),
-                }
+            "ACTION": "edit",
+            "NUMTABLES": str(1),
+            "TABLE0_NUMCOLS": str(num_cols),
+            "TABLE0": str(table_name),
+        }
         index = 0
         for column in columns:
             found_in_changes = False
@@ -1890,11 +2029,11 @@ def set_ra_dec_columns(self, table_name=None,
             raise ValueError("Dec column name cannot be null")
 
         args = {
-                "ACTION": "radec",
-                "TABLE_NAME": str(table_name),
-                "RA": str(ra_column_name),
-                "DEC": str(dec_column_name),
-                }
+            "ACTION": "radec",
+            "TABLE_NAME": str(table_name),
+            "RA": str(ra_column_name),
+            "DEC": str(dec_column_name),
+        }
         connHandler = self.__getconnhandler()
         data = connHandler.url_encode(args)
         response = connHandler.execute_table_edit(data, verbose=verbose)
diff --git a/astroquery/utils/tap/tests/data/test_table_rename.xml b/astroquery/utils/tap/tests/data/test_table_rename.xml
@@ -0,0 +1,52 @@
+<vod:tableset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+              xmlns:vod="http://www.ivoa.net/xml/VODataService/v1.1"
+              xmlns:esatapplus="http://esa.int/xml/EsaTapPlus"
+              xsi:type="vod:TableSet"
+              xsi:schemaLocation="http://www.ivoa.net/xml/VODataService/v1.1 http://www.ivoa.net/xml/VODataService/v1.1 http://esa.int/xml/EsaTapPlus https://gea.esac.esa.int/tap-server/xml/esaTapPlusAttributes.xsd">
+    <schema esatapplus:public="false">
+        <name>user_mhenar</name>
+        <description/>
+        <table type="base_table" esatapplus:size="3" esatapplus:flags="0">
+            <name>user_mhenar.table1</name>
+            <description>
+            <![CDATA[ Uploaded from disk ]]>
+            </description>
+             <column std="false" esatapplus:flags="16" esatapplus:ref="">
+                <name>table1_oid</name>
+                <description>
+                <![CDATA[ Object Identifier ]]>
+                </description>
+                <unit/>
+                <ucd/>
+                <utype/>
+                <dataType xsi:type="vod:TAPType">INTEGER</dataType>
+                <flag>indexed</flag>
+                <flag>primary</flag>
+            </column>
+            <column std="false" esatapplus:flags="0" esatapplus:ref="">
+                <name>source_id</name>
+                <description/>
+                <unit/>
+                <ucd>None</ucd>
+                <utype>None</utype>
+                <dataType xsi:type="vod:TAPType">VARCHAR</dataType>
+            </column>
+            <column std="false" esatapplus:flags="0" esatapplus:ref="">
+                <name>ra</name>
+                <description/>
+                <unit/>
+                <ucd/>
+                <utype/>
+                <dataType xsi:type="vod:TAPType">DOUBLE</dataType>
+            </column>
+            <column std="false" esatapplus:flags="0" esatapplus:ref="">
+                <name>dec</name>
+                <description/>
+                <unit/>
+                <ucd/>
+                <utype/>
+                <dataType xsi:type="vod:TAPType">DOUBLE</dataType>
+            </column>
+        </table>
+    </schema>
+</vod:tableset>
diff --git a/astroquery/utils/tap/tests/test_tap.py b/astroquery/utils/tap/tests/test_tap.py
