Ignore folders, system and hidden files

Author: Avasam

src/split_parser.py

@@ -1,14 +1,17 @@
 import os
 from collections.abc import Callable
 from functools import partial
+import sys
 from typing import TYPE_CHECKING, TypeVar
 
 import error_messages
 from AutoSplitImage import RESET_KEYWORD, START_KEYWORD, AutoSplitImage, ImageType
 from utils import is_valid_image
+from stat import FILE_ATTRIBUTE_HIDDEN, FILE_ATTRIBUTE_SYSTEM, UF_HIDDEN
 
 if TYPE_CHECKING:
     from AutoSplit import AutoSplit
+    from _typeshed import StrPath
 
 (
     DUMMY_FLAG,
@@ -193,13 +196,39 @@ def validate_before_parsing(autosplit: "AutoSplit", *, show_error: bool = True):
     return not error
 
 
-def parse_and_validate_images(autosplit: "AutoSplit"):
-    # Get split images
-    all_images = [
-        AutoSplitImage(os.path.join(autosplit.settings_dict["split_image_directory"], image_name))
-        for image_name in os.listdir(autosplit.settings_dict["split_image_directory"])
-    ]
+def is_user_file(path: StrPath):
+    """Returns False for hidden files, system files and folders."""
+    if os.path.isdir(path) or os.path.basename(path).startswith("."):
+        return False
+    if sys.platform == "darwin":
+        return not (os.stat(path).st_mode & UF_HIDDEN)
+    if sys.platform == "win32":
+        st_file_attributes = os.stat(path).st_file_attributes
+        return not (
+            (st_file_attributes & FILE_ATTRIBUTE_SYSTEM)
+            | (st_file_attributes & FILE_ATTRIBUTE_HIDDEN)
+        )
+
+
+def __get_images_from_directory(directory: StrPath):
+    """Returns a list of AutoSplitImage parsed from a directory.
+    Hidden files, system files and folders are silently ignored."""
+    file_paths = (
+        os.path.join(directory, filename)  # format: skip
+        for filename in os.listdir(directory)
+    )
+    filtered_image_paths = (
+        image_path  # format: skip
+        for image_path in file_paths
+        if is_user_file(image_path)
+    )
+    return [AutoSplitImage(image_path) for image_path in filtered_image_paths]
 
+
+def parse_and_validate_images(autosplit: "AutoSplit"):
+    all_images = __get_images_from_directory(
+        autosplit.settings_dict["split_image_directory"]
+    )
     # Find non-split images and then remove them from the list
     start_image = __pop_image_type(all_images, ImageType.START)
     reset_image = __pop_image_type(all_images, ImageType.RESET)
@@ -245,12 +274,16 @@ def parse_and_validate_images(autosplit: "AutoSplit"):
 
             # Check that there's only one Reset Image
             if image.image_type == ImageType.RESET:
-                error_message = lambda: error_messages.multiple_keyword_images(RESET_KEYWORD)  # noqa: E731
+                error_message = lambda: error_messages.multiple_keyword_images(
+                    RESET_KEYWORD
+                )  # noqa: E731
                 break
 
             # Check that there's only one Start Image
             if image.image_type == ImageType.START:
-                error_message = lambda: error_messages.multiple_keyword_images(START_KEYWORD)  # noqa: E731
+                error_message = lambda: error_messages.multiple_keyword_images(
+                    START_KEYWORD
+                )  # noqa: E731
                 break
 
     if error_message: