Merge pull request #2131 from bsipocz/ipac_namespace

New ipac namespace to restructure modules

Author: bsipocz

astroquery/ibe/__init__.py

@@ -1,45 +1,9 @@
 # Licensed under a 3-clause BSD style license - see LICENSE.rst
-"""
-IRSA Image Server program interface (IBE) Query Tool
-====================================================
 
-This module contains various methods for querying the
-IRSA Image Server program interface (IBE).
-"""
-from astropy import config as _config
 
+import warnings
 
-class Conf(_config.ConfigNamespace):
-    """
-    Configuration parameters for `astroquery.ibe`.
-    """
+warnings.warn("the ``ibe`` module has been moved to astroquery.ipac.irsa.ibe, "
+              "please update your imports.", DeprecationWarning, stacklevel=2)
 
-    server = _config.ConfigItem(
-        'https://irsa.ipac.caltech.edu/ibe/',
-        'Name of the IBE server to use.')
-    mission = _config.ConfigItem(
-        'ptf',
-        ('Default mission. See, for example, '
-         'https://irsa.ipac.caltech.edu/ibe/search/ for options.'))
-
-    dataset = _config.ConfigItem(
-        'images',
-        ('Default data set. See, for example, '
-         'https://irsa.ipac.caltech.edu/ibe/search/ptf for options.'))
-    table = _config.ConfigItem(
-        'level1',
-        ('Default table. See, for example, '
-         'https://irsa.ipac.caltech.edu/ibe/search/ptf/images for options.'))
-    timeout = _config.ConfigItem(
-        120,
-        'Time limit for connecting to the IRSA server.')
-
-
-conf = Conf()
-
-
-from .core import Ibe, IbeClass
-
-__all__ = ['Ibe', 'IbeClass',
-           'Conf', 'conf',
-           ]
+from astroquery.ipac.irsa.ibe import *

astroquery/ibe/tests/__init__.py renamed to astroquery/ipac/__init__.py

@@ -0,0 +1,38 @@
+# Licensed under a 3-clause BSD style license - see LICENSE.rst
+"""
+IRSA Query Tool
+===============
+
+This module contains various methods for querying the
+IRSA Catalog Query Service(CatQuery).
+"""
+from astropy import config as _config
+
+
+class Conf(_config.ConfigNamespace):
+    """
+    Configuration parameters for `astroquery.ipac.irsa`.
+    """
+
+    server = _config.ConfigItem(
+        'https://irsa.ipac.caltech.edu/cgi-bin/Gator/nph-query',
+        'Name of the IRSA mirror to use.')
+    gator_list_catalogs = _config.ConfigItem(
+        'https://irsa.ipac.caltech.edu/cgi-bin/Gator/nph-scan',
+        'URL from which to list all the public catalogs in IRSA.')
+    row_limit = _config.ConfigItem(
+        500,
+        'Maximum number of rows to retrieve in result')
+    timeout = _config.ConfigItem(
+        60,
+        'Time limit for connecting to the IRSA server.')
+
+
+conf = Conf()
+
+
+from .core import Irsa, IrsaClass
+
+__all__ = ['Irsa', 'IrsaClass',
+           'Conf', 'conf',
+           ]

astroquery/ipac/irsa/__init__.py

@@ -109,7 +109,7 @@
 
 from astroquery.query import BaseQuery
 from astroquery.utils import commons, async_to_sync
-from astroquery.irsa import conf
+from astroquery.ipac.irsa import conf
 from astroquery.exceptions import TableParseError, NoResultsWarning, InvalidQueryError
 
 
@@ -129,7 +129,7 @@ def query_region_async(self, coordinates=None, *, catalog=None,
                            selcols=None, verbose=False, cache=True):
         """
         This function serves the same purpose as
-        :meth:`~astroquery.irsa.IrsaClass.query_region`, but returns the raw
+        :meth:`~astroquery.ipac.irsa.IrsaClass.query_region`, but returns the raw
         HTTP response rather than the results in a `~astropy.table.Table`.
 
         Parameters
@@ -144,7 +144,7 @@ def query_region_async(self, coordinates=None, *, catalog=None,
             if spatial is ``'Polygon'``.
         catalog : str
             The catalog to be used. To list the available catalogs, use
-            :meth:`~astroquery.irsa.IrsaClass.print_catalogs`.
+            :meth:`~astroquery.ipac.irsa.IrsaClass.print_catalogs`.
         spatial : str
             Type of spatial query: ``'Cone'``, ``'Box'``, ``'Polygon'``, and
             ``'All-Sky'``. If missing then defaults to ``'Cone'``.

astroquery/irsa/core.py renamed to astroquery/ipac/irsa/core.py

@@ -0,0 +1,45 @@
+# Licensed under a 3-clause BSD style license - see LICENSE.rst
+"""
+IRSA Image Server program interface (IBE) Query Tool
+====================================================
+
+This module contains various methods for querying the
+IRSA Image Server program interface (IBE).
+"""
+from astropy import config as _config
+
+
+class Conf(_config.ConfigNamespace):
+    """
+    Configuration parameters for `astroquery.ipac.irsa.ibe`.
+    """
+
+    server = _config.ConfigItem(
+        'https://irsa.ipac.caltech.edu/ibe/',
+        'Name of the IBE server to use.')
+    mission = _config.ConfigItem(
+        'ptf',
+        ('Default mission. See, for example, '
+         'https://irsa.ipac.caltech.edu/ibe/search/ for options.'))
+
+    dataset = _config.ConfigItem(
+        'images',
+        ('Default data set. See, for example, '
+         'https://irsa.ipac.caltech.edu/ibe/search/ptf for options.'))
+    table = _config.ConfigItem(
+        'level1',
+        ('Default table. See, for example, '
+         'https://irsa.ipac.caltech.edu/ibe/search/ptf/images for options.'))
+    timeout = _config.ConfigItem(
+        120,
+        'Time limit for connecting to the IRSA server.')
+
+
+conf = Conf()
+
+
+from .core import Ibe, IbeClass
+
+__all__ = ['Ibe', 'IbeClass',
+           'Conf', 'conf',
+           ]

astroquery/ipac/irsa/ibe/__init__.py

@@ -15,12 +15,11 @@
 
 import astropy.coordinates as coord
 from astropy.table import Table
-import six
 
-from ..exceptions import InvalidQueryError
-from ..query import BaseQuery
-from ..utils import commons
-from . import conf
+from astroquery.exceptions import InvalidQueryError
+from astroquery.query import BaseQuery
+from astroquery.utils import commons
+from astroquery.ipac.irsa.ibe import conf
 
 __all__ = ['Ibe', 'IbeClass']
 
@@ -32,10 +31,9 @@ class IbeClass(BaseQuery):
     TABLE = conf.table
     TIMEOUT = conf.timeout
 
-    def query_region(
-            self, coordinate=None, where=None, mission=None, dataset=None,
-            table=None, columns=None, width=None, height=None,
-            intersect='OVERLAPS', most_centered=False):
+    def query_region(self, coordinate=None, where=None, mission=None, dataset=None,
+                     table=None, columns=None, width=None, height=None,
+                     intersect='OVERLAPS', most_centered=False):
         """
         For certain missions, this function can be used to search for image and
         catalog files based on a point, a box (bounded by great circles) and/or
@@ -129,11 +127,9 @@ def query_region_sia(self, coordinate=None, mission=None,
         return commons.parse_votable(
             response.text).get_first_table().to_table()
 
-    def query_region_async(
-            self, coordinate=None, where=None, mission=None, dataset=None,
-            table=None, columns=None, width=None, height=None,
-            action='search',
-            intersect='OVERLAPS', most_centered=False):
+    def query_region_async(self, coordinate=None, where=None, mission=None, dataset=None,
+                           table=None, columns=None, width=None, height=None,
+                           action='search', intersect='OVERLAPS', most_centered=False):
         """
         For certain missions, this function can be used to search for image and
         catalog files based on a point, a box (bounded by great circles) and/or
@@ -243,7 +239,7 @@ def query_region_async(
             args['where'] = where
 
         if columns:
-            if isinstance(columns, six.string_types):
+            if isinstance(columns, str):
                 columns = columns.split()
             args['columns'] = ','.join(columns)
 
@@ -291,7 +287,7 @@ def list_datasets(self, mission=None, cache=True):
         ----------
         mission : str
             A mission name.  Must be one of the valid missions from
-            `~astroquery.ibe.IbeClass.list_missions`.  Defaults to the
+            `~astroquery.ipac.irsa.ibe.IbeClass.list_missions`.  Defaults to the
             configured Mission
         cache : bool
             Cache the query result
@@ -323,9 +319,9 @@ def list_datasets(self, mission=None, cache=True):
     def list_tables(self, mission=None, dataset=None, cache=True):
         """
         For a given mission and dataset (see
-        `~.astroquery.ibe.IbeClass.list_missions`,
-        `~astroquery.ibe.IbeClass.list_datasets`), return the list of valid
-        table names to query.
+        `~.astroquery.ipac.irsa.ibe.IbeClass.list_missions`,
+        `~astroquery.ipac.irsa.ibe.IbeClass.list_datasets`),
+        returns the list of valid table names to query.
 
         Parameters
         ----------