Remove an utility function for reading test data

`astroquery.utils.tap.xmlparser.utils.read_file_content()` has been
replaced with the standard library `pathlib.Path.read_text()`.
Furthermore, in the modules where multiple test functions previously
used `read_file_content()` to read the data files, they are now read
once at the module level instead.

Author: eerovaher

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/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/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)
 

astroquery/utils/tap/tests/test_tap.py

@@ -12,7 +12,7 @@
 
 Created on 30 jun. 2016
 """
-import os
+from pathlib import Path
 from unittest.mock import patch
 from urllib.parse import quote_plus, urlencode
 
@@ -25,22 +25,17 @@
 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.utils.tap import taputils
 
 
-def data_path(filename):
-    data_dir = os.path.join(os.path.dirname(__file__), 'data')
-    return os.path.join(data_dir, filename)
+TEST_DATA = {f.name: f.read_text() for f in Path(__file__).with_name("data").iterdir()}
 
 
 def test_load_tables():
     connHandler = DummyConnHandler()
     tap = TapPlus("http://test:1111/tap", connhandler=connHandler)
     responseLoadTable = DummyResponse(500)
-    tableDataFile = data_path('test_tables.xml')
-    tableData = utils.read_file_content(tableDataFile)
-    responseLoadTable.set_data(method='GET', body=tableData)
+    responseLoadTable.set_data(method='GET', body=TEST_DATA["test_tables.xml"])
     tableRequest = "tables"
     connHandler.set_response(tableRequest, responseLoadTable)
     with pytest.raises(Exception):
@@ -77,9 +72,7 @@ def test_load_tables_parameters():
     connHandler = DummyConnHandler()
     tap = TapPlus("http://test:1111/tap", connhandler=connHandler)
     responseLoadTable = DummyResponse(200)
-    tableDataFile = data_path('test_tables.xml')
-    tableData = utils.read_file_content(tableDataFile)
-    responseLoadTable.set_data(method='GET', body=tableData)
+    responseLoadTable.set_data(method='GET', body=TEST_DATA["test_tables.xml"])
     tableRequest = "tables"
     connHandler.set_response(tableRequest, responseLoadTable)
 
@@ -125,9 +118,7 @@ def test_load_table():
         tap.load_table()
 
     responseLoadTable = DummyResponse(500)
-    tableDataFile = data_path('test_table1.xml')
-    tableData = utils.read_file_content(tableDataFile)
-    responseLoadTable.set_data(method='GET', body=tableData)
+    responseLoadTable.set_data(method='GET', body=TEST_DATA["test_table1.xml"])
     tableSchema = "public"
     tableName = "table1"
     fullQualifiedTableName = f"{tableSchema}.{tableName}"
@@ -153,9 +144,7 @@ def test_launch_sync_job():
     connHandler = DummyConnHandler()
     tap = TapPlus("http://test:1111/tap", connhandler=connHandler)
     responseLaunchJob = DummyResponse(500)
-    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=TEST_DATA["job_1.vot"])
     query = 'select top 5 * from table'
     dictTmp = {
         "REQUEST": "doQuery",
@@ -229,9 +218,7 @@ def test_launch_sync_job_redirect():
     connHandler.set_response(jobRequest, responseLaunchJob)
     # Results response
     responseResultsJob = DummyResponse(500)
-    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=TEST_DATA["job_1.vot"])
     connHandler.set_response(resultsReq, responseResultsJob)
 
     with pytest.raises(Exception):
@@ -316,9 +303,7 @@ def test_launch_async_job():
     connHandler.set_response(req, responsePhase)
     # Results response
     responseResultsJob = DummyResponse(500)
-    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=TEST_DATA["job_1.vot"])
     req = f"async/{jobid}/results/result"
     connHandler.set_response(req, responseResultsJob)
 
@@ -398,9 +383,7 @@ def test_start_job():
     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=TEST_DATA["job_1.vot"])
     req = f"async/{jobid}/results/result"
     connHandler.set_response(req, responseResultsJob)
 
@@ -490,9 +473,7 @@ def test_job_parameters():
     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=TEST_DATA["job_1.vot"])
     req = f"async/{jobid}/results/result"
     connHandler.set_response(req, responseResultsJob)
 
@@ -526,9 +507,7 @@ def test_list_async_jobs():
     connHandler = DummyConnHandler()
     tap = TapPlus("http://test:1111/tap", connhandler=connHandler)
     response = DummyResponse(500)
-    jobDataFile = data_path('jobs_list.xml')
-    jobData = utils.read_file_content(jobDataFile)
-    response.set_data(method='GET', body=jobData)
+    response.set_data(method='GET', body=TEST_DATA["jobs_list.xml"])
     req = "async"
     connHandler.set_response(req, response)
     with pytest.raises(Exception):
@@ -549,9 +528,7 @@ def test_data():
                   data_context="data",
                   connhandler=connHandler)
     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=TEST_DATA["job_1.vot"])
     req = "?ID=1%2C2&format=votable"
     connHandler.set_response(req, responseResultsJob)
     req = "?ID=1%2C2"
@@ -585,9 +562,7 @@ def test_datalink():
                   datalink_context="datalink",
                   connhandler=connHandler)
     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=TEST_DATA["job_1.vot"])
     req = "links?ID=1,2"
     connHandler.set_response(req, responseResultsJob)
 
@@ -750,9 +725,7 @@ def test_update_user_table():
     connHandler = DummyConnHandler()
     tap = TapPlus("http://test:1111/tap", connhandler=connHandler)
     dummyResponse = DummyResponse(200)
-    tableDataFile = data_path('test_table_update.xml')
-    tableData = utils.read_file_content(tableDataFile)
-    dummyResponse.set_data(method='GET', body=tableData)
+    dummyResponse.set_data(method='GET', body=TEST_DATA["test_table_update.xml"])
     tableRequest = f"tables?tables={tableName}"
     connHandler.set_response(tableRequest, dummyResponse)
 
@@ -818,9 +791,7 @@ def test_rename_table():
     connHandler = DummyConnHandler()
     tap = TapPlus("http://test:1111/tap", connhandler=connHandler)
     dummyResponse = DummyResponse(200)
-    tableDataFile = data_path('test_table_rename.xml')
-    tableData = utils.read_file_content(tableDataFile)
-    dummyResponse.set_data(method='GET', body=tableData)
+    dummyResponse.set_data(method='GET', body=TEST_DATA["test_table_rename.xml"])
 
     with pytest.raises(Exception):
         tap.rename_table()

astroquery/utils/tap/xmlparser/utils.py

@@ -53,13 +53,6 @@ def get_suitable_astropy_format(output_format):
     return output_format
 
 
-def read_file_content(file_path):
-    file_handler = open(file_path, 'r')
-    file_content = file_handler.read()
-    file_handler.close()
-    return file_content
-
-
 def modify_unrecognized_table_units(table):
     """Modifies the units of an input table column in place
     """