put back help, open_form, filter_columns arguments

juanmcloaiza · juanmcloaiza · commit 0891d2788bf4 · 2025-03-28T12:10:50.000+01:00
diff --git a/astroquery/eso/core.py b/astroquery/eso/core.py
@@ -412,6 +412,8 @@ def _query_on_allowed_values(
 
         return retval
 
+    @deprecated_renamed_argument(('open_form', 'cache'), (None, None),
+                                 since=['0.4.11', '0.4.11'])
     def query_surveys(
             self,
             surveys: Union[List[str], str] = None, *,
@@ -420,9 +422,14 @@ def query_surveys(
             top: int = None,
             count_only: bool = False,
             query_str_only: bool = False,
-            print_help: bool = False,
+            help: bool = False,
             authenticated: bool = False,
+            column_filters: Optional[dict] = None,
+            open_form: bool = False, cache: bool = False,
             **kwargs) -> Union[astropy.table.Table, int, str]:
+        _ = open_form, cache  # make explicit that we are aware these arguments are unused
+        c = column_filters if column_filters else {}
+        kwargs = {**kwargs, **c}
         return self._query_on_allowed_values(table_name=EsoNames.phase3_table,
                                              column_name=EsoNames.phase3_surveys_column,
                                              allowed_values=surveys,
@@ -431,10 +438,12 @@ def query_surveys(
                                              top=top,
                                              count_only=count_only,
                                              query_str_only=query_str_only,
-                                             print_help=print_help,
+                                             print_help=help,
                                              authenticated=authenticated,
                                              **kwargs)
 
+    @deprecated_renamed_argument(('open_form', 'cache'), (None, None),
+                                 since=['0.4.11', '0.4.11'])
     def query_main(
             self,
             instruments: Union[List[str], str] = None, *,
@@ -443,9 +452,14 @@ def query_main(
             top: int = None,
             count_only: bool = False,
             query_str_only: bool = False,
-            print_help: bool = False,
+            help: bool = False,
             authenticated: bool = False,
+            column_filters: Optional[dict] = None,
+            open_form: bool = False, cache: bool = False,
             **kwargs) -> Union[astropy.table.Table, int, str]:
+        _ = open_form, cache  # make explicit that we are aware these arguments are unused
+        c = column_filters if column_filters else {}
+        kwargs = {**kwargs, **c}
         return self._query_on_allowed_values(table_name=EsoNames.raw_table,
                                              column_name=EsoNames.raw_instruments_column,
                                              allowed_values=instruments,
@@ -454,11 +468,12 @@ def query_main(
                                              top=top,
                                              count_only=count_only,
                                              query_str_only=query_str_only,
-                                             print_help=print_help,
+                                             print_help=help,
                                              authenticated=authenticated,
                                              **kwargs)
 
-    # ex query_instrument
+    @deprecated_renamed_argument(('open_form', 'cache'), (None, None),
+                                 since=['0.4.11', '0.4.11'])
     def query_instrument(
             self,
             instrument: str, *,
@@ -467,9 +482,14 @@ def query_instrument(
             top: int = None,
             count_only: bool = False,
             query_str_only: bool = False,
-            print_help: bool = False,
+            help: bool = False,
             authenticated: bool = False,
+            column_filters: Optional[dict] = None,
+            open_form: bool = False, cache: bool = False,
             **kwargs) -> Union[astropy.table.Table, int, str]:
+        _ = open_form, cache  # make explicit that we are aware these arguments are unused
+        c = column_filters if column_filters else {}
+        kwargs = {**kwargs, **c}
         return self._query_on_allowed_values(table_name=EsoNames.ist_table(instrument),
                                              column_name=None,
                                              allowed_values=None,
@@ -478,7 +498,7 @@ def query_instrument(
                                              top=top,
                                              count_only=count_only,
                                              query_str_only=query_str_only,
-                                             print_help=print_help,
+                                             print_help=help,
                                              authenticated=authenticated,
                                              **kwargs)
 
@@ -786,10 +806,12 @@ def retrieve_data(self, datasets, *, continuation=False, destination=None,
         log.info("Done!")
         return files[0] if files and len(files) == 1 and return_string else files
 
-    @deprecated_renamed_argument(('open_form', 'help'), (None, 'print_help'),
-                                 since=['0.4.8', '0.4.8'])
-    def query_apex_quicklooks(self, *, project_id=None, print_help=False,
-                              open_form=False, **kwargs):
+    @deprecated_renamed_argument(('open_form', 'cache'), (None, None),
+                                 since=['0.4.11', '0.4.11'])
+    def query_apex_quicklooks(self, *, project_id=None, help: bool = False,
+                              column_filters: Optional[dict] = None,
+                              open_form: bool = False, cache: bool = False,
+                              **kwargs):
         """
         APEX data are distributed with quicklook products identified with a
         different name than other ESO products.  This query tool searches by
@@ -801,7 +823,8 @@ def query_apex_quicklooks(self, *, project_id=None, print_help=False,
         >>> files = ...
         """
         # TODO All this function
-        _ = project_id, print_help, open_form, kwargs
+        # make explicit that we are aware these arguments are unused
+        _ = project_id, help, column_filters, open_form, cache, kwargs
         raise NotImplementedError
 
 
diff --git a/astroquery/eso/tests/test_eso.py b/astroquery/eso/tests/test_eso.py
@@ -22,6 +22,8 @@
 from ...exceptions import NoResultsWarning, MaxResultsWarning
 
 DATA_DIR = os.path.join(os.path.dirname(__file__), 'data')
+EXPECTED_MAXREC = 1000
+MONKEYPATCH_TABLE_LENGTH = 50
 
 
 def data_path(filename):
@@ -123,7 +125,7 @@ def test_sinfoni_sgr_a_star(monkeypatch):
     monkeypatch.setattr(eso, 'query_tap_service', monkey_tap)
     result = eso.query_instrument('sinfoni', target='SGRA')
     # test all results are there and the expected target is present
-    assert len(result) == 50
+    assert len(result) == MONKEYPATCH_TABLE_LENGTH
     assert 'SGRA' in result['target']
 
 
@@ -147,7 +149,7 @@ def test_vvv(monkeypatch):
                                radius=0.1775,
                                )
     # test all results are there and the expected target is present
-    assert len(result) == 50
+    assert len(result) == MONKEYPATCH_TABLE_LENGTH
     assert 'target_name' in result.colnames
     assert 'b333' in result['target_name']
 
@@ -216,7 +218,7 @@ def test_calselector(monkeypatch, tmp_path):
     monkeypatch.setattr(eso._session, 'post', calselector_request)
     result = eso.get_associated_files([dataset], savexml=True)
     assert isinstance(result, list)
-    assert len(result) == 50
+    assert len(result) == MONKEYPATCH_TABLE_LENGTH
     assert dataset not in result
 
 
@@ -276,9 +278,9 @@ def test_adql_sanitize_val():
 def test_maxrec():
     eso_instance = Eso()
 
-    # 50 is the default value in the conf
+    # EXPECTED_MAXREC is the default value in the conf
     maxrec = eso_instance.maxrec
-    assert maxrec == 50
+    assert maxrec == EXPECTED_MAXREC
 
     # we change it to 5
     eso_instance.maxrec = 5
@@ -321,8 +323,8 @@ def test_issue_table_length_warnings():
     with pytest.warns(NoResultsWarning):
         eso_instance._maybe_warn_about_table_length(t)
 
-    # should warn, since 50 = eso_instance.maxrec
-    t = Table({"col_name": [i for i in range(50)]})
+    # should warn, since EXPECTED_MAXREC = eso_instance.maxrec
+    t = Table({"col_name": [i for i in range(EXPECTED_MAXREC)]})
     with pytest.warns(MaxResultsWarning):
         eso_instance._maybe_warn_about_table_length(t)
 
diff --git a/astroquery/eso/tests/test_eso_remote.py b/astroquery/eso/tests/test_eso_remote.py
@@ -169,27 +169,29 @@ def test_empty_return(self):
         assert len(result_s) == 0
 
     @pytest.mark.filterwarnings("ignore::pyvo.dal.exceptions.DALOverflowWarning")
-    def test_sgrastar_remote_vs_local(self, tmp_path):
+    def test_sgrastar_column_filters(self, tmp_path):
         eso = Eso()
-        # TODO originally it was 'gravity', but it is not yet ready in the TAP ISTs
-        instrument = 'uves'
 
-        # Remote version
-        with pytest.warns(MaxResultsWarning):
-            result1 = eso.query_instrument(instrument, ra=266.41681662,
-                                           dec=-29.00782497, radius=1.0)
-        # Local version
-        eso.cache_location = tmp_path
-        with pytest.warns(MaxResultsWarning):
-            result2 = eso.query_instrument(instrument, ra=266.41681662,
-                                           dec=-29.00782497, radius=1.0)
+        result1 = eso.query_surveys(["sphere", "vegas"],
+                                    columns="obs_collection, calib_level, multi_ob, filter, s_pixel_scale, instrument_name",
+                                    calib_level=3,
+                                    multi_ob='M'
+                                    )
+
+        result2 = eso.query_surveys("sphere, vegas",
+                                    columns="obs_collection, calib_level, multi_ob, filter, s_pixel_scale, instrument_name",
+                                    column_filters={
+                                        'calib_level': 3,
+                                        'multi_ob': 'M'
+                                    }
+                                    )
+
         assert all(result1.values_equal(result2))
 
     def test_list_instruments(self):
         # If this test fails, we may simply need to update it
         inst = set(Eso.list_instruments())
-        assert set(inst) == set(instrument_list), \
-            f"Expected result {instrument_list}; Obtained: {inst}"
+        assert set(inst) == set(instrument_list), f"Expected result {instrument_list}; Obtained: {inst}"
 
     def test_retrieve_data(self):
         eso = Eso()
@@ -217,7 +219,7 @@ def test_retrieve_data_list(self):
     @pytest.mark.parametrize('instrument', instrument_list)
     def test_help(self, instrument):
         eso = Eso()
-        eso.query_instrument(instrument, print_help=True)
+        eso.query_instrument(instrument, help=True)
 
     def test_apex_retrieval(self):
         raise NotImplementedError
@@ -261,10 +263,8 @@ def test_each_collection_sgrastar(self, tmp_path):
                 with pytest.warns(MaxResultsWarning):
                     generic_result = eso.query_surveys(surveys=collection)
 
-                    assert generic_result is not None, \
-                        f"query_collection({collection}) returned None"
-                    assert len(generic_result) > 0, \
-                        f"query_collection({collection}) returned no records"
+                    assert generic_result is not None, f"query_collection({collection}) returned None"
+                    assert len(generic_result) > 0, f"query_collection({collection}) returned no records"
 
     @pytest.mark.filterwarnings("ignore::pyvo.dal.exceptions.DALOverflowWarning")
     def test_mixed_case_instrument(self, tmp_path):
