Move logic into commons

Author: snbianco

CHANGES.rst

@@ -35,66 +35,34 @@ simbad
 Service fixes and enhancements
 ------------------------------
 
-linelists.cdms
-^^^^^^^^^^^^^^
-
-- Add whole catalog retrieval, improve error messaging for unparseable lines,
-  improve metadata catalog, and improve lookuptable behavior [#3173,#2901]
-
-heasarc
-^^^^^^^
-
-- Fix Heasarc.download_data for Sciserver. [#3183]
-
-jplspec
-^^^^^^^
-
-- minor improvement to lookuptable behavior [#3173,#2901]
-
-mocserver
-^^^^^^^^^
-
-- Switch to https instead of http for the default url (allows pyodide to use the
-  module) [#3139]
-
-- Add ``TimeMOC`` and ``STMOC`` as possible entries in ``MOCServer.query_region`` to
-  allow temporal and space-time searches [#3139]
-
-- ``return_moc`` now allows to ask for a Time-MOC or a Space-Time MOC rather than only
-  Space-MOCs [#3139]
-
-- Fix query by MOC that would write a file ``moc.fits`` where the method was executed in
-  overwriting mode (potentially deleting data if there was a conflicting file) [#3139]
-
-- [:warning: BREAKING] Returned tables now have a default list of fields instead of the
-  > 130 columns returned previously. The full list of fields can be displayed with the
-  new method ``MOCServer.list_fields`` [#3139]
+mast
+^^^^
 
-- Add ``casesensitive`` parameter in the queries (previously, this was hardcoded
-  to ``True``) [#3139]
+- Handle a MAST URI string as input for ``Observations.get_cloud_uri`` and a list of MAST URIs as input for
+  ``Observations.get_cloud_uris``. [#3193]
 
-- Add ``coordinate_system`` parameter to the queries to allow to filter on the different
-  bodies or frames. The list of available space systems can be printed with the new
-  method ``MOCServer.list_coordinates_systems`` [#3139]
+simbad
+^^^^^^
 
-- Add ``query_hips`` method, which is convenient to filter only Hierarchical progressive
-  surveys [#3139]
+- The detailed hierarchy is now returned by default in ``query_hierarchy``
+  (it was hidden by default in the previous versions) [#3195]
 
-- New parameter ``criteria`` in ``query_region`` and ``query_hips`` that has the same
-  use than ``meta_data`` in the deprecated method ``find_datasets`` [#3139]
+Service fixes and enhancements
+------------------------------
 
-simbad
-^^^^^^
+gaia
+^^^^
 
-- Fixed adding a list of fluxes with the deprecated notation
-  ``Simbad.add_votable_fields("flux(U)", "flux(J)")`` [#3186]
+- Update DR4 retrieval_type names and include the new one EPOCH_ASTROMETRY_BRIGHT [#3207]
 
-- Support more of the 0.4.7 votable fields. Raise more significant error messages
-  for the discontinued ones. [#3186]
+ipac.irsa
+^^^^^^^^^
 
-- Fix the deprecated votable fields ``otype(V)`` and ``otype(S)`` [#3186]
+- Adding the "servicetype" kwarg to ``list_collections`` to be able to list SIA
+  and SSA collections separately. [#3200]
 
-- Fixed non existing flux filters as votable fields would fail silently [#3186]
+- Adding support for asynchronous queries using the new ``async_job``
+  keyword. [#3201]
 
 - Making ``'spatial'`` keyword in ``query_region`` case insensitive. [#3224]
 
@@ -110,8 +78,6 @@ mast
 
 - Bugfix where ``Observations.get_cloud_uri`` and ``Observations.get_cloud_uris`` fail if the MAST relative path is not found. [#3193]
 
-- Handle coordinates that are not in the ICRS frame in query functions. [#3164]
-
 simbad
 ^^^^^^
 
@@ -2166,4 +2132,4 @@ Infrastructure, Utility and Other Changes and Additions
 0.1 (2013-09-19)
 ================
 
-- Initial release.  Includes features!
+- Initial release.  Includes features!

astroquery/mast/collections.py

@@ -19,7 +19,7 @@
 
 from astropy.table import Table, Row
 
-from ..utils import async_to_sync
+from ..utils import commons, async_to_sync
 from ..utils.class_or_instance import class_or_instance
 from ..exceptions import InvalidQueryError, MaxResultsWarning, InputWarning
 
@@ -204,7 +204,7 @@ def query_region_async(self, coordinates, *, radius=0.2*u.deg, catalog="Hsc",
         """
 
         # Put coordinates and radius into consistent format
-        coordinates = utils.parse_coordinates(coordinates)
+        coordinates = commons.parse_coordinates(coordinates, 'icrs')
 
         # if radius is just a number we assume degrees
         radius = coord.Angle(radius, u.deg)

astroquery/mast/missions.py

@@ -19,7 +19,7 @@
 from requests import HTTPError, RequestException
 
 from astroquery import log
-from astroquery.utils import async_to_sync
+from astroquery.utils import commons, async_to_sync
 from astroquery.utils.class_or_instance import class_or_instance
 from astroquery.exceptions import InvalidQueryError, MaxResultsWarning, InputWarning, NoResultsWarning
 
@@ -184,7 +184,7 @@ def query_region_async(self, coordinates, *, radius=3*u.arcmin, limit=5000, offs
         self._validate_criteria(**criteria)
 
         # Put coordinates and radius into consistent format
-        coordinates = utils.parse_coordinates(coordinates)
+        coordinates = commons.parse_coordinates(coordinates, 'icrs')
 
         # if radius is just a number we assume degrees
         radius = coord.Angle(radius, u.arcmin)

astroquery/mast/observations.py

@@ -22,6 +22,7 @@
 from astropy.table import Table, Row, vstack
 from astroquery import log
 from astroquery.mast.cloud import CloudAccess
+from astroquery.utils import commons
 
 from ..utils import async_to_sync
 from ..utils.class_or_instance import class_or_instance
@@ -227,7 +228,7 @@ def query_region_async(self, coordinates, *, radius=0.2*u.deg, pagesize=None, pa
         """
 
         # Put coordinates and radius into consistent format
-        coordinates = utils.parse_coordinates(coordinates)
+        coordinates = commons.parse_coordinates(coordinates, 'icrs')
 
         # if radius is just a number we assume degrees
         radius = coord.Angle(radius, u.deg)
@@ -346,7 +347,7 @@ def query_region_count(self, coordinates, *, radius=0.2*u.deg, pagesize=None, pa
         """
 
         # build the coordinates string needed by ObservationsClass._caom_filtered_position
-        coordinates = utils.parse_coordinates(coordinates)
+        coordinates = commons.parse_coordinates(coordinates, 'icrs')
 
         # if radius is just a number we assume degrees
         radius = coord.Angle(radius, u.deg)

astroquery/mast/tests/test_mast.py

@@ -1157,33 +1157,3 @@ def test_zcut_get_cutouts(patch_post, tmpdir):
     assert isinstance(cutout_list, list)
     assert len(cutout_list) == 1
     assert isinstance(cutout_list[0], fits.HDUList)
-
-
-################
-# Utils tests #
-################
-
-
-def test_utils_parse_coordinates(patch_post):
-
-    def compare_coords(coords1, coords2):
-        assert coords1.ra.deg == coords2.ra.deg
-        assert coords1.dec.deg == coords2.dec.deg
-        assert coords1.frame.name == 'icrs'
-        assert coords2.frame.name == 'icrs'
-
-    # Expected result
-    expected = SkyCoord('266.40498829 -28.93617776', unit='deg')
-
-    # Parse a string
-    coords = mast.utils.parse_coordinates('266.40498829 -28.93617776')
-    compare_coords(coords, expected)
-
-    # Parse a SkyCoord in ICRS frame
-    coords = mast.utils.parse_coordinates(expected)
-    compare_coords(coords, expected)
-
-    # Parse a SkyCoord in galactic frame
-    galactic = SkyCoord('0 0', unit='deg', frame='galactic')
-    coords = mast.utils.parse_coordinates(galactic)
-    compare_coords(coords, galactic.transform_to('icrs'))

astroquery/mast/utils.py

@@ -122,32 +122,6 @@ def resolve_object(objectname):
     return coordinates
 
 
-def parse_coordinates(coordinates):
-    """
-    Convenience function to parse user input of coordinates.
-
-    Parameters
-    ----------
-    coordinates : str or `astropy.coordinates` object, optional
-        The target around which to search. It may be specified as a
-        string or as the appropriate `astropy.coordinates` object.
-
-    Returns
-    -------
-    response : `~astropy.coordinates.SkyCoord`
-        The given coordinates as an `~astropy.coordinates.SkyCoord` object in the ICRS frame.
-    """
-
-    # Parse into SkyCoord object
-    coordinates = commons.parse_coordinates(coordinates)
-
-    # Convert to ICRS frame, if needed
-    if coordinates.frame.name != 'icrs':
-        coordinates = coordinates.transform_to('icrs')
-
-    return coordinates
-
-
 def parse_input_location(coordinates=None, objectname=None):
     """
     Convenience function to parse user input of coordinates and objectname.
@@ -183,7 +157,7 @@ def parse_input_location(coordinates=None, objectname=None):
 
     # Parse coordinates, if given
     if coordinates:
-        obj_coord = parse_coordinates(coordinates)
+        obj_coord = commons.parse_coordinates(coordinates, 'icrs')
 
     return obj_coord
 

astroquery/utils/commons.py

@@ -38,7 +38,7 @@
 ASTROPY_LT_6_0 = not minversion('astropy', '6.0')
 
 
-def parse_coordinates(coordinates):
+def parse_coordinates(coordinates, return_frame=None):
     """
     Takes a string or astropy.coordinates object. Checks if the
     string is parsable as an `astropy.coordinates`
@@ -49,6 +49,10 @@ def parse_coordinates(coordinates):
     ----------
     coordinates : str or `astropy.coordinates` object
         Astronomical coordinate
+    return_frame : `astropy.coordinates` frame
+        The frame to return the coordinates in. If None and `coordinates` is
+        a string, the frame will be ICRS. If `coordinates` is an `astropy.coordinates` object, the
+        frame will be the same as the input object.
 
     Returns
     -------
@@ -91,6 +95,14 @@ def parse_coordinates(coordinates):
             c = SkyCoord(coordinates)
     else:
         raise TypeError("Argument cannot be parsed as a coordinate")
+
+    # Convert to requested frame, if given
+    if return_frame and c.frame.name != return_frame.lower():
+        try:
+            c = c.transform_to(return_frame)
+        except ValueError:
+            warnings.warn(f"Failed to transform coordinates to requested frame: {return_frame}.", InputWarning)
+
     return c
 
 

astroquery/utils/tests/test_utils.py

@@ -15,6 +15,7 @@
 import astropy.utils.data as aud
 from astropy.logger import log
 
+from ...exceptions import InputWarning
 from ...utils import chunk_read, chunk_report, class_or_instance, commons
 from ...utils.process_asyncs import async_to_sync_docstr, async_to_sync
 from ...utils.docstr_chompers import remove_sections, prepend_docstr_nosections
@@ -80,6 +81,30 @@ def test_parse_coordinates_4():
     assert c.to_string() == coordinates
 
 
+def test_parse_coordinates_return_frame():
+    # String input should return in icrs frame
+    coords = commons.parse_coordinates('266.40498829 -28.93617776')
+    assert coords.frame.name == 'icrs'
+
+    # SkyCoord input without return_frame should return in original frame
+    galactic = coord.SkyCoord('0 0', unit='deg', frame='galactic')
+    coords = commons.parse_coordinates(galactic)
+    assert coords.frame.name == 'galactic'
+
+    # Parse a SkyCoord in galactic frame into icrs frame
+    galactic = coord.SkyCoord('0 0', unit='deg', frame='galactic')
+    icrs = galactic.transform_to('icrs')  # Expected result
+    coords = commons.parse_coordinates(galactic, return_frame='icrs')
+    assert icrs.ra.deg == coords.ra.deg
+    assert icrs.dec.deg == coords.dec.deg
+    assert galactic.frame.name == 'galactic'
+    assert coords.frame.name == 'icrs'
+
+    # Warn if transformation fails
+    with pytest.warns(InputWarning, match='Failed to transform coordinates'):
+        coords = commons.parse_coordinates(galactic, return_frame='invalid')
+
+
 col_1 = [1, 2, 3]
 col_2 = [0, 1, 0, 1, 0, 1]
 col_3 = ['v', 'w', 'x', 'y', 'z']