Normalise Windows paths

Author: snejus

beets/dbcore/pathutils.py

@@ -4,8 +4,10 @@
 from typing import TypeVar
 
 from beets import context, util
+from beets.util import path_as_posix
 
 MaybeBytes = TypeVar("MaybeBytes", bytes, None)
+DB_PATH_SEP = b"/"
 
 
 def _is_same_path_or_child(path: bytes, music_dir: bytes) -> bool:
@@ -17,6 +19,16 @@ def _is_same_path_or_child(path: bytes, music_dir: bytes) -> bool:
     )
 
 
+def _to_db_path(path: bytes) -> bytes:
+    """Store relative paths with a platform-neutral separator."""
+    return path_as_posix(path)
+
+
+def _from_db_path(path: bytes) -> bytes:
+    """Convert a stored relative path to the current platform syntax."""
+    return path.replace(DB_PATH_SEP, os.fsencode(os.sep))
+
+
 def normalize_path_for_db(path: MaybeBytes) -> MaybeBytes:
     """Convert an absolute library path to its database representation."""
     if not path or not os.path.isabs(path):
@@ -27,7 +39,7 @@ def normalize_path_for_db(path: MaybeBytes) -> MaybeBytes:
         return path
 
     if _is_same_path_or_child(path, music_dir):
-        return os.path.relpath(path, music_dir)
+        return _to_db_path(os.path.relpath(path, music_dir))
 
     return path
 
@@ -36,6 +48,6 @@ def expand_path_from_db(path: bytes) -> bytes:
     """Convert a stored database path to an absolute library path."""
     music_dir = context.get_music_dir()
     if path and not os.path.isabs(path) and music_dir:
-        return util.normpath(os.path.join(music_dir, path))
+        return util.normpath(os.path.join(music_dir, _from_db_path(path)))
 
     return path

beets/library/models.py

@@ -112,12 +112,11 @@ def field_query(
         ):
             # Regex, exact, and string queries operate on the raw DB value, so
             # strip the library prefix to match the stored relative path.
-            if isinstance(pattern, bytes):
-                pattern = normalize_path_for_db(pattern)
-            else:
-                pattern = os.fsdecode(
-                    normalize_path_for_db(util.bytestring_path(pattern))
-                )
+            bytes_pattern = normalize_path_for_db(util.bytestring_path(pattern))
+            if query_cls is not dbcore.query.RegexpQuery:
+                bytes_pattern = util.path_as_posix(bytes_pattern)
+            pattern = os.fsdecode(bytes_pattern)
+
         if field in cls.shared_db_fields:
             # This field exists in both tables, so SQLite will encounter
             # an OperationalError if we try to use it in a query.

test/library/test_migrations.py

@@ -8,6 +8,7 @@
 from beets.library import migrations
 from beets.library.models import Album, Item
 from beets.test.helper import TestHelper
+from beets.util import path_as_posix
 
 
 class TestMultiGenreFieldMigration:
@@ -270,6 +271,6 @@ def test_migrate(self, helper: TestHelper):
             .execute("select path from items where id=?", (item.id,))
             .fetchone()[0]
         )
-        assert stored_path == os.fsencode(relative_path)
+        assert stored_path == path_as_posix(os.fsencode(relative_path))
         # and the item.path property still returns an absolute path
         assert item.path == absolute_path

test/test_library.py

@@ -34,7 +34,13 @@
 from beets.test import _common
 from beets.test._common import item
 from beets.test.helper import BeetsTestCase, ItemInDBTestCase, capture_log
-from beets.util import as_string, bytestring_path, normpath, syspath
+from beets.util import (
+    as_string,
+    bytestring_path,
+    normpath,
+    path_as_posix,
+    syspath,
+)
 
 # Shortcut to path normalization.
 np = util.normpath
@@ -1143,7 +1149,7 @@ def test_relative_path_is_stored(self):
         album = self.lib.add_album([self.i])
 
         assert self.i.path == absolute_path
-        assert stored_path == relative_path
+        assert stored_path == path_as_posix(relative_path)
         assert album.path == os.path.dirname(absolute_path)