Merge pull request #2193 from jaymedina/monkey-patch-services

bsipocz · web-flow · commit 4a3f214c3852 · 2022-01-26T10:58:11.000-08:00
monkey patch services
diff --git a/astroquery/mast/discovery_portal.py b/astroquery/mast/discovery_portal.py
@@ -116,23 +116,23 @@ class PortalAPI(BaseQuery):
     Should be used to facilitate all Portal API queries.
     """
 
+    MAST_REQUEST_URL = conf.server + "/api/v0/invoke"
+    COLUMNS_CONFIG_URL = conf.server + "/portal/Mashup/Mashup.asmx/columnsconfig"
+    MAST_DOWNLOAD_URL = conf.server + "/api/v0.1/Download/file"
+    MAST_BUNDLE_URL = conf.server + "/api/v0.1/Download/bundle"
+
+    TIMEOUT = conf.timeout
+    PAGESIZE = conf.pagesize
+
+    _column_configs = dict()
+    _current_service = None
+
     def __init__(self, session=None):
 
         super(PortalAPI, self).__init__()
         if session:
             self._session = session
 
-        self.MAST_REQUEST_URL = conf.server + "/api/v0/invoke"
-        self.COLUMNS_CONFIG_URL = conf.server + "/portal/Mashup/Mashup.asmx/columnsconfig"
-        self.MAST_DOWNLOAD_URL = conf.server + "/api/v0.1/Download/file"
-        self.MAST_BUNDLE_URL = conf.server + "/api/v0.1/Download/bundle"
-
-        self.TIMEOUT = conf.timeout
-        self.PAGESIZE = conf.pagesize
-
-        self._column_configs = dict()
-        self._current_service = None
-
     def _request(self, method, url, params=None, data=None, headers=None,
                  files=None, stream=False, auth=None, retrieve_all=True):
         """
@@ -482,6 +482,7 @@ def _get_columnsconfig_metadata(self, colconf_name):
         headers = {"User-Agent": self._session.headers["User-Agent"],
                    "Content-type": "application/x-www-form-urlencoded",
                    "Accept": "text/plain"}
+
         response = self._request("POST", self.COLUMNS_CONFIG_URL,
                                  data=("colConfigId={}".format(colconf_name)), headers=headers)
 
diff --git a/astroquery/mast/observations.py b/astroquery/mast/observations.py
@@ -6,7 +6,6 @@
 This module contains various methods for querying MAST observations.
 """
 
-
 import warnings
 import json
 import time
@@ -38,7 +37,6 @@
 from . import conf, utils
 from .core import MastQueryWithLogin
 
-
 __all__ = ['Observations', 'ObservationsClass',
            'MastClass', 'Mast']
 
@@ -51,6 +49,13 @@ class ObservationsClass(MastQueryWithLogin):
     Class for querying MAST observational data.
     """
 
+    # Calling static class variables
+    _caom_all = 'Mast.Caom.All'
+    _caom_cone = 'Mast.Caom.Cone'
+    _caom_filtered_position = 'Mast.Caom.Filtered.Position'
+    _caom_filtered = 'Mast.Caom.Filtered'
+    _caom_products = 'Mast.Caom.Products'
+
     def _parse_result(self, responses, verbose=False):  # Used by the async_to_sync decorator functionality
         """
         Parse the results of a list of `~requests.Response` objects and returns an `~astropy.table.Table` of results.
@@ -82,7 +87,7 @@ def list_missions(self):
         """
 
         # getting all the histogram information
-        service = "Mast.Caom.All"
+        service = self._caom_all
         params = {}
         response = self._portal_api_connection.service_request_async(service, params, format='extjs')
         json_response = response[0].json()
@@ -112,9 +117,9 @@ def get_metadata(self, query_type):
         """
 
         if query_type.lower() == "observations":
-            colconf_name = "Mast.Caom.Cone"
+            colconf_name = self._caom_cone
         elif query_type.lower() == "products":
-            colconf_name = "Mast.Caom.Products"
+            colconf_name = self._caom_products
         else:
             raise InvalidQueryError("Unknown query type.")
 
@@ -152,14 +157,14 @@ def _parse_caom_criteria(self, **criteria):
 
         # Build the mashup filter object and store it in the correct service_name entry
         if coordinates or objectname:
-            mashup_filters = self._portal_api_connection.build_filter_set("Mast.Caom.Cone",
-                                                                           "Mast.Caom.Filtered.Position",
-                                                                           **criteria)
+            mashup_filters = self._portal_api_connection.build_filter_set(self._caom_cone,
+                                                            self._caom_filtered_position,
+                                                            **criteria)
             coordinates = utils.parse_input_location(coordinates, objectname)
         else:
-            mashup_filters = self._portal_api_connection.build_filter_set("Mast.Caom.Cone",
-                                                                           "Mast.Caom.Filtered",
-                                                                           **criteria)
+            mashup_filters = self._portal_api_connection.build_filter_set(self._caom_cone,
+                                                            self._caom_filtered,
+                                                            **criteria)
 
         # handle position info (if any)
         position = None
@@ -168,7 +173,7 @@ def _parse_caom_criteria(self, **criteria):
             # if radius is just a number we assume degrees
             radius = coord.Angle(radius, u.deg)
 
-            # build the coordinates string needed by Mast.Caom.Filtered.Position
+            # build the coordinates string needed by ObservationsClass._caom_filtered_position
             position = ', '.join([str(x) for x in (coordinates.ra.deg, coordinates.dec.deg, radius.deg)])
 
         return position, mashup_filters
@@ -209,7 +214,7 @@ def query_region_async(self, coordinates, radius=0.2*u.deg, pagesize=None, page=
         # if radius is just a number we assume degrees
         radius = coord.Angle(radius, u.deg)
 
-        service = 'Mast.Caom.Cone'
+        service = self._caom_cone
         params = {'ra': coordinates.ra.deg,
                   'dec': coordinates.dec.deg,
                   'radius': radius.deg}
@@ -286,12 +291,12 @@ def query_criteria_async(self, pagesize=None, page=None, **criteria):
             raise InvalidQueryError("At least one non-positional criterion must be supplied.")
 
         if position:
-            service = "Mast.Caom.Filtered.Position"
+            service = self._caom_filtered_position
             params = {"columns": "*",
                       "filters": mashup_filters,
                       "position": position}
         else:
-            service = "Mast.Caom.Filtered"
+            service = self._caom_filtered
             params = {"columns": "*",
                       "filters": mashup_filters}
 
@@ -322,7 +327,7 @@ def query_region_count(self, coordinates, radius=0.2*u.deg, pagesize=None, page=
         response : int
         """
 
-        # build the coordinates string needed by Mast.Caom.Filtered.Position
+        # build the coordinates string needed by ObservationsClass._caom_filtered_position
         coordinates = commons.parse_coordinates(coordinates)
 
         # if radius is just a number we assume degrees
@@ -331,7 +336,7 @@ def query_region_count(self, coordinates, radius=0.2*u.deg, pagesize=None, page=
         # turn coordinates into the format
         position = ', '.join([str(x) for x in (coordinates.ra.deg, coordinates.dec.deg, radius.deg)])
 
-        service = "Mast.Caom.Filtered.Position"
+        service = self._caom_filtered_position
         params = {"columns": "COUNT_BIG(*)",
                   "filters": [],
                   "position": position}
@@ -399,12 +404,12 @@ def query_criteria_count(self, pagesize=None, page=None, **criteria):
 
         # send query
         if position:
-            service = "Mast.Caom.Filtered.Position"
+            service = self._caom_filtered_position
             params = {"columns": "COUNT_BIG(*)",
                       "filters": mashup_filters,
                       "position": position}
         else:
-            service = "Mast.Caom.Filtered"
+            service = self._caom_filtered
             params = {"columns": "COUNT_BIG(*)",
                       "filters": mashup_filters}
 
@@ -440,7 +445,7 @@ def get_product_list_async(self, observations):
         if len(observations) == 0:
             raise InvalidQueryError("Observation list is empty, no associated products.")
 
-        service = 'Mast.Caom.Products'
+        service = self._caom_products
         params = {'obsid': ','.join(observations)}
 
         return self._portal_api_connection.service_request_async(service, params)
diff --git a/astroquery/mast/services.py b/astroquery/mast/services.py
@@ -101,15 +101,16 @@ class ServiceAPI(BaseQuery):
     Should be used to facilitate all microservice API queries.
     """
 
+    SERVICE_URL = conf.server
+    REQUEST_URL = conf.server + "/api/v0.1/"
+    SERVICES = {}
+
     def __init__(self, session=None):
 
         super().__init__()
         if session:
             self._session = session
 
-        self.REQUEST_URL = conf.server + "/api/v0.1/"
-        self.SERVICES = {}
-
         self.TIMEOUT = conf.timeout
 
     def set_service_params(self, service_dict, service_name="", server_prefix=False):
@@ -128,7 +129,7 @@ def set_service_params(self, service_dict, service_name="", server_prefix=False)
             vs. the default of mast.stsci.edu/service_name
         """
 
-        service_url = conf.server
+        service_url = self.SERVICE_URL
         if server_prefix:
             service_url = service_url.replace("mast", f"{service_name}.mast")
         else:
@@ -248,6 +249,7 @@ def service_request_async(self, service, params, page_size=None, page=None, **kw
             compiled_service_args[service_argument] = found_argument.lower()
 
         request_url = self.REQUEST_URL + service_url.format(**compiled_service_args)
+
         headers = {
             'User-Agent': self._session.headers['User-Agent'],
             'Content-type': 'application/x-www-form-urlencoded',
