New optional argument "sort" for listdir_matching()

Author: ehrenfeu

CHANGELOG.md

@@ -47,4 +47,6 @@
   * OME-TIFF filenames are now treated as special cases in the sense that the
     `.ome` part is stripped from the `basename` key and added to the `ext` key
     instead (as it is part of the suffix).
+* `imcflibs.pathtools.listdir_matching` now has an additional optional argument
+  `sort` (defaulting to `False`) to request the resulting list to be sorted.
 * Many improvements / clarifications in function docstrings.

src/imcflibs/pathtools.py

@@ -155,7 +155,7 @@ def jython_fiji_exists(path):
         return False
 
 
-def listdir_matching(path, suffix, fullpath=False):
+def listdir_matching(path, suffix, fullpath=False, sort=False):
     """Get a list of files in a directory matching a given suffix.
 
     Parameters
@@ -168,6 +168,9 @@ def listdir_matching(path, suffix, fullpath=False):
         If set to True, the list returned by the function will contain the full
         paths to the matching files (the default is False, which will result in
         the file names only, without path).
+    sort : bool, optional
+        If set to True, the returned list will be sorted using Python's built-in
+        `sorted()` call. By default False.
 
     Returns
     -------
@@ -183,6 +186,9 @@ def listdir_matching(path, suffix, fullpath=False):
             else:
                 matching_files.append(candidate)
 
+    if sort:
+        matching_files = sorted(matching_files)
+
     return matching_files