first commit

swingmusic/utils/filesystem.py

@@ -0,0 +1,87 @@
+import os
+from pathlib import Path
+
+FILES = ["flac", "mp3", "wav", "m4a", "ogg", "wma", "opus", "alac", "aiff"]
+SUPPORTED_FILES = tuple(f".{file}" for file in FILES)
+
+# INFO: Skip these paths when scanning
+# These are common directories that don't contain music files
+IGNORE_PATH_ENDSWITH = {
+    "node_modules",
+    "site-packages",
+    "postgres",
+    "__pycache__",
+    "/src",
+    "/learnrs",
+    "/venv",
+    "/code",
+    "/dist",
+    "/demos",
+    "/temp",
+}
+
+
+IGNORE_PATH_CONTAINS = {
+    "Photos Library",
+}
+
+
+def run_fast_scandir(path: str, full=False) -> tuple[list[str], list[str]]:
+    """
+    Scans a directory for files with a specific extension.
+    Returns a list of files and folders in the directory.
+
+    Note: Symlinks are followed but circular links are prevented by the
+    path resolution in Path.resolve() which detects and handles cycles.
+
+    :param path: folder to scan
+    :param full: will call recursively until end of path.
+    :return: (folder:[], files:[])
+    """
+
+    # filter out unwanted known folders
+    if isinstance(path, str) and path == "":
+        return [], []
+
+    path: Path = Path(path).resolve()
+
+    if any(
+        path.as_posix().endswith(ignore_path) for ignore_path in IGNORE_PATH_ENDSWITH
+    ):
+        return [], []
+
+    if any(ignore_path in path.as_posix() for ignore_path in IGNORE_PATH_CONTAINS):
+        return [], []
+
+    # if on mac, ignore Library folder and its children
+    if os.name == "posix":
+        library_path = (Path.home() / "Library").resolve()
+        if path == library_path or str(path).startswith(str(library_path)):
+            return [], []
+
+    subfolders = []
+    files = []
+
+    try:
+        for entry in path.iterdir():
+            if entry.is_dir():
+                if entry.name.startswith(".") or entry.name.startswith("$"):
+                    continue  # filter out system / hidden files
+                else:
+                    subfolders.append(entry)
+
+            if entry.is_file():
+                ext = entry.suffix.lower()
+                if ext in SUPPORTED_FILES:
+                    files.append(entry.as_posix())
+
+        if full or len(files) == 0:
+            for folder in subfolders:
+                sub_dirs, subfiles = run_fast_scandir(folder, full=True)
+                subfolders.extend(sub_dirs)
+                files.extend(subfiles)
+
+    except (OSError, PermissionError, FileNotFoundError, ValueError):
+        return [], []
+
+    return subfolders, files