seppl.io.locate_files can take a default_glob now that gets appended to inputs that point to dirs

Author: fracpete

CHANGES.rst

@@ -1,6 +1,13 @@
 Changelog
 =========
 
+0.2.5 (2024-06-18)
+------------------
+
+- the `seppl.io.locate_files` method can take a default glob now, which gets appended
+  to inputs that point to directories
+
+
 0.2.4 (2024-05-06)
 ------------------
 

setup.py

@@ -30,7 +30,7 @@ def _read(f):
         '': 'src'
     },
     packages=find_namespace_packages(where='src'),
-    version="0.2.4",
+    version="0.2.5",
     author='Peter Reutemann',
     author_email='fracpete@waikato.ac.nz',
     entry_points={

src/seppl/io/_utils.py

@@ -5,17 +5,21 @@
 
 
 def locate_files(inputs: Union[str, List[str]], input_lists: Union[str, List[str]] = None,
-                 fail_if_empty: bool = False) -> List[str]:
+                 fail_if_empty: bool = False, default_glob: str = None) -> List[str]:
     """
     Locates all the files from the specified inputs, which may contain globs.
     glob results get sorted to ensure the same file order each time.
+    If default_glob is not None and the inputs are pointing to directories, then default_glob
+    gets appended.
 
     :param inputs: the input path(s) with optional globs
     :type inputs: str or list
     :param input_lists: text file(s) that list the actual input files to use
     :type input_lists: str or list
     :param fail_if_empty: whether to throw an exception if no files were located
     :type fail_if_empty: bool
+    :param default_glob: the default glob to use, ignored if None
+    :type default_glob: str
     :return: the expanded list of files
     :rtype: list
     """
@@ -30,6 +34,11 @@ def locate_files(inputs: Union[str, List[str]], input_lists: Union[str, List[str
         else:
             raise Exception("Invalid inputs, must be string(s)!")
 
+        if default_glob is not None:
+            for i, inp in enumerate(inputs):
+                if os.path.isdir(inp):
+                    inputs[i] = os.path.join(inp, default_glob)
+
     if input_lists is not None:
         if isinstance(input_lists, str):
             input_lists = [input_lists]