list_dirs_containing_filetype() -> find_dirs_containing_filetype()

This is done to avoid confusion with listdir_matching() (and also the
Python os.listdir() from the standard library) as the "listdir"
functions are returning entries (files and sub-folders) in a given path
whereas this function is assembling a list of directories that fulfill a
given criteria, hence the "find_dirs" prefix.

Author: ehrenfeu

CHANGELOG.md

@@ -10,6 +10,7 @@
   * `imcflibs.pathtools.join2` can be used to join paths, much like
     `os.path.join` except that it will work with `java.io.File` objects as well
     (but doesn't support more than two path components / parameters).
+  * `imcflibs.pathtools.find_dirs_containing_filetype`
 * New functions in `imcflibs.imagej.misc`:
   * `imcflibs.imagej.misc.calculate_mean_and_stdv`
   * `imcflibs.imagej.misc.elapsed_time_since`

src/imcflibs/pathtools.py

@@ -263,21 +263,21 @@ def derive_out_dir(in_dir, out_dir):
     return out_dir
 
 
-def list_dirs_containing_filetype(source, filetype):
-    """List all directories (recursive) that contain files with the given suffix.
+def find_dirs_containing_filetype(source, filetype):
+    """Recursively list directories containing files with a given suffix.
 
     Parameters
     ----------
     source : str
-        Path to source dir.
+        Path to base directory to start recursive search in.
     filetype : str
         Filetype (string pattern) that should be matched against filenames in
         the directories.
 
     Returns
     -------
     list(str)
-        List of all dirs that contain files of the given filetype.
+        List of all dirs that contain files with the given suffix / filetype.
     """
     dirs_containing_filetype = []