Skip to content

API: Deprecate vo_conesearch #3548

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pllim wants to merge 1 commit into
base: main
Choose a base branch
from
+35 −7
Open

API: Deprecate vo_conesearch #3548

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions CHANGES.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ esa.euclid
- Methods ``cone_search`` and ``cross_match_basic`` now define the parameters ``table_name`` and ``ra_column_name`` and
``dec_column_name`` independently [#3496]

- Method ``get_product`` now supports the input file_name as a Python list (e.g. ["file1.fits", "file2.fits"]) while
- Method ``get_product`` now supports the input file_name as a Python list (e.g. ["file1.fits", "file2.fits"]) while
still accepting the original comma separated string format. [#3541]

vizier
Expand All @@ -37,10 +37,16 @@ vizier
mast
^^^^
- ``utils.mast_relative_path`` is now deprecated in favor of ``utils.get_cloud_paths``. [#3488]
- When cloud access is enabled, ``Observations.download_file`` and ``Observations.download_products``
now check all requested products against cloud storage. As a result, setting ``cloud_only=True`` will skip
- When cloud access is enabled, ``Observations.download_file`` and ``Observations.download_products``
now check all requested products against cloud storage. As a result, setting ``cloud_only=True`` will skip
any products that are not available in the cloud, rather than falling back to on-prem downloads.

vo_conesearch
^^^^^^^^^^^^^
- The whole ``vo_conesearch`` module is deprecated. Queries can be made using
PyVO Simple Cone Search interface instead. There is no direct replacement
for server validation. [#3548]

Service fixes and enhancements
------------------------------

Expand Down Expand Up @@ -98,7 +104,7 @@ mast

- Added full support for the International Ultraviolet Explorer (IUE) mission in ``MastMissions``. [#3517]

- Added a new ``Observations.list_cloud_datasets()`` method for querying cloud-supported MAST datasets, alongside
- Added a new ``Observations.list_cloud_datasets()`` method for querying cloud-supported MAST datasets, alongside
improvements to cloud download handling. [#3488]

jplspec
Expand Down
9 changes: 9 additions & 0 deletions astroquery/vo_conesearch/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
# Licensed under a 3-clause BSD style license - see LICENSE.rst

import warnings

from astropy import config as _config
from astropy.utils.exceptions import AstropyDeprecationWarning

warnings.warn(
"astroquery.vo_conesearch was deprecated in version 0.4.12 "
"and will be removed in a future version; "
"where possible, use PyVO SCS instead.",
AstropyDeprecationWarning)


class Conf(_config.ConfigNamespace):
Expand Down
10 changes: 7 additions & 3 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -294,11 +294,9 @@ The following modules have been completed using a common API:
ukidss/ukidss.rst
vamdc/vamdc.rst
vizier/vizier.rst
vo_conesearch/vo_conesearch.rst
vsa/vsa.rst
xmatch/xmatch.rst


These others are functional, but do not follow a common & consistent API:

.. toctree::
Expand All @@ -324,6 +322,13 @@ There are also subpackages that serve as the basis of others.

wfau/wfau.rst

This module is deprecated in favor of :ref:`PyVO Simple Cone Search (SCS) <pyvo:pyvo-scs>`:

.. toctree::
:maxdepth: 1

vo_conesearch/vo_conesearch.rst

Catalog, Archive, and Other
===========================

Expand Down Expand Up @@ -355,7 +360,6 @@ for each source)
simbad/simbad.rst
ukidss/ukidss.rst
vizier/vizier.rst
vo_conesearch/vo_conesearch.rst
vsa/vsa.rst
xmatch/xmatch.rst

Expand Down
8 changes: 8 additions & 0 deletions docs/vo_conesearch/vo_conesearch.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,14 @@
VO Simple Cone Search (``astroquery.vo_conesearch``)
****************************************************

.. warning::

As of version 0.4.12, this module has been deprecated. Client-side queries can be made using
:ref:`PyVO Simple Cone Search (SCS) <pyvo:pyvo-scs>` interface instead.
However, there is no direct replacement for server validation functionality.
If you need help transitioning away from the deprecated
functionality here, please reach out to Astroquery or PyVO communities.

Astroquery offers Simple Cone Search Version 1.03 as defined in IVOA
Recommendation (February 22, 2008). Cone Search queries an
area encompassed by a given radius centered on a given RA and Dec and returns
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,7 @@ filterwarnings = [
"error",
# Ignore astroquery's own module reorganization deprecation warnings during testing
"ignore:Importing from 'astroquery.jplspec' is deprecated:DeprecationWarning",
"ignore:astroquery\\.vo_conesearch was deprecated:astropy.utils.exceptions.AstropyDeprecationWarning",
# These are temporary measures, all of these should be fixed:
# -----------------------------------------------------------
"ignore:distutils Version classes are deprecated:DeprecationWarning",
Expand Down
Loading