Move new functions from "iotools" to "pathtools"

Since they're not dealing with I/O but with directories and files they
are much better kept here.

Author: ehrenfeu

src/imcflibs/iotools.py

@@ -107,79 +107,3 @@ def readtxt(fname, path="", flat=False):
     if zipread is not None:
         zipread.close()
     return txt
-
-
-def list_dirs_containing_filetype(source, filetype):
-    """List all directories (recursive) that contain files with the given suffix.
-
-    Parameters
-    ----------
-    source : str
-        Path to source dir.
-    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.
-    """
-    dirs_containing_filetype = []
-
-    # walk recursively through all directories
-    # list their paths and all files inside (=os.walk)
-    for dirname, _, filenames in os.walk(source):
-        # stop when encountering a directory that contains "filetype"
-        # and store the directory path
-        for filename in filenames:
-            if filetype in filename:
-                dirs_containing_filetype.append(dirname + "/")
-                break
-
-    return dirs_containing_filetype
-
-
-def list_all_filenames(source, filetype):
-    """Get a sorted list of all files of specified filetype in a given directory.
-
-    Parameters
-    ----------
-    source : str
-        Path to the directory to scan for desired files.
-    filetype : str
-        The file extension to look for.
-
-    Returns
-    -------
-    list(str)
-        List of all files with the given suffix in the source directory.
-    """
-    os.chdir(str(source))
-    allimages = sorted(glob.glob("*" + filetype))  # sorted by name
-
-    return allimages
-
-
-def get_folder_size(source):
-    """Get the total size of a given directory and its subdirectories.
-
-    Parameters
-    ----------
-    source : str
-        Directory for which the size should be determined.
-
-    Returns
-    -------
-    int
-        The total size of all files in the source dir and subdirs in bytes.
-    """
-    total_size = 0
-    for dirpath, _, filenames in os.walk(source):
-        for fname in filenames:
-            fpath = os.path.join(dirpath, fname)
-            # skip if it is symbolic link
-            if not os.path.islink(fpath):
-                total_size += os.path.getsize(fpath)
-
-    return total_size

src/imcflibs/pathtools.py

@@ -263,6 +263,82 @@ 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.
+
+    Parameters
+    ----------
+    source : str
+        Path to source dir.
+    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.
+    """
+    dirs_containing_filetype = []
+
+    # walk recursively through all directories
+    # list their paths and all files inside (=os.walk)
+    for dirname, _, filenames in os.walk(source):
+        # stop when encountering a directory that contains "filetype"
+        # and store the directory path
+        for filename in filenames:
+            if filetype in filename:
+                dirs_containing_filetype.append(dirname + "/")
+                break
+
+    return dirs_containing_filetype
+
+
+def list_all_filenames(source, filetype):
+    """Get a sorted list of all files of specified filetype in a given directory.
+
+    Parameters
+    ----------
+    source : str
+        Path to the directory to scan for desired files.
+    filetype : str
+        The file extension to look for.
+
+    Returns
+    -------
+    list(str)
+        List of all files with the given suffix in the source directory.
+    """
+    os.chdir(str(source))
+    allimages = sorted(glob.glob("*" + filetype))  # sorted by name
+
+    return allimages
+
+
+def get_folder_size(source):
+    """Get the total size of a given directory and its subdirectories.
+
+    Parameters
+    ----------
+    source : str
+        Directory for which the size should be determined.
+
+    Returns
+    -------
+    int
+        The total size of all files in the source dir and subdirs in bytes.
+    """
+    total_size = 0
+    for dirpath, _, filenames in os.walk(source):
+        for fname in filenames:
+            fpath = os.path.join(dirpath, fname)
+            # skip if it is symbolic link
+            if not os.path.islink(fpath):
+                total_size += os.path.getsize(fpath)
+
+    return total_size
+
+
 # pylint: disable-msg=C0103
 #   we use the variable name 'exists' in its common spelling (lowercase), so
 #   removing this workaround will be straightforward at a later point