move file walker into its own module

1 files changed, 31 insertions, 0 deletions

diff --git a/bsie/utils/filewalker.py b/bsie/utils/filewalker.py
new file mode 100644
index 0000000..3c36926
--- /dev/null
+++ b/bsie/utils/filewalker.py
@@ -0,0 +1,31 @@
+
+# standard imports
+import os
+import typing
+
+# exports
+__all__: typing.Sequence[str] = (
+    'list_files',
+    )
+
+
+## code ##
+
+def list_files(
+        roots: typing.Iterable[str],
+        recursive: bool = True,
+        follow_symlinks: bool = True,
+        ) -> typing.Iterator[str]:
+    """Iterate over all files in *roots*, recursively by default."""
+    # index input paths
+    for path in roots:
+        if not os.path.exists(path):
+            continue
+        elif os.path.isdir(path) and recursive:
+            for dirpath, _, filenames in os.walk(path, topdown=True, followlinks=follow_symlinks):
+                for filename in filenames:
+                    yield os.path.join(dirpath, filename)
+        elif os.path.isfile(path):
+            yield path
+
+## EOF ##