renamed and deprecated Observations and Observations class

renamed and deprecated Observations and Observations class in mast module

added changelog entry

gemini observations old syntax now works

gemini observations old syntax still works

added old syntax to init

some corrections

mast observations old syntax still works

changes requested

updated gemini doc

updated mast doc

renamed and deprecated Observations and Observations class

fixed pep8 issues and corrected deprecated version

added Zcut

renamed obesrvation in test files

renamed and deprecated Observations and Observations class

Author: tinuademargaret

CHANGES.rst

@@ -341,6 +341,12 @@ esa.xmm_newton
 - Use astroquery downloader tool to get progressbar, caching, and prevent
   memory leaks. [#2087]
 
+observations
+^^^^^^^^^^^^
+
+- Renamed and deprecated Observations and ObservationsClass in MAST
+  and GEMINI modules. [#1885]
+
 gaia
 ^^^^
 

astroquery/gemini/__init__.py

@@ -18,6 +18,6 @@ class Conf(_config.ConfigNamespace):
 
 conf = Conf()
 
-from .core import ObservationsClass, Observations
+from .core import GeminiObservationsClass, GeminiObservations
 
-__all__ = ['Observations', 'ObservationsClass', 'conf']
+__all__ = ['GeminiObservations', 'GeminiObservationsClass', 'conf']

astroquery/gemini/core.py

@@ -11,6 +11,7 @@
 from astroquery import log
 from astropy import units
 from astropy.table import Table, MaskedColumn
+from astropy.utils import deprecated
 
 from astroquery.gemini.urlhelper import URLHelper
 import numpy as np
@@ -21,7 +22,7 @@
 from ..exceptions import AuthenticationWarning
 
 
-__all__ = ['Observations', 'ObservationsClass']  # specifies what to import
+__all__ = ['GeminiObservations', 'GeminiObservationsClass']  # specifies what to import
 
 
 __valid_instruments__ = [
@@ -97,7 +98,7 @@
 ]
 
 
-class ObservationsClass(QueryWithLogin):
+class GeminiObservationsClass(QueryWithLogin):
 
     server = conf.server
     url_helper = URLHelper(server)
@@ -526,4 +527,11 @@ def _gemini_json_to_table(json):
         "release",
         "dec"]
 
+
+@deprecated(since='v0.4.3', alternative='GeminiObservationsClass')
+class ObservationsClass(GeminiObservationsClass):
+    pass
+
+
+GeminiObservations = GeminiObservationsClass()
 Observations = ObservationsClass()

astroquery/gemini/tests/test_gemini.py

@@ -66,14 +66,14 @@ def data_path(filename):
 
 def test_observations_query_region(patch_get):
     """ test query against a region of the sky """
-    result = gemini.Observations.query_region(coords, radius=0.3 * units.deg)
+    result = gemini.GeminiObservations.query_region(coords, radius=0.3 * units.deg)
     assert isinstance(result, Table)
     assert len(result) > 0
 
 
 def test_observations_query_criteria(patch_get):
     """ test query against an instrument/program via criteria """
-    result = gemini.Observations.query_criteria(instrument='GMOS-N', program_id='GN-CAL20191122',
+    result = gemini.GeminiObservations.query_criteria(instrument='GMOS-N', program_id='GN-CAL20191122',
                                                 observation_type='BIAS',
                                                 utc_date=(date(2019, 10, 1), date(2019, 11, 25)))
     assert isinstance(result, Table)
@@ -82,26 +82,26 @@ def test_observations_query_criteria(patch_get):
 
 def test_observations_query_criteria_radius_defaults(patch_get):
     """ test query against an instrument/program via criteria """
-    result = gemini.Observations.query_criteria(instrument='GMOS-N', program_id='GN-CAL20191122',
+    result = gemini.GeminiObservations.query_criteria(instrument='GMOS-N', program_id='GN-CAL20191122',
                                                 observation_type='BIAS')
     global saved_request
     assert(saved_request is not None and 'args' in saved_request and len(saved_request['args']) >= 2)
     assert('/sr=' not in saved_request['args'][1])
     saved_request = None
-    result = gemini.Observations.query_criteria(instrument='GMOS-N', program_id='GN-2016A-Q-9',
+    result = gemini.GeminiObservations.query_criteria(instrument='GMOS-N', program_id='GN-2016A-Q-9',
                                                 observation_type='BIAS', coordinates=coords)
     assert(saved_request is not None and 'args' in saved_request and len(saved_request['args']) >= 2)
     assert('/sr=0.300000d' in saved_request['args'][1])
     saved_request = None
-    result = gemini.Observations.query_criteria(instrument='GMOS-N', program_id='GN-2016A-Q-9',
+    result = gemini.GeminiObservations.query_criteria(instrument='GMOS-N', program_id='GN-2016A-Q-9',
                                                 observation_type='BIAS', objectname='m101')
     assert(saved_request is not None and 'args' in saved_request and len(saved_request['args']) >= 2)
     assert('/sr=0.300000d' in saved_request['args'][1])
 
 
 def test_observations_query_raw(patch_get):
     """ test querying raw """
-    result = gemini.Observations.query_raw('GMOS-N', 'BIAS', progid='GN-CAL20191122')
+    result = gemini.GeminiObservations.query_raw('GMOS-N', 'BIAS', progid='GN-CAL20191122')
     assert isinstance(result, Table)
     assert len(result) > 0
 

astroquery/gemini/tests/test_remote.py

@@ -28,20 +28,20 @@
 class TestGemini:
     def test_observations_query_region(self):
         """ test query against a region of the sky against actual archive """
-        result = gemini.Observations.query_region(coords, radius=0.3 * units.deg)
+        result = gemini.GeminiObservations.query_region(coords, radius=0.3 * units.deg)
         assert isinstance(result, Table)
         assert len(result) > 0
 
     def test_observations_query_criteria(self):
         """ test query against an instrument/program via criteria against actual archive """
-        result = gemini.Observations.query_criteria(instrument='GMOS-N', program_id='GN-CAL20191122',
+        result = gemini.GeminiObservations.query_criteria(instrument='GMOS-N', program_id='GN-CAL20191122',
                                                     observation_type='BIAS')
         assert isinstance(result, Table)
         assert len(result) > 0
 
     def test_observations_query_criteria_ascending_sort(self):
         """ test query against an instrument/program via criteria against actual archive """
-        result = gemini.Observations.query_criteria(instrument='GMOS-N', program_id='GN-CAL20191122',
+        result = gemini.GeminiObservations.query_criteria(instrument='GMOS-N', program_id='GN-CAL20191122',
                                                     observation_type='BIAS', orderby='filename_asc')
         assert isinstance(result, Table)
         assert len(result) > 0
@@ -52,7 +52,7 @@ def test_observations_query_criteria_ascending_sort(self):
 
     def test_observations_query_criteria_descending_sort(self):
         """ test query against an instrument/program via criteria against actual archive """
-        result = gemini.Observations.query_criteria(instrument='GMOS-N', program_id='GN-CAL20191122',
+        result = gemini.GeminiObservations.query_criteria(instrument='GMOS-N', program_id='GN-CAL20191122',
                                                     observation_type='BIAS', orderby='filename_desc')
         assert isinstance(result, Table)
         assert len(result) > 0
@@ -62,15 +62,15 @@ def test_observations_query_criteria_descending_sort(self):
 
     def test_observations_query_raw(self):
         """ test querying raw against actual archive """
-        result = gemini.Observations.query_raw('GMOS-N', 'BIAS', progid='GN-CAL20191122')
+        result = gemini.GeminiObservations.query_raw('GMOS-N', 'BIAS', progid='GN-CAL20191122')
         assert isinstance(result, Table)
         assert len(result) > 0
 
     def test_get_file(self):
         """ test querying raw against actual archive """
         tempdir = tempfile.mkdtemp('_gemini_test')
         filename = '20190105_GN-CAL20190105_obslog.txt'
-        gemini.Observations.get_file(filename, download_dir=tempdir)
+        gemini.GeminiObservations.get_file(filename, download_dir=tempdir)
         filepath = os.path.join(tempdir, filename)
         assert os.path.isfile(filepath)
         assert os.stat(filepath).st_size == 7624

astroquery/mast/__init__.py

@@ -31,13 +31,13 @@ class Conf(_config.ConfigNamespace):
 conf = Conf()
 
 from .cutouts import TesscutClass, Tesscut, ZcutClass, Zcut
-from .observations import Observations, ObservationsClass, MastClass, Mast
+from .observations import MastObservations, MastObservationsClass, MastClass, Mast
 from .collections import Catalogs, CatalogsClass
 from .missions import MastMissions, MastMissionsClass
 from .core import MastQueryWithLogin
 from . import utils
 
-__all__ = ['Observations', 'ObservationsClass',
+__all__ = ['MastObservations', 'MastObservationsClass',
            'Catalogs', 'CatalogsClass',
            'MastMissions', 'MastMissionsClass',
            'Mast', 'MastClass',

astroquery/mast/observations.py

@@ -1,7 +1,7 @@
 # Licensed under a 3-clause BSD style license - see LICENSE.rst
 """
-MAST Observations
-=================
+MAST MastObservations
+=====================
 
 This module contains various methods for querying MAST observations.
 """
@@ -37,14 +37,14 @@
 from . import conf, utils
 from .core import MastQueryWithLogin
 
-__all__ = ['Observations', 'ObservationsClass',
+__all__ = ['MastObservations', 'MastObservationsClass',
            'MastClass', 'Mast']
 
 
 @async_to_sync
-class ObservationsClass(MastQueryWithLogin):
+class MastObservationsClass(MastQueryWithLogin):
     """
-    MAST Observations query class.
+    MAST MastObservations query class.
 
     Class for querying MAST observational data.
     """
@@ -173,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 ObservationsClass._caom_filtered_position
+            # build the coordinates string needed by MastObservationsClass._caom_filtered_position
             position = ', '.join([str(x) for x in (coordinates.ra.deg, coordinates.dec.deg, radius.deg)])
 
         return position, mashup_filters
@@ -327,7 +327,7 @@ def query_region_count(self, coordinates, *, radius=0.2*u.deg, pagesize=None, pa
         response : int
         """
 
-        # build the coordinates string needed by ObservationsClass._caom_filtered_position
+        # build the coordinates string needed by MastObservationsClass._caom_filtered_position
         coordinates = commons.parse_coordinates(coordinates)
 
         # if radius is just a number we assume degrees
@@ -807,7 +807,7 @@ class MastClass(MastQueryWithLogin):
     MAST query class.
 
     Class that allows direct programatic access to the MAST Portal,
-    more flexible but less user friendly than `ObservationsClass`.
+    more flexible but less user friendly than `MastObservationsClass`.
     """
 
     def _parse_result(self, responses, *, verbose=False):  # Used by the async_to_sync decorator functionality
@@ -864,5 +864,5 @@ def service_request_async(self, service, params, *, pagesize=None, page=None, **
         return self._portal_api_connection.service_request_async(service, params, pagesize, page, **kwargs)
 
 
-Observations = ObservationsClass()
+MastObservations = MastObservationsClass()
 Mast = MastClass()