Merge pull request #3415 from bsipocz/ENH_irsa_list_catalogs_filter_desc

ENH: Irsa.list_catalog(filter) now matching in description

Author: bsipocz

CHANGES.rst

@@ -30,7 +30,7 @@ mast
 ^^^^
 
 - Deprecated the ``product`` parameter in the ``Tesscut.get_sectors``, ``Tesscut.get_cutouts``, and ``Tesscut.download_cutouts`` methods.
-  Support for TESS Image Calibration (TICA) high-level science products has been removed; only Science Processing Operations Center (SPOC) 
+  Support for TESS Image Calibration (TICA) high-level science products has been removed; only Science Processing Operations Center (SPOC)
   products are now supported. [#3391]
 
 Service fixes and enhancements
@@ -86,6 +86,9 @@ ipac.irsa
   in to return all TAP tables, including non-spatial and metadata ones,
   too. [#3334]
 
+- The "filter" kwarg of ``list_catalogs`` is now looking for string matches
+  either in catalog names and short descriptions. [#3415]
+
 SIMBAD
 ^^^^^^
 

astroquery/ipac/irsa/core.py

@@ -314,8 +314,9 @@ def list_catalogs(self, *, full=False, filter=None, include_metadata_tables=Fals
             If True returns the full schema as a `~astropy.table.Table`.
             If False returns a dictionary of the table names and their description.
         filter : str or None
-            If specified we only return catalogs when their catalog_name
-            contains the filter string.
+            If specified we only return catalogs when their catalog_name or the short description
+            contains the filter string (case-insensitive). Note this may not be all the relevant catalogs
+            from a given mission, do consult the unfiltered list when in doubt.
         include_metadata_tables : bool
             If True returns not just the catalogs but all table holdings including the image metadata tables.
             These are not suitable for spatial queries with e.g. ``query_region``.
@@ -331,7 +332,9 @@ def list_catalogs(self, *, full=False, filter=None, include_metadata_tables=Fals
         tap_tables = self.query_tap(f"SELECT * FROM TAP_SCHEMA.tables {more_filtering}").to_table()
 
         if filter:
-            mask = [filter in name for name in tap_tables['table_name']]
+            filter = filter.lower()
+            mask = [filter in name.lower() or filter in description.lower()
+                    for name, description in tap_tables['table_name', 'description']]
             tap_tables = tap_tables[mask]
 
         if full:

astroquery/ipac/irsa/tests/test_irsa_remote.py

@@ -82,6 +82,13 @@ def test_list_catalogs_filter(self):
 
         assert len(allwise_catalogs) == 4
 
+    def test_list_catalogs_filter_description(self):
+        twomass_catalogs = Irsa.list_catalogs(filter='2mass')
+        assert len(twomass_catalogs) == 39
+
+        all_twomass = Irsa.list_catalogs(filter='2mass', include_metadata_tables=True)
+        assert len(all_twomass) == 58
+
     def test_list_catalogs_metadata(self):
         catalogs = Irsa.list_catalogs(filter='wise')
         all_tables = Irsa.list_catalogs(filter='wise', include_metadata_tables=True)

docs/ipac/irsa/irsa.rst

@@ -29,8 +29,8 @@ The output consists of two fields for each catalog, the name of the catalog
 and a very short description. To query a
 specific catalog, the first field can be entered as the value of the
 ``catalog`` parameter in the `~.astroquery.ipac.irsa.IrsaClass.query_region` method.
-You can also use the ``filter`` argument to return only the catalogs with
-name matches to the specified string.
+You can also use the ``filter`` argument to return only the catalogs with their
+name or short description matching to the specified string (case-insensitive matching).
 
 
 .. doctest-remote-data::
@@ -455,48 +455,20 @@ will return a `~astropy.table.Table`.
 
    >>> from astroquery.ipac.irsa import Irsa
    >>> Irsa.list_collections(servicetype='SSA')
-   <Table length=37>
+   <Table length=41>
           collection
             object
    ------------------------
                       champ
                       goals
+             herschel_digit
           herschel_gotcplus
-             herschel_hexos
-         herschel_hifistars
-               herschel_hop
-              herschel_hops
-    herschel_magcloudscplus
-           herschel_ppdisks
-           herschel_prismas
-              herschel_sag4
-             herschel_shpdp
-           herschel_v838mon
-              herschel_vngs
-                irtf_mearth
-                       irts
-                    iso_sws
-                 sofia_exes
-             sofia_exes_enh
-               sofia_fifils
-             sofia_flitecam
-              sofia_forcast
-                sofia_great
-             spitzer_5muses
-                spitzer_c2d
-   spitzer_disks_sh_spectra
-               spitzer_feps
-            spitzer_irs_std
-             spitzer_irsenh
-             spitzer_m83m33
-                 spitzer_s5
-               spitzer_sage
-               spitzer_sass
+                        ...
                 spitzer_sha
               spitzer_sings
               spitzer_ssgss
                        swas
-
+                    thrumms
 
 Other Configurations
 --------------------