diff --git a/CHANGES.rst b/CHANGES.rst index a6da861b74..76f9eef620 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -33,6 +33,16 @@ mast - Expand the supported data types for filter values in ``Mast.mast_query``. Previously, users had to input filter values enclosed in lists, even when specifying a single value or dictionary. [#3422] +jplspec +^^^^^^^ + +- Moved to linelists/. astroquery.jplspec is now deprecated in favor of astroquery.linelists.jplspec [#3455] + +linelists.jplspec +^^^^^^^^^^^^^^^^^ + +- New location for jplspec. astroquery.jplspec is now deprecated in favor of astroquery.linelists.jplspec [#3455] + Infrastructure, Utility and Other Changes and Additions ------------------------------------------------------- diff --git a/astroquery/jplspec/__init__.py b/astroquery/jplspec/__init__.py index 8f87702481..1ab0e72d1c 100644 --- a/astroquery/jplspec/__init__.py +++ b/astroquery/jplspec/__init__.py @@ -1,33 +1,33 @@ # Licensed under a 3-clause BSD style license - see LICENSE.rst """ -JPL Spectral Catalog --------------------- +JPL Spectral Catalog (Deprecated Location) +------------------------------------------- +.. deprecated:: 0.4.12 + The `astroquery.jplspec` module has been moved to `astroquery.linelists.jplspec`. + Please update your imports to use `from astroquery.linelists.jplspec import JPLSpec` instead. + This backward compatibility layer will be removed in a future version. -:author: Giannina Guzman (gguzman2@villanova.edu) -:author: Miguel de Val-Borro (miguel.deval@gmail.com) - -""" -from astropy import config as _config +This module provides backward compatibility for the old import location. +The JPLSpec module has been reorganized under the linelists subpackage. +For new code, please use:: -class Conf(_config.ConfigNamespace): - """ - Configuration parameters for `astroquery.jplspec`. - """ - server = _config.ConfigItem( - 'https://spec.jpl.nasa.gov/cgi-bin/catform', - 'JPL Spectral Catalog URL.') - - timeout = _config.ConfigItem( - 60, - 'Time limit for connecting to JPL server.') + from astroquery.linelists.jplspec import JPLSpec +""" +import warnings -conf = Conf() +# Issue deprecation warning +warnings.warn( + "Importing from 'astroquery.jplspec' is deprecated. " + "Please use 'from astroquery.linelists.jplspec import JPLSpec' instead. " + "The old import path will be removed in a future version.", + DeprecationWarning, + stacklevel=2 +) -from .core import JPLSpec, JPLSpecClass +# Import from the new location +from ..linelists.jplspec import JPLSpec, JPLSpecClass, Conf, conf -__all__ = ['JPLSpec', 'JPLSpecClass', - 'Conf', 'conf', - ] +__all__ = ['JPLSpec', 'JPLSpecClass', 'Conf', 'conf'] diff --git a/astroquery/linelists/jplspec/__init__.py b/astroquery/linelists/jplspec/__init__.py new file mode 100644 index 0000000000..71aedd7259 --- /dev/null +++ b/astroquery/linelists/jplspec/__init__.py @@ -0,0 +1,28 @@ +# Licensed under a 3-clause BSD style license - see LICENSE.rst +""" +JPL Spectral Catalog +-------------------- +""" +from astropy import config as _config + + +class Conf(_config.ConfigNamespace): + """ + Configuration parameters for `astroquery.linelists.jplspec`. + """ + server = _config.ConfigItem( + 'https://spec.jpl.nasa.gov/cgi-bin/catform', + 'JPL Spectral Catalog URL.') + + timeout = _config.ConfigItem( + 60, + 'Time limit for connecting to JPL server.') + + +conf = Conf() + +from .core import JPLSpec, JPLSpecClass + +__all__ = ['JPLSpec', 'JPLSpecClass', + 'Conf', 'conf', + ] diff --git a/astroquery/jplspec/core.py b/astroquery/linelists/jplspec/core.py similarity index 98% rename from astroquery/jplspec/core.py rename to astroquery/linelists/jplspec/core.py index 1f72ca580b..58287680ec 100644 --- a/astroquery/jplspec/core.py +++ b/astroquery/linelists/jplspec/core.py @@ -4,11 +4,10 @@ import astropy.units as u from astropy.io import ascii -from ..query import BaseQuery -from ..utils import async_to_sync +from astroquery.query import BaseQuery +from astroquery.utils import async_to_sync # import configurable items declared in __init__.py -from . import conf -from . import lookup_table +from astroquery.linelists.jplspec import conf, lookup_table from astroquery.exceptions import EmptyResponseError, InvalidQueryError diff --git a/astroquery/jplspec/data/catdir.cat b/astroquery/linelists/jplspec/data/catdir.cat similarity index 100% rename from astroquery/jplspec/data/catdir.cat rename to astroquery/linelists/jplspec/data/catdir.cat diff --git a/astroquery/jplspec/lookup_table.py b/astroquery/linelists/jplspec/lookup_table.py similarity index 100% rename from astroquery/jplspec/lookup_table.py rename to astroquery/linelists/jplspec/lookup_table.py diff --git a/astroquery/jplspec/setup_package.py b/astroquery/linelists/jplspec/setup_package.py similarity index 72% rename from astroquery/jplspec/setup_package.py rename to astroquery/linelists/jplspec/setup_package.py index 761f2f6829..585e27fa4b 100644 --- a/astroquery/jplspec/setup_package.py +++ b/astroquery/linelists/jplspec/setup_package.py @@ -11,5 +11,5 @@ def get_package_data(): os.path.join('data', 'multi.data')] paths_data = [os.path.join('data', 'catdir.cat')] - return {'astroquery.jplspec.tests': paths_test, - 'astroquery.jplspec': paths_data, } + return {'astroquery.linelists.jplspec.tests': paths_test, + 'astroquery.linelists.jplspec': paths_data, } diff --git a/astroquery/jplspec/tests/__init__.py b/astroquery/linelists/jplspec/tests/__init__.py similarity index 100% rename from astroquery/jplspec/tests/__init__.py rename to astroquery/linelists/jplspec/tests/__init__.py diff --git a/astroquery/jplspec/tests/data/CO.data b/astroquery/linelists/jplspec/tests/data/CO.data similarity index 100% rename from astroquery/jplspec/tests/data/CO.data rename to astroquery/linelists/jplspec/tests/data/CO.data diff --git a/astroquery/jplspec/tests/data/CO_6.data b/astroquery/linelists/jplspec/tests/data/CO_6.data similarity index 100% rename from astroquery/jplspec/tests/data/CO_6.data rename to astroquery/linelists/jplspec/tests/data/CO_6.data diff --git a/astroquery/jplspec/tests/data/multi.data b/astroquery/linelists/jplspec/tests/data/multi.data similarity index 100% rename from astroquery/jplspec/tests/data/multi.data rename to astroquery/linelists/jplspec/tests/data/multi.data diff --git a/astroquery/jplspec/tests/test_jplspec.py b/astroquery/linelists/jplspec/tests/test_jplspec.py similarity index 98% rename from astroquery/jplspec/tests/test_jplspec.py rename to astroquery/linelists/jplspec/tests/test_jplspec.py index b11c15b8a5..623c995e6d 100644 --- a/astroquery/jplspec/tests/test_jplspec.py +++ b/astroquery/linelists/jplspec/tests/test_jplspec.py @@ -4,7 +4,7 @@ from astropy import units as u from astropy.table import Table -from ...jplspec import JPLSpec +from astroquery.linelists.jplspec import JPLSpec file1 = 'CO.data' file2 = 'CO_6.data' diff --git a/astroquery/jplspec/tests/test_jplspec_remote.py b/astroquery/linelists/jplspec/tests/test_jplspec_remote.py similarity index 96% rename from astroquery/jplspec/tests/test_jplspec_remote.py rename to astroquery/linelists/jplspec/tests/test_jplspec_remote.py index 0f60e2b4fa..fc9f612be0 100644 --- a/astroquery/jplspec/tests/test_jplspec_remote.py +++ b/astroquery/linelists/jplspec/tests/test_jplspec_remote.py @@ -2,7 +2,7 @@ from astropy import units as u from astropy.table import Table -from ...jplspec import JPLSpec +from astroquery.linelists.jplspec import JPLSpec @pytest.mark.remote_data diff --git a/docs/index.rst b/docs/index.rst index baef40b2a3..64c3d35f66 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -276,7 +276,7 @@ The following modules have been completed using a common API: ipac/irsa/irsa_dust/irsa_dust.rst ipac/irsa/ibe/ibe.rst ipac/irsa/irsa.rst - jplspec/jplspec.rst + linelists/jplspec/jplspec.rst magpis/magpis.rst mast/mast.rst mocserver/mocserver.rst @@ -412,7 +412,7 @@ well as cross section and collision rates. Those services are: atomic/atomic.rst linelists/cdms/cdms.rst hitran/hitran.rst - jplspec/jplspec.rst + linelists/jplspec/jplspec.rst lamda/lamda.rst nist/nist.rst splatalogue/splatalogue.rst diff --git a/docs/jplspec/images/docplot_curvefit.png b/docs/linelists/jplspec/images/docplot_curvefit.png similarity index 100% rename from docs/jplspec/images/docplot_curvefit.png rename to docs/linelists/jplspec/images/docplot_curvefit.png diff --git a/docs/jplspec/images/docplot_jplspec.png b/docs/linelists/jplspec/images/docplot_jplspec.png similarity index 100% rename from docs/jplspec/images/docplot_jplspec.png rename to docs/linelists/jplspec/images/docplot_jplspec.png diff --git a/docs/jplspec/jplspec.rst b/docs/linelists/jplspec/jplspec.rst similarity index 96% rename from docs/jplspec/jplspec.rst rename to docs/linelists/jplspec/jplspec.rst index e60ea06e82..9e8a233a1b 100644 --- a/docs/jplspec/jplspec.rst +++ b/docs/linelists/jplspec/jplspec.rst @@ -1,8 +1,8 @@ -.. _astroquery.jplspec: +.. _astroquery.linelists.jplspec: -********************************************* -JPL Spectroscopy Queries (astroquery.jplspec) -********************************************* +******************************************************* +JPL Spectroscopy Queries (astroquery.linelists.jplspec) +******************************************************* Getting Started =============== @@ -26,7 +26,7 @@ what each setting yields: .. doctest-remote-data:: - >>> from astroquery.jplspec import JPLSpec + >>> from astroquery.linelists.jplspec import JPLSpec >>> import astropy.units as u >>> response = JPLSpec.query_lines(min_frequency=100 * u.GHz, ... max_frequency=1000 * u.GHz, @@ -120,7 +120,7 @@ the line frequency has been measured in the laboratory .. doctest-remote-data:: >>> import matplotlib.pyplot as plt - >>> from astroquery.jplspec import JPLSpec + >>> from astroquery.linelists.jplspec import JPLSpec >>> result = JPLSpec.get_species_table() >>> mol = result[result['TAG'] == 28001] #do not include signs of TAG for this >>> print(mol) @@ -210,7 +210,7 @@ to query these directly. .. doctest-remote-data:: - >>> from astroquery.jplspec import JPLSpec + >>> from astroquery.linelists.jplspec import JPLSpec >>> import astropy.units as u >>> result = JPLSpec.query_lines(min_frequency=100 * u.GHz, ... max_frequency=1000 * u.GHz, @@ -314,7 +314,7 @@ If you are repeatedly getting failed queries, or bad/out-of-date results, try cl .. code-block:: python - >>> from astroquery.jplspec import JPLSpec + >>> from astroquery.linelists.jplspec import JPLSpec >>> JPLSpec.clear_cache() If this function is unavailable, upgrade your version of astroquery. @@ -324,5 +324,5 @@ The ``clear_cache`` function was introduced in version 0.4.7.dev8479. Reference/API ============= -.. automodapi:: astroquery.jplspec +.. automodapi:: astroquery.linelists.jplspec :no-inheritance-diagram: diff --git a/setup.cfg b/setup.cfg index 1b93d76267..b00172e24e 100644 --- a/setup.cfg +++ b/setup.cfg @@ -52,6 +52,8 @@ filterwarnings = # Remove along with astropy-helpers, once we switch to a new versioning scheme ignore:Use setlocale:DeprecationWarning ignore: 'locale.getdefaultlocale' is deprecated and slated for removal:DeprecationWarning +# Ignore astroquery's own module reorganization deprecation warnings during testing + ignore:Importing from 'astroquery.jplspec' is deprecated:DeprecationWarning # These are temporary measures, all of these should be fixed: # ----------------------------------------------------------- ignore:distutils Version classes are deprecated:DeprecationWarning