Merge pull request #2389 from bsipocz/pyvo_usage_cleanup

MNT: cleanup deprecations and obsolte checks

Author: bsipocz

CHANGES.rst

@@ -13,6 +13,11 @@ hsa
 Service fixes and enhancements
 ------------------------------
 
+cadc
+^^^^
+
+- Deprecated keywords and ``run_query`` method have been removed. [#2389]
+
 casda
 ^^^^^
 

astroquery/cadc/core.py

@@ -21,19 +21,11 @@
 from astropy.utils.exceptions import AstropyDeprecationWarning
 from astropy.utils.decorators import deprecated
 from astropy import units as u
+import pyvo
+from pyvo.auth import authsession
+
 from . import conf
 
-try:
-    import pyvo
-    from pyvo.auth import authsession
-except ImportError:
-    print('Please install pyvo. astropy.cadc does not work without it.')
-except AstropyDeprecationWarning as e:
-    if str(e) == 'The astropy.vo.samp module has now been moved to astropy.samp':
-        # CADC does not use samp and this only affects Python 2.7
-        print('AstropyDeprecationWarning: {}'.format(str(e)))
-    else:
-        raise e
 
 __all__ = ['Cadc', 'CadcClass']
 
@@ -78,17 +70,14 @@ class CadcClass(BaseQuery):
     CADCLOGIN_SERVICE_URI = conf.CADCLOGIN_SERVICE_URI
     TIMEOUT = conf.TIMEOUT
 
-    def __init__(self, url=None, tap_plus_handler=None, verbose=None,
-                 auth_session=None):
+    def __init__(self, url=None, auth_session=None):
         """
         Initialize Cadc object
 
         Parameters
         ----------
         url : str, optional, default 'None;
             a url to use instead of the default
-        tap_plus_handler : deprecated
-        verbose : deprecated
         auth_session: `requests.Session` or `pyvo.auth.authsession.AuthSession`
             A existing authenticated session containing the appropriate
             credentials to be used by the client to communicate with the
@@ -98,10 +87,6 @@ def __init__(self, url=None, tap_plus_handler=None, verbose=None,
         -------
         Cadc object
         """
-        if tap_plus_handler:
-            raise AttributeError('tap handler no longer supported')
-        if verbose is not None:
-            warnings.warn('verbose deprecated since version 0.4.0')
 
         super(CadcClass, self).__init__()
         self.baseurl = url
@@ -210,19 +195,12 @@ def login(self, user=None, password=None, certificate_file=None):
                     self.cadctap._session.cookies.set(
                         CADC_COOKIE_PREFIX, cookie)
 
-    def logout(self, verbose=None):
+    def logout(self):
         """
         Logout. Anonymous access with all the subsequent use of the
         object. Note that the original session is not affected (in case
         it was passed when the object was first instantiated)
-
-        Parameters
-        ----------
-        verbose : deprecated
-
         """
-        if verbose is not None:
-            warnings.warn('verbose deprecated since 0.4.0')
 
         if isinstance(self._auth_session, pyvo.auth.AuthSession):
             # Remove the existing credentials (if any)
@@ -561,44 +539,38 @@ def get_data_urls(self, query_result, include_auxiliaries=False):
                 result.append(service_def.access_url)
         return result
 
-    def get_tables(self, only_names=False, verbose=None):
+    def get_tables(self, only_names=False):
         """
         Gets all public tables
 
         Parameters
         ----------
         only_names : bool, optional, default False
             True to load table names only
-        verbose : deprecated
 
         Returns
         -------
         A list of table objects
         """
-        if verbose is not None:
-            warnings.warn('verbose deprecated since 0.4.0')
         table_set = self.cadctap.tables
         if only_names:
             return list(table_set.keys())
         else:
             return list(table_set.values())
 
-    def get_table(self, table, verbose=None):
+    def get_table(self, table):
         """
         Gets the specified table
 
         Parameters
         ----------
         table : str, mandatory
             full qualified table name (i.e. schema name + table name)
-        verbose : deprecated
 
         Returns
         -------
         A table object
         """
-        if verbose is not None:
-            warnings.warn('verbose deprecated since 0.4.0')
         tables = self.get_tables()
         for t in tables:
             if table == t.name:
@@ -683,67 +655,25 @@ def create_async(self, query, maxrec=None, uploads=None):
         return self.cadctap.submit_job(query, language='ADQL',
                                        uploads=uploads)
 
-    @deprecated('0.4.0', 'Use exec_sync or create_async instead')
-    def run_query(self, query, operation, output_file=None,
-                  output_format="votable", verbose=None,
-                  background=False, upload_resource=None,
-                  upload_table_name=None):
-        """
-        Runs a query
-
-        Parameters
-        ----------
-        query : str, mandatory
-            query to be executed
-        operation : str, mandatory,
-            'sync' or 'async' to run a synchronous or asynchronous job
-        output_file : str, optional, default None
-            file name where the results are saved if dumpToFile is True.
-            If this parameter is not provided, the jobid is used instead
-        output_format : str, optional, default 'votable'
-            results format, 'csv', 'tsv' and 'votable'
-        verbose : deprecated
-        save_to_file : bool, optional, default 'False'
-            if True, the results are saved in a file instead of using memory
-        background : bool, optional, default 'False'
-            when the job is executed in asynchronous mode,
-            this flag specifies whether the execution will wait until results
-            are available
-        upload_resource : str, optional, default None
-            resource to be uploaded to UPLOAD_SCHEMA
-        upload_table_name : str, required if uploadResource is provided,
-            default None
-            resource temporary table name associated to the uploaded resource
-
-        Returns
-        -------
-        A Job object
-        """
-        raise NotImplementedError('No longer supported. '
-                                  'Use exec_sync or create_async instead.')
-
-    def load_async_job(self, jobid, verbose=None):
+    def load_async_job(self, jobid):
         """
         Loads an asynchronous job
 
         Parameters
         ----------
         jobid : str, mandatory
             job identifier
-        verbose : deprecated
 
         Returns
         -------
         A Job object
         """
-        if verbose is not None:
-            warnings.warn('verbose deprecated since 0.4.0')
 
         return pyvo.dal.AsyncTAPJob('{}/async/{}'.format(
             self.cadctap.baseurl, jobid), session=self._auth_session)
 
     def list_async_jobs(self, phases=None, after=None, last=None,
-                        short_description=True, verbose=None):
+                        short_description=True):
         """
         Returns all the asynchronous jobs
 
@@ -760,14 +690,11 @@ def list_async_jobs(self, phases=None, after=None, last=None,
             corresponding to the TAP ShortJobDescription object (job ID, phase,
             run ID, owner ID and creation ID) whereas if False, a separate GET
             call to each job is performed for the complete job description
-        verbose : deprecated
 
         Returns
         -------
         A list of Job objects
         """
-        if verbose is not None:
-            warnings.warn('verbose deprecated since 0.4.0')
 
         return self.cadctap.get_job_list(phases=phases, after=after, last=last,
                                          short_description=short_description)

astroquery/cadc/tests/test_cadctap.py

@@ -16,28 +16,15 @@
 from astropy.io.votable import parse
 from astroquery.utils.commons import parse_coordinates, FileContainer
 from astropy import units as u
-from astropy.utils.exceptions import AstropyDeprecationWarning
 import pytest
 import tempfile
 import requests
-try:
-    pyvo_OK = True
-    from pyvo.auth import authsession, securitymethods
-    from astroquery.cadc import Cadc, conf
-    import astroquery.cadc.core as cadc_core
-except ImportError:
-    pyvo_OK = False
-    pytest.skip("Install pyvo for the cadc module.", allow_module_level=True)
-except AstropyDeprecationWarning as ex:
-    if str(ex) == \
-            'The astropy.vo.samp module has now been moved to astropy.samp':
-        print('AstropyDeprecationWarning: {}'.format(str(ex)))
-    else:
-        raise ex
-try:
-    from unittest.mock import Mock, patch, PropertyMock
-except ImportError:
-    pytest.skip("Install mock for the cadc tests.", allow_module_level=True)
+
+from pyvo.auth import securitymethods
+from astroquery.cadc import Cadc, conf
+import astroquery.cadc.core as cadc_core
+
+from unittest.mock import Mock, patch, PropertyMock
 
 
 def data_path(filename):
@@ -47,7 +34,6 @@ def data_path(filename):
 
 @patch('astroquery.cadc.core.get_access_url',
        Mock(side_effect=lambda x: 'https://some.url'))
-@pytest.mark.skipif(not pyvo_OK, reason='not pyvo_OK')
 def test_get_tables():
     # default parameters
     table_set = PropertyMock()
@@ -62,7 +48,6 @@ def test_get_tables():
 
 @patch('astroquery.cadc.core.get_access_url',
        Mock(side_effect=lambda x: 'https://some.url'))
-@pytest.mark.skipif(not pyvo_OK, reason='not pyvo_OK')
 def test_get_table():
     table_set = PropertyMock()
     tables_result = [Mock() for _ in range(3)]
@@ -80,7 +65,6 @@ def test_get_table():
 
 @patch('astroquery.cadc.core.get_access_url',
        Mock(side_effect=lambda x: 'https://some.url'))
-@pytest.mark.skipif(not pyvo_OK, reason='not pyvo_OK')
 def test_get_collections():
     cadc = Cadc()
 
@@ -106,7 +90,6 @@ def mock_run_query(query, output_format=None, maxrec=None,
 
 @patch('astroquery.cadc.core.get_access_url',
        Mock(side_effect=lambda x: 'https://some.url'))
-@pytest.mark.skipif(not pyvo_OK, reason='not pyvo_OK')
 def test_load_async_job():
     with patch('astroquery.cadc.core.pyvo.dal.TAPService', autospec=True) as tapservice_mock:
         with patch('astroquery.cadc.core.pyvo.dal.AsyncTAPJob',
@@ -124,7 +107,6 @@ def test_load_async_job():
 @pytest.mark.skip('Disabled until job listing available in pyvo')
 @patch('astroquery.cadc.core.get_access_url',
        Mock(side_effect=lambda x: 'https://some.url'))
-@pytest.mark.skipif(not pyvo_OK, reason='not pyvo_OK')
 def test_list_async_jobs():
     with patch('astroquery.cadc.core.pyvo.dal.TAPService', autospec=True) as tapservice_mock:
         tapservice_mock.return_value.baseurl.return_value = 'https://www.example.com/tap'
@@ -136,7 +118,6 @@ def test_list_async_jobs():
        Mock(side_effect=lambda x, y=None: 'https://some.url'))
 @patch('astroquery.cadc.core.pyvo.dal.TAPService.capabilities', [])  # TAP capabilities not needed
 @patch('astroquery.cadc.core.pyvo.dal.adhoc.DatalinkService.capabilities', [])  # DL capabilities not needed
-@pytest.mark.skipif(not pyvo_OK, reason='not pyvo_OK')
 def test_auth():
     # the Cadc() will cause a remote data call to TAP service capabilities
     # To avoid this, use an anonymous session and replace it with an
@@ -183,7 +164,6 @@ def test_auth():
 
 # make sure that caps is reset at the end of the test
 @patch('astroquery.cadc.core.get_access_url.caps', {})
-@pytest.mark.skipif(not pyvo_OK, reason='not pyvo_OK')
 def test_get_access_url():
     # testing implementation of requests.get method:
     def get(url, **kwargs):
@@ -219,7 +199,6 @@ def raise_for_status(self):
        Mock(side_effect=lambda x, y=None: 'https://some.url'))
 @patch('astroquery.cadc.core.pyvo.dal.adhoc.DatalinkService',
        Mock(return_value=Mock(capabilities=[])))  # DL capabilities not needed
-@pytest.mark.skipif(not pyvo_OK, reason='not pyvo_OK')
 def test_get_data_urls():
 
     def get(*args, **kwargs):
@@ -268,7 +247,6 @@ class Result:
 
 @patch('astroquery.cadc.core.get_access_url',
        Mock(side_effect=lambda x, y=None: 'https://some.url'))
-@pytest.mark.skipif(not pyvo_OK, reason='not pyvo_OK')
 def test_misc():
     cadc = Cadc()
 
@@ -302,7 +280,6 @@ def test_misc():
        Mock(return_value=Mock(capabilities=[])))  # TAP capabilities not needed
 @patch('astroquery.cadc.core.pyvo.dal.adhoc.DatalinkService',
        Mock(return_value=Mock(capabilities=[])))  # DL capabilities not needed
-@pytest.mark.skipif(not pyvo_OK, reason='not pyvo_OK')
 def test_get_image_list():
     def get(*args, **kwargs):
         class CapsResponse:
@@ -370,7 +347,6 @@ def __init__(self, **param_dict):
 
 @patch('astroquery.cadc.core.get_access_url',
        Mock(side_effect=lambda x, y=None: 'https://some.url'))
-@pytest.mark.skipif(not pyvo_OK, reason='not pyvo_OK')
 def test_exec_sync():
     # save results in a file
     # create the VOTable result
@@ -411,7 +387,6 @@ def test_exec_sync():
 @patch('astroquery.cadc.core.CadcClass.exec_sync', Mock())
 @patch('astroquery.cadc.core.CadcClass.get_image_list',
        Mock(side_effect=lambda x, y, z: ['https://some.url']))
-@pytest.mark.skipif(not pyvo_OK, reason='not pyvo_OK')
 def test_get_images():
     with patch('astroquery.utils.commons.get_readable_fileobj', autospec=True) as readable_fobj_mock:
         readable_fobj_mock.return_value = open(data_path('query_images.fits'), 'rb')
@@ -429,7 +404,6 @@ def test_get_images():
 @patch('astroquery.cadc.core.CadcClass.exec_sync', Mock())
 @patch('astroquery.cadc.core.CadcClass.get_image_list',
        Mock(side_effect=lambda x, y, z: ['https://some.url']))
-@pytest.mark.skipif(not pyvo_OK, reason='not pyvo_OK')
 def test_get_images_async():
     with patch('astroquery.utils.commons.get_readable_fileobj', autospec=True) as readable_fobj_mock:
         readable_fobj_mock.return_value = open(data_path('query_images.fits'), 'rb')