Fix for filenames with special characters, #561, #618

tests/test_utils.py

@@ -1,27 +1,33 @@
+import logging
+import os.path
+import pathlib
+import tempfile
+
 import pytest
 
+import osxphotos
+
 DB_LOCKED_10_12 = "./tests/Test-Lock-10_12.photoslibrary/database/photos.db"
 DB_LOCKED_10_15 = "./tests/Test-Lock-10_15_1.photoslibrary/database/Photos.sqlite"
 DB_UNLOCKED_10_15 = "./tests/Test-10.15.1.photoslibrary/database/photos.db"
 
 UTI_DICT = {"public.jpeg": "jpeg", "com.canon.cr2-raw-image": "cr2"}
 
+from osxphotos.utils import (
+    _dd_to_dms,
+    increment_filename,
+    increment_filename_with_count,
+    list_directory,
+)
+
 
 def test_debug_enable():
-    import logging
-
-    import osxphotos
-
     osxphotos._set_debug(True)
     logger = osxphotos._get_logger()
     assert logger.isEnabledFor(logging.DEBUG)
 
 
 def test_debug_disable():
-    import logging
-
-    import osxphotos
-
     osxphotos._set_debug(False)
     logger = osxphotos._get_logger()
     assert not logger.isEnabledFor(logging.DEBUG)
@@ -29,14 +35,12 @@ def test_debug_disable():
 
 def test_dd_to_dms():
     # expands coverage for edge case in _dd_to_dms
-    from osxphotos.utils import _dd_to_dms
 
     assert _dd_to_dms(-0.001) == (0, 0, -3.6)
 
 
 @pytest.mark.skip(reason="Fails on some machines")
 def test_get_system_library_path():
-    import osxphotos
 
     _, major, _ = osxphotos.utils._get_os_version()
     if int(major) < 15:
@@ -46,51 +50,73 @@ def test_get_system_library_path():
 
 
 def test_db_is_locked_locked():
-    import osxphotos
 
     assert osxphotos.utils._db_is_locked(DB_LOCKED_10_12)
     assert osxphotos.utils._db_is_locked(DB_LOCKED_10_15)
 
 
 def test_db_is_locked_unlocked():
-    import osxphotos
 
     assert not osxphotos.utils._db_is_locked(DB_UNLOCKED_10_15)
 
 
-def test_findfiles():
-    import os.path
-    import tempfile
-
-    from osxphotos.utils import findfiles
+def test_list_directory():
+    """test list_directory"""
 
     temp_dir = tempfile.TemporaryDirectory(prefix="osxphotos_")
-    fd = open(os.path.join(temp_dir.name, "file1.jpg"), "w+")
-    fd.close
-    fd = open(os.path.join(temp_dir.name, "file2.JPG"), "w+")
-    fd.close
-    files = findfiles("*.jpg", temp_dir.name)
+    temp_dir_name = pathlib.Path(temp_dir.name)
+    file1 = (temp_dir_name / "file1.jpg").touch()
+    file2 = (temp_dir_name / "File2.JPG").touch()
+    file3 = (temp_dir_name / "File.png").touch()
+    file4 = (temp_dir_name / "document.pdf").touch()
+
+    files = list_directory(temp_dir.name, glob="*.jpg")
     assert len(files) == 2
     assert "file1.jpg" in files
-    assert "file2.JPG" in files
+    assert "File2.JPG" in files
+    assert isinstance(files[0], str)
+
+    files = list_directory(temp_dir.name, glob="*.jpg", case_sensitive=True)
+    assert len(files) == 1
+    assert "file1.jpg" in files
+
+    files = list_directory(temp_dir.name, startswith="file")
+    assert len(files) == 3
+
+    files = list_directory(temp_dir.name, endswith="jpg")
+    assert len(files) == 2
+
+    files = list_directory(temp_dir.name, contains="doc")
+    assert len(files) == 1
+    assert "document.pdf" in files
+
+    files = list_directory(temp_dir.name, startswith="File", case_sensitive=True)
+    assert len(files) == 2
+
+    files = list_directory(temp_dir.name, startswith="File", case_sensitive=False)
+    assert len(files) == 3
+
+    files = list_directory(temp_dir.name, startswith="document", include_path=True)
+    assert len(files) == 1
+    assert files[0] == str(pathlib.Path(temp_dir.name) / "document.pdf")
+
+    # test pathlib.Path
+    files = list_directory(temp_dir_name, glob="*.jpg")
+    assert isinstance(files[0], pathlib.Path)
+
+    files = list_directory(temp_dir.name, glob="FooBar*.jpg")
+    assert not files
 
 
-def test_findfiles_invalid_dir():
-    import tempfile
-
-    from osxphotos.utils import findfiles
+def test_list_directory_invalid():
 
     temp_dir = tempfile.TemporaryDirectory(prefix="osxphotos_")
-    files = findfiles("*.jpg", f"{temp_dir.name}/no_such_dir")
+    files = list_directory(f"{temp_dir.name}/no_such_dir", glob="*.jpg")
     assert len(files) == 0
 
 
 def test_increment_filename():
     # test that increment_filename works
-    import pathlib
-    import tempfile
-
-    from osxphotos.utils import increment_filename, increment_filename_with_count
 
     with tempfile.TemporaryDirectory(prefix="osxphotos_") as temp_dir:
         temp_dir = pathlib.Path(temp_dir)