feat: rename spacesys into coordinate_system

ManonMarchand · bsipocz · commit 2ced5b32b26d · 2025-01-22T15:00:15.000-08:00
note that this change is only user-facing, the upstream name is spacesys
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -41,9 +41,9 @@ mocserver
 - Add ``casesensitive`` parameter in the queries (previously, this was hardcoded
   to ``True``) [#3139]
 
-- Add ``spacesys`` 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_spacesys`` [#3139]
+- 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]
 
 - Add ``query_hips`` method, which is convenient to filter only Hierarchical progressive
   surveys [#3139]
diff --git a/astroquery/mocserver/core.py b/astroquery/mocserver/core.py
@@ -49,7 +49,7 @@ def query_region(
         fields=None,
         max_rec=None,
         casesensitive=False,
-        spacesys=None,
+        coordinate_system=None,
         get_query_payload=False,
         verbose=False,
         cache=True,
@@ -74,11 +74,11 @@ def query_region(
         fields : [str], optional
             Specifies which columns to retrieve. Defaults to a pre-defined subset of
             fields. The complete list of fields can be obtained with `list_fields`.
-        spacesys: str, optional
+        coordinate_system : str, optional
             This is the space system on which the coordinates are expressed. Can take
             the values ``sky``, ``mars``, ``moon``... The extended list can
-            be printed with `list_spacesys`. Default is None, meaning that the results
-            will have mixed frames.
+            be printed with `~astroquery.mocserver.MOCServer.list_coordinate_systems`.
+            Default is None, meaning that the results will have mixed frames.
         intersect : str, optional
             This parameter can take three different values:
 
@@ -122,7 +122,7 @@ def query_region(
             fields=fields,
             max_rec=max_rec,
             casesensitive=casesensitive,
-            spacesys=spacesys,
+            coordinate_system=coordinate_system,
             get_query_payload=get_query_payload,
             cache=cache,
         )
@@ -141,7 +141,7 @@ def query_hips(
         fields=None,
         max_rec=None,
         casesensitive=False,
-        spacesys=None,
+        coordinate_system=None,
         get_query_payload=False,
         verbose=False,
         cache=True,
@@ -161,11 +161,11 @@ def query_hips(
         fields : [str], optional
             Specifies which columns to retrieve. Defaults to a pre-defined subset of
             fields. The complete list of fields can be obtained with `list_fields`.
-        spacesys: str, optional
+        coordinate_system : str, optional
             This is the space system on which the coordinates are expressed. Can take
             the values ``sky``, ``mars``, ``moon``... The extended list can
-            be printed with `list_spacesys`. Default is None, meaning that the results
-            will have mixed frames.
+            be printed with `~astroquery.mocserver.MOCServer.list_coordinate_systems`.
+            Default is None, meaning that the results will have mixed frames.
         region : `regions.CircleSkyRegion`, `regions.PolygonSkyRegion`, `mocpy.MOC`,
             `mocpy.TimeMOC`, or `mocpy.STMOC`
             The region to query the MOCServer with. Note that this can also be a
@@ -217,7 +217,7 @@ def query_hips(
             fields=fields,
             max_rec=max_rec,
             casesensitive=casesensitive,
-            spacesys=spacesys,
+            coordinate_system=coordinate_system,
             get_query_payload=get_query_payload,
             verbose=verbose,
             cache=cache,
@@ -235,7 +235,7 @@ def find_datasets(
         fields=None,
         max_rec=None,
         casesensitive=False,
-        spacesys=None,
+        coordinate_system=None,
         get_query_payload=False,
         verbose=False,
         cache=True,
@@ -255,11 +255,11 @@ def find_datasets(
         fields : [str], optional
             Specifies which columns to retrieve. Defaults to a pre-defined subset of
             fields. The complete list of fields can be obtained with `list_fields`.
-        spacesys: str, optional
+        coordinate_system : str, optional
             This is the space system on which the coordinates are expressed. Can take
             the values ``sky``, ``mars``, ``moon``... The extended list can
-            be printed with `list_spacesys`. Default is None, meaning that the results
-            will have mixed frames.
+            be printed with `~astroquery.mocserver.MOCServer.list_coordinate_systems`.
+            Default is None, meaning that the results will have mixed frames.
         region : `regions.CircleSkyRegion`, `regions.PolygonSkyRegion`, `mocpy.MOC`,
             `mocpy.TimeMOC`, or `mocpy.STMOC`
             The region to query the MOCServer with. Note that this can also be a
@@ -307,7 +307,7 @@ def find_datasets(
             fields=fields,
             max_rec=max_rec,
             casesensitive=casesensitive,
-            spacesys=spacesys,
+            coordinate_system=coordinate_system,
             get_query_payload=get_query_payload,
             verbose=verbose,
             cache=cache,
@@ -323,7 +323,7 @@ def query_async(
         fields=None,
         max_rec=None,
         intersect="overlaps",
-        spacesys=None,
+        coordinate_system=None,
         casesensitive=False,
         get_query_payload=False,
         cache=True,
@@ -343,11 +343,11 @@ def query_async(
         fields : [str], optional
             Specifies which columns to retrieve. Defaults to a pre-defined subset of
             fields. The complete list of fields can be obtained with `list_fields`.
-        spacesys: str, optional
+        coordinate_system : str, optional
             This is the space system on which the coordinates are expressed. Can take
             the values ``sky``, ``mars``, ``moon``... The extended list can
-            be printed with `list_spacesys`. Default is None, meaning that the results
-            will have mixed frames.
+            be printed with `~astroquery.mocserver.MOCServer.list_coordinate_systems`.
+            Default is None, meaning that the results will have mixed frames.
         region : `regions.CircleSkyRegion`, `regions.PolygonSkyRegion`, `mocpy.MOC`,
             `mocpy.TimeMOC`, or `mocpy.STMOC`
             The region to query the MOCServer with. Note that this can also be a
@@ -392,7 +392,7 @@ def query_async(
             max_rec=max_rec,
             region=region,
             intersect=intersect,
-            spacesys=spacesys,
+            coordinate_system=coordinate_system,
             casesensitive=casesensitive,
             default_fields=self.DEFAULT_FIELDS,
         )
@@ -509,20 +509,20 @@ def list_fields_async(self, cache=True):
             params={"get": "example", "fmt": "json"},
         )
 
-    def list_spacesys(self):
-        """Return the list of "spacesys" currently available in the MOC Server.
+    def list_coordinate_systems(self):
+        """Return the list of coordinate systems currently available in the MOC Server.
 
         This list may be enriched later, as new datasets are added into the MOC Server.
 
         Returns
         -------
         list
-            The list of spacesys currently available in the MOC Server
+            The list of coordinate systems currently available in the MOC Server
 
         """
         frames = list(set(self.query_region(meta_data="hips_frame=*",
                                             fields=["ID", "hips_frame"],
-                                            spacesys=None)["hips_frame"]))
+                                            coordinate_system=None)["hips_frame"]))
         # `C` is a special case that corresponds to both equatorial and galactic frames
         frames.append("sky")
         frames.sort()
@@ -538,7 +538,7 @@ def _args_to_payload(
     max_rec=None,
     region=None,
     intersect="overlaps",
-    spacesys=None,
+    coordinate_system=None,
     casesensitive=False,
     default_fields=None,
 ):
@@ -556,7 +556,7 @@ def _args_to_payload(
         "get": "record",
         "fields": _get_fields(fields, default_fields),
         "intersect": intersect.replace("encloses", "enclosed"),
-        "spacesys": "C" if spacesys == "sky" else spacesys,
+        "spacesys": "C" if coordinate_system == "sky" else coordinate_system,
     }
 
     if region and not isinstance(region, (MOC, STMOC, TimeMOC)):
diff --git a/astroquery/mocserver/tests/test_mocserver.py b/astroquery/mocserver/tests/test_mocserver.py
@@ -129,18 +129,18 @@ def test_list_fields():
     assert "ID" in fields["field_name"]
 
 
-# -------------
-# List spacesys
-# -------------
+# -----------------------
+# List coordinate systems
+# -----------------------
 
 
 @pytest.fixture
-def _mock_list_spacesys(monkeypatch):
+def _mock_list_coordinate_systems(monkeypatch):
     # This list changes upstream. To regenerate it, do:
     # >>> from astroquery.mocserver import MOCServer
     # >>> hips_frames = MOCServer.query_region(meta_data="hips_frame=*",
     # ...                                       fields=["hips_frame"],
-    # ...                                       spacesys=None, max_rec=100)
+    # ...                                       coordinate_system=None, max_rec=100)
     # >>> hips_frames.remove_column("ID")
     # >>> hips_frames.write("hips_frames.vot", format="votable", overwrite=True)
     with open(Path(__file__).parent / "data" / "hips_frames.vot", "rb") as f:
@@ -151,10 +151,10 @@ def _mock_list_spacesys(monkeypatch):
 
 
 @pytest.mark.skipif(not HAS_MOCPY, reason="mocpy is required")
-@pytest.mark.usefixtures("_mock_list_spacesys")
-def test_list_spacesys():
-    list_spacesys = MOCServer.list_spacesys()
-    assert "sky" in list_spacesys and "equatorial" in list_spacesys
+@pytest.mark.usefixtures("_mock_list_coordinate_systems")
+def test_list_coordinate_systems():
+    list_coordinate_system = MOCServer.list_coordinate_systems()
+    assert "sky" in list_coordinate_system and "equatorial" in list_coordinate_system
 
 
 # ---------------------
@@ -225,9 +225,9 @@ def test_return_moc():
     assert payload["order"] == "max"
 
 
-def test_spacesys():
+def test_coordinate_system():
     payload = MOCServer.query_region(
-        spacesys="sky", meta_data="", return_moc=True,
+        coordinate_system="sky", meta_data="", return_moc=True,
         max_norder=5, get_query_payload=True
     )
     assert payload["spacesys"] == "C"
diff --git a/astroquery/mocserver/tests/test_mocserver_remote.py b/astroquery/mocserver/tests/test_mocserver_remote.py
@@ -85,7 +85,7 @@ def test_no_region(self):
         assert all(result["moc_sky_fraction"] > 0.5)
 
     def test_query_hips(self):
-        result = MOCServer.query_hips(spacesys="venus", fields="hips_frame")
+        result = MOCServer.query_hips(coordinate_system="venus", fields="hips_frame")
         assert all(result["hips_frame"] == "venus")
 
     def test_list_fields(self):
diff --git a/docs/mocserver/mocserver.rst b/docs/mocserver/mocserver.rst
@@ -78,7 +78,7 @@ Performing a query on a cone region
 
 Let's get the datasets for which all the data is comprised in a cone (this is
 what the ``enclosed`` option means for intersect). We also restrict our search to
-datasets describing the sky (with ``spacesys=sky``).
+datasets describing the sky (with ``coordinate_system=sky``).
 
 .. doctest-remote-data::
 
@@ -88,7 +88,7 @@ datasets describing the sky (with ``spacesys=sky``).
     >>> center = coordinates.SkyCoord(10.8, 32.2, unit='deg')
     >>> radius = coordinates.Angle(0.5, unit='deg')
     >>> cone = CircleSkyRegion(center, radius)
-    >>> MOCServer.query_region(region=cone, intersect="enclosed", spacesys="sky")  # doctest: +IGNORE_OUTPUT
+    >>> MOCServer.query_region(region=cone, intersect="enclosed", coordinate_system="sky")  # doctest: +IGNORE_OUTPUT
     <Table length=450>
                   ID               ...
                 str49              ...
@@ -116,7 +116,7 @@ datasets describing the sky (with ``spacesys=sky``).
 
 You can also use this method with `regions.PolygonSkyRegion`, `mocpy.MOC`, `mocpy.TimeMOC`,
 and `mocpy.STMOC`. Not providing the region parameter means that the search is done on
-the whole sky (or the whole planet, if we chose a different ``spacesys``).
+the whole sky (or the whole planet, if we chose a different ``coordinate_system``).
 
 Querying by meta-data
 =====================
@@ -217,7 +217,7 @@ methods. The only difference is that the output will only contain HiPS data.
 .. doctest-remote-data::
 
   >>> from astroquery.mocserver import MOCServer
-  >>> MOCServer.query_hips(spacesys="mars") # doctest: +IGNORE_OUTPUT
+  >>> MOCServer.query_hips(coordinate_system="mars") # doctest: +IGNORE_OUTPUT
   <Table length=25>
                    ID                 ...
                  str35                ...
@@ -361,25 +361,25 @@ object) of the ``GALEXGR6/AIS/FUV`` survey.
 Finding data on a specific solar system body
 --------------------------------------------
 
-The default value for ``spacesys`` is None. It means that we're looking for data for the
-sky and all other possible frames. This parameter can take all the values listed by
-`astroquery.mocserver.MOCServerClass.list_spacesys`:
+The default value for ``coordinate_system`` is ``None``. It means that we're looking for
+data for the sky and all other possible frames. This parameter can take all the values
+listed by `astroquery.mocserver.MOCServerClass.list_coordinate_systems`:
 
 .. doctest-remote-data::
 
   >>> from astroquery.mocserver import MOCServer
-  >>> MOCServer.list_spacesys()
+  >>> MOCServer.list_coordinate_systems()
   ['ariel', 'callisto', 'ceres', 'charon', 'dione', 'earth', 'enceladus', 'equatorial', 'europa', 'galactic', 'ganymede', 'iapetus', 'io', 'jupiter', 'mars', 'mars-pia20284', 'mars-pia24422', 'mars-stimson', 'mercury', 'mimas', 'miranda', 'moon', 'moon-pan1', 'neptune', 'oberon', 'pluto', 'rhea', 'sky', 'sun', 'tethys', 'titan', 'titania', 'triton', 'umbriel', 'venus']
 
 Where the special value ``sky`` means any celestial frame (mainly ``equatorial`` and
 ``galactic``). 
 
-The ``spacesys`` parameter can be used in any of the query methods like so:
+The ``coordinate_system`` parameter can be used in any of the query methods like so:
 
 .. doctest-remote-data::
 
   >>> from astroquery.mocserver import MOCServer
-  >>> MOCServer.query_hips(spacesys="ariel")
+  >>> MOCServer.query_hips(coordinate_system="ariel")
   <Table length=1>
            ID           obs_title   ... dataproduct_type
          str19            str13     ...       str5      
