change 'regex_str' to 'species_regex'

Author: keflavich

astroquery/splatalogue/build_species_table.py

@@ -67,7 +67,6 @@ def get_json_species_ids(*, outfile='splat-species.json', base_url=conf.base_url
             species[kid['class'][0]][kid['value']] = kid.text
 
     with open(data_path(outfile), 'w') as f:
-        assert isinstance(species, dict)
         json.dump(species, f)
 
     return json.dumps(species)

astroquery/splatalogue/core.py

@@ -76,16 +76,17 @@ def set_default_options(self, **kwargs):
         """
         self.data.update(self._parse_kwargs(**kwargs))
 
-    def get_species_ids(self, regex_str=None, *, reflags=0, recache=False):
+    def get_species_ids(self, species_regex=None, *, reflags=0, recache=False):
         """
         Get a dictionary of "species" IDs, where species refers to the molecule
         name, mass, and chemical composition.
 
         Parameters
         ----------
-        regex_str : str
-            String to compile into an re, if specified.   Searches table for
-            species whose names match
+        species_regex : str
+            String to search for among the species names, if specified.
+            The string will be compiled into a regular expression using the
+            python `re` module.
         reflags : int
             Flags to pass to `re`.
         recache : bool
@@ -95,7 +96,7 @@ def get_species_ids(self, regex_str=None, *, reflags=0, recache=False):
         --------
         >>> import re
         >>> import pprint # unfortunate hack required for documentation testing
-        >>> rslt = Splatalogue.get_species_ids(regex_str='Formaldehyde')
+        >>> rslt = Splatalogue.get_species_ids(species_regex='Formaldehyde')
         >>> pprint.pprint(rslt)
         {'03023 H2CO - Formaldehyde': '194',
          '03106 H213CO - Formaldehyde': '324',
@@ -107,7 +108,7 @@ def get_species_ids(self, regex_str=None, *, reflags=0, recache=False):
          '03301 D213CO - Formaldehyde': '1220',
          '03315 HDC18O - Formaldehyde': '21141',
          '03410 D2C18O - Formaldehyde': '21140'}
-        >>> rslt = Splatalogue.get_species_ids(regex_str='H2CO')
+        >>> rslt = Splatalogue.get_species_ids(species_regex='H2CO')
         >>> pprint.pprint(rslt)
         {'03023 H2CO - Formaldehyde': '194',
          '03109 H2COH+ - Hydroxymethylium ion': '224',
@@ -125,9 +126,9 @@ def get_species_ids(self, regex_str=None, *, reflags=0, recache=False):
          '08903 CH3CHNH2COOH - II - α-Alanine': '1322'}
         >>> # note the whitespace, preventing H2CO within other
         >>> # more complex molecules
-        >>> Splatalogue.get_species_ids(regex_str=' H2CO ')
+        >>> Splatalogue.get_species_ids(species_regex=' H2CO ')
         {'03023 H2CO - Formaldehyde': '194'}
-        >>> Splatalogue.get_species_ids(regex_str=' h2co ', reflags=re.IGNORECASE)
+        >>> Splatalogue.get_species_ids(species_regex=' h2co ', reflags=re.IGNORECASE)
         {'03023 H2CO - Formaldehyde': '194'}
 
         """
@@ -136,8 +137,8 @@ def get_species_ids(self, regex_str=None, *, reflags=0, recache=False):
         if not hasattr(self, '_species_ids'):
             self._species_ids = load_species_table.species_lookuptable(recache=recache)
 
-        if regex_str is not None:
-            return self._species_ids.find(regex_str, flags=reflags)
+        if species_regex is not None:
+            return self._species_ids.find(species_regex, flags=reflags)
         else:
             return self._species_ids
 
@@ -319,7 +320,7 @@ def _parse_kwargs(self, *, min_frequency=None, max_frequency=None,
             payload['sid[]'] = []
         elif chemical_name is not None:
             if parse_chemistry_locally:
-                species_ids = self.get_species_ids(regex_str=chemical_name, reflags=chem_re_flags)
+                species_ids = self.get_species_ids(species_regex=chemical_name, reflags=chem_re_flags)
                 if len(species_ids) == 0:
                     raise ValueError("No matching chemical species found.")
                 payload['sid[]'] = list(species_ids.values())

docs/splatalogue/splatalogue.rst

@@ -29,10 +29,10 @@ To search within this list for a particular species, you can use regular express
 
 .. code-block:: python
 
-   >>> CO_containing_species = Splatalogue.get_species_ids(regex_str='CO')
+   >>> CO_containing_species = Splatalogue.get_species_ids(species_regex='CO')
    >>> len(CO_containing_species)
    105
-   >>> just_CO = Splatalogue.get_species_ids(regex_str=' CO ') # note the spaces
+   >>> just_CO = Splatalogue.get_species_ids(species_regex=' CO ') # note the spaces
    >>> len(just_CO)
    4
    >>> assert just_CO == {'02812 CO v = 0 - Carbon Monoxide': '204',