Merge pull request #2635 from eerovaher/refactor-tap

Remove unused code from `utils.tap` and related sub-packages

Author: bsipocz

astroquery/esa/hubble/core.py

@@ -8,6 +8,7 @@
 European Space Agency (ESA)
 
 """
+from urllib.parse import urlencode
 
 from astropy import units
 from astropy.coordinates import SkyCoord
@@ -503,7 +504,7 @@ def _query_tap_target(self, target):
 
             subContext = conf.EHST_TARGET_ACTION
             connHandler = self._tap._TapPlus__getconnhandler()
-            data = connHandler.url_encode(params)
+            data = urlencode(params)
             target_response = connHandler.execute_secure(subContext, data, True)
             for line in target_response:
                 target_result = json.loads(line.decode("utf-8"))

astroquery/esa/jwst/core.py

@@ -16,6 +16,7 @@
 import tarfile
 import zipfile
 from datetime import datetime
+from urllib.parse import urlencode
 
 from astropy import log
 from astropy import units
@@ -667,9 +668,8 @@ def set_token(self, token):
             MAST token to have access to propietary data
         """
         subContext = conf.JWST_TOKEN
-        args = {"token": token}
+        data = urlencode({"token": token})
         connHandler = self.__jwsttap._TapPlus__getconnhandler()
-        data = connHandler.url_encode(args)
         response = connHandler.execute_secure(subContext, data, True)
         if response.status == 403:
             print("ERROR: MAST tokens cannot be assigned or requested by anonymous users")

astroquery/esa/jwst/tests/test_jwsttap.py

@@ -10,6 +10,7 @@
 """
 import os
 import shutil
+from pathlib import Path
 from unittest.mock import MagicMock
 
 import astropy.units as u
@@ -28,12 +29,14 @@
 from astroquery.utils.tap.conn.tests.DummyConnHandler import DummyConnHandler
 from astroquery.utils.tap.conn.tests.DummyResponse import DummyResponse
 from astroquery.utils.tap.core import TapPlus
-from astroquery.utils.tap.xmlparser import utils
 from astroquery.vizier import Vizier
 
 from astroquery.esa.jwst import conf
 
 
+JOB_DATA = (Path(__file__).with_name("data") / "job_1.vot").read_text()
+
+
 def data_path(filename):
     data_dir = os.path.join(os.path.dirname(__file__), 'data')
     return os.path.join(data_dir, filename)
@@ -234,9 +237,7 @@ def test_query_region(self):
         # Launch response: we use default response because the
         # query contains decimals
         responseLaunchJob = DummyResponse(200)
-        jobDataFile = data_path('job_1.vot')
-        jobData = utils.read_file_content(jobDataFile)
-        responseLaunchJob.set_data(method='POST', body=jobData)
+        responseLaunchJob.set_data(method='POST', body=JOB_DATA)
         # The query contains decimals: force default response
         connHandler.set_default_response(responseLaunchJob)
         sc = SkyCoord(ra=29.0, dec=15.0, unit=(u.degree, u.degree),
@@ -379,9 +380,7 @@ def test_query_region_async(self):
         connHandler.set_response(req, responsePhase)
         # Results response
         responseResultsJob = DummyResponse(200)
-        jobDataFile = data_path('job_1.vot')
-        jobData = utils.read_file_content(jobDataFile)
-        responseResultsJob.set_data(method='GET', body=jobData)
+        responseResultsJob.set_data(method='GET', body=JOB_DATA)
         req = "async/" + jobid + "/results/result"
         connHandler.set_response(req, responseResultsJob)
         sc = SkyCoord(ra=29.0, dec=15.0, unit=(u.degree, u.degree),
@@ -442,9 +441,7 @@ def test_cone_search_sync(self):
         # Launch response: we use default response because the
         # query contains decimals
         responseLaunchJob = DummyResponse(200)
-        jobDataFile = data_path('job_1.vot')
-        jobData = utils.read_file_content(jobDataFile)
-        responseLaunchJob.set_data(method='POST', body=jobData)
+        responseLaunchJob.set_data(method='POST', body=JOB_DATA)
         ra = 19.0
         dec = 20.0
         sc = SkyCoord(ra=ra, dec=dec, unit=(u.degree, u.degree), frame='icrs')
@@ -544,9 +541,7 @@ def test_cone_search_async(self):
         connHandler.set_response(req, responsePhase)
         # Results response
         responseResultsJob = DummyResponse(200)
-        jobDataFile = data_path('job_1.vot')
-        jobData = utils.read_file_content(jobDataFile)
-        responseResultsJob.set_data(method='GET', body=jobData)
+        responseResultsJob.set_data(method='GET', body=JOB_DATA)
         req = "async/" + jobid + "/results/result"
         connHandler.set_response(req, responseResultsJob)
         job = tap.cone_search(sc, radius, async_job=True)

astroquery/gaia/tests/DummyTapHandler.py

@@ -14,8 +14,6 @@
 
 
 """
-from urllib.parse import urlencode
-
 CONTENT_TYPE_POST_DEFAULT = "application/x-www-form-urlencoded"
 
 
@@ -320,6 +318,3 @@ def is_valid_user(self, user_id=None, verbose=False):
         self.__invokedMethod = 'is_valid_user'
         self.__parameters['user_id'] = user_id
         self.__parameters['verbose'] = verbose
-
-    def url_encode(self, data):
-        return urlencode(data)

astroquery/gaia/tests/test_gaiatap.py

@@ -30,11 +30,10 @@
 import astropy.units as u
 from astropy.coordinates.sky_coordinate import SkyCoord
 import numpy as np
-from astroquery.utils.tap.xmlparser import utils
 from astroquery.utils.tap.core import TapPlus
 
 
-job_data = utils.read_file_content(Path(__file__).parent.joinpath("data", "job_1.vot"))
+job_data = (Path(__file__).with_name("data") / "job_1.vot").read_text()
 
 skycoord = SkyCoord(ra=19 * u.deg, dec=20 * u.deg, frame="icrs")
 

astroquery/utils/tap/conn/tapconn.py

@@ -24,8 +24,6 @@
 import mimetypes
 import time
 
-from urllib.parse import urlencode
-
 from astroquery.utils.tap.xmlparser import utils
 from astroquery.utils.tap import taputils
 from astroquery import version
@@ -474,16 +472,6 @@ def get_response_reason(self):
         """
         return self.__currentReason
 
-    def url_encode(self, data):
-        """Encodes the provided dictionary
-
-        Parameters
-        ----------
-        data : dictionary, mandatory
-            dictionary to be encoded
-        """
-        return urlencode(data)
-
     def find_header(self, headers, key):
         """Searches for the specified keyword
 

astroquery/utils/tap/conn/tests/DummyConnHandler.py

@@ -16,8 +16,6 @@
 """
 from astroquery.utils.tap import taputils
 
-from urllib.parse import urlencode
-
 import requests
 
 
@@ -29,8 +27,6 @@ def __init__(self):
         self.fileExt = ".ext"
         self.defaultResponse = None
         self.responses = {}
-        self.errorFileOutput = None
-        self.errorReceivedResponse = None
         self.contentType = None
         self.verbose = None
         self.query = None
@@ -42,21 +38,6 @@ def set_default_response(self, defaultResponse):
     def get_default_response(self):
         return self.defaultResponse
 
-    def get_last_request(self):
-        return self.request
-
-    def get_last_data(self):
-        return self.data
-
-    def get_last_query(self):
-        return self.query
-
-    def get_error_file_output(self):
-        return self.errorFileOutput
-
-    def get_error_received_response(self):
-        return self.errorReceivedResponse
-
     def set_response(self, request, response):
         self.responses[str(request)] = response
 
@@ -102,8 +83,6 @@ def __execute_post(self, subcontext=None, data=None,
         return self.__get_response(self.request)
 
     def dump_to_file(self, fileOutput, response):
-        self.errorFileOutput = fileOutput
-        self.errorReceivedResponse = response
         print(f"DummyConnHandler - dump to file: file: '{fileOutput}', \
         response status: {response.status}, response msg: {response.reason}")
 
@@ -147,15 +126,9 @@ def check_launch_response_status(self, response, debug,
         else:
             return isError
 
-    def url_encode(self, data):
-        return urlencode(data)
-
     def get_suitable_extension(self, headers):
         return self.fileExt
 
-    def set_suitable_extension(self, ext):
-        self.fileExt = ext
-
     def get_suitable_extension_by_format(self, output_format):
         return self.fileExt
 

astroquery/utils/tap/core.py

@@ -13,6 +13,8 @@
 Created on 30 jun. 2016
 Modified on 1 jun. 2021 by mhsarmiento
 """
+from urllib.parse import urlencode
+
 from astroquery.utils.tap import taputils
 from astroquery.utils.tap.conn.tapconn import TapConn
 from astroquery.utils.tap.xmlparser.tableSaxParser import TableSaxParser
@@ -554,7 +556,7 @@ def list_async_jobs(self, verbose=False):
         return jobs
 
     def __appendData(self, args):
-        data = self.__connHandler.url_encode(args)
+        data = urlencode(args)
         result = ""
         firtsTime = True
         for k in data:
@@ -633,9 +635,8 @@ def __launchJob(self, query, outputFormat, context, verbose, name=None,
             args['PHASE'] = 'RUN'
         if name is not None:
             args['jobname'] = name
-        data = self.__connHandler.url_encode(args)
         response = self.__connHandler.execute_tappost(subcontext=context,
-                                                      data=data,
+                                                      data=urlencode(args),
                                                       verbose=verbose)
         if verbose:
             print(response.status, response.reason)
@@ -847,7 +848,7 @@ def load_data(self, params_dict=None, output_file=None, verbose=False):
         connHandler = self.__getconnhandler()
         if not isinstance(params_dict, dict):
             raise ValueError("Parameters dictionary expected")
-        data = connHandler.url_encode(params_dict)
+        data = urlencode(params_dict)
         if verbose:
             print(f"Data request: {data}")
         response = connHandler.execute_datapost(data=data, verbose=verbose)
@@ -1371,8 +1372,7 @@ def __execLogin(self, usr, pwd, verbose=False):
             "username": usr,
             "password": pwd}
         connHandler = self.__getconnhandler()
-        data = connHandler.url_encode(args)
-        response = connHandler.execute_secure(subContext, data, verbose)
+        response = connHandler.execute_secure(subContext, urlencode(args), verbose)
         if verbose:
             print(response.status, response.reason)
             print(response.getheaders())
@@ -1568,8 +1568,7 @@ def delete_user_table(self, table_name=None, force_removal=False,
                 "DELETE": "TRUE",
                 "FORCE_REMOVAL": "FALSE"}
         connHandler = self.__getconnhandler()
-        data = connHandler.url_encode(args)
-        response = connHandler.execute_upload(data, verbose=verbose)
+        response = connHandler.execute_upload(urlencode(args), verbose=verbose)
         if verbose:
             print(response.status, response.reason)
             print(response.getheaders())
@@ -1620,8 +1619,7 @@ def rename_table(self, table_name=None, new_table_name=None, new_column_names_di
                 args = self.get_args_4_rename_table(table_name, table_name, new_column_names_dict)
 
         connHandler = self.__getconnhandler()
-        data = connHandler.url_encode(args)
-        response = connHandler.execute_table_tool(data, verbose=verbose)
+        response = connHandler.execute_table_tool(urlencode(args), verbose=verbose)
 
         if verbose:
             print(response.status, response.reason)
@@ -1724,8 +1722,7 @@ def update_user_table(self, table_name=None, list_of_changes=[],
                                                   list_of_changes)
 
         connHandler = self.__getconnhandler()
-        data = connHandler.url_encode(args)
-        response = connHandler.execute_table_edit(data, verbose=verbose)
+        response = connHandler.execute_table_edit(urlencode(args), verbose=verbose)
         if verbose:
             print(response.status, response.reason)
             print(response.getheaders())
@@ -1897,8 +1894,7 @@ def set_ra_dec_columns(self, table_name=None,
             "DEC": str(dec_column_name),
         }
         connHandler = self.__getconnhandler()
-        data = connHandler.url_encode(args)
-        response = connHandler.execute_table_edit(data, verbose=verbose)
+        response = connHandler.execute_table_edit(urlencode(args), verbose=verbose)
         isError = connHandler.check_launch_response_status(response,
                                                            verbose,
                                                            200)
@@ -1995,10 +1991,8 @@ def logout(self, verbose=False):
             flag to display information about the process
         """
         subContext = "logout"
-        args = {}
         connHandler = self.__getconnhandler()
-        data = connHandler.url_encode(args)
-        response = connHandler.execute_secure(subContext, data)
+        response = connHandler.execute_secure(subContext, "")
         if verbose:
             print(response.status, response.reason)
             print(response.getheaders())

astroquery/utils/tap/model/job.py

@@ -16,6 +16,7 @@
 """
 
 import time
+from urllib.parse import urlencode
 
 from astroquery.utils.tap.model import modelutils
 from astroquery.utils.tap.xmlparser import utils
@@ -110,12 +111,9 @@ def abort(self, verbose=False):
     def __change_phase(self, phase, verbose=False):
         if self._phase == 'PENDING':
             context = f"async/{self.jobid}/phase"
-            args = {
-                "PHASE": str(phase)}
-            data = self.connHandler.url_encode(args)
-            response = self.connHandler.execute_tappost(subcontext=context,
-                                                        data=data,
-                                                        verbose=verbose)
+            response = self.connHandler.execute_tappost(
+                subcontext=context, data=urlencode({"PHASE": phase}), verbose=verbose
+            )
             if verbose:
                 print(response.status, response.reason)
                 print(response.getheaders())
@@ -150,11 +148,8 @@ def send_parameter(self, name=None, value=None, verbose=False):
         if self._phase == 'PENDING':
             # send post parameter/value
             context = f"async/{self.jobid}"
-            args = {
-                name: str(value)}
-            data = self.connHandler.url_encode(args)
             response = self.connHandler.execute_tappost(subcontext=context,
-                                                        data=data,
+                                                        data=urlencode({name: value}),
                                                         verbose=verbose)
             if verbose:
                 print(response.status, response.reason)

astroquery/utils/tap/model/tests/test_job.py

@@ -14,18 +14,13 @@
 
 
 """
-import os
+from pathlib import Path
+
 import pytest
 
 from astroquery.utils.tap.model.job import Job
 from astroquery.utils.tap.conn.tests.DummyConnHandler import DummyConnHandler
 from astroquery.utils.tap.conn.tests.DummyResponse import DummyResponse
-from astroquery.utils.tap.xmlparser import utils
-
-
-def data_path(filename):
-    data_dir = os.path.join(os.path.dirname(__file__), 'data')
-    return os.path.join(data_dir, filename)
 
 
 def test_job_basic():
@@ -53,9 +48,9 @@ def test_job_get_results(capsys, tmpdir):
 
     responseCheckPhase.set_status_code(200)
     responseGetData = DummyResponse(500)
-    jobContentFileName = data_path('result_1.vot')
-    jobContent = utils.read_file_content(jobContentFileName)
-    responseGetData.set_data(method='GET', body=jobContent)
+    responseGetData.set_data(
+        method="GET",
+        body=(Path(__file__).with_name("data") / "result_1.vot").read_text())
     dataRequest = f"async/{jobid}/results/result"
     connHandler.set_response(dataRequest, responseGetData)