Say bye to util._fsencoding

Author: snejus

beets/util/__init__.py

@@ -376,21 +376,6 @@ def arg_encoding() -> str:
     return sys.getfilesystemencoding()
 
 
-def _fsencoding() -> str:
-    """Get the system's filesystem encoding. On Windows, this is always
-    UTF-8 (not MBCS).
-    """
-    encoding = sys.getfilesystemencoding() or sys.getdefaultencoding()
-    if encoding == "mbcs":
-        # On Windows, a broken encoding known to Python as "MBCS" is
-        # used for the filesystem. However, we only use the Unicode API
-        # for Windows paths, so the encoding is actually immaterial so
-        # we can avoid dealing with this nastiness. We arbitrarily
-        # choose UTF-8.
-        encoding = "utf-8"
-    return encoding
-
-
 def bytestring_path(path: PathLike) -> bytes:
     """Given a path, which is either a bytes or a unicode, returns a str
     path (ensuring that we never deal with Unicode pathnames). Path should be
@@ -432,10 +417,7 @@ def displayable_path(
         # A non-string object: just get its unicode representation.
         return str(path)
 
-    try:
-        return path.decode(_fsencoding(), "ignore")
-    except (UnicodeError, LookupError):
-        return path.decode("utf-8", "ignore")
+    return os.fsdecode(path)
 
 
 def syspath(path: PathLike, prefix: bool = True) -> str:

beetsplug/ipfs.py

@@ -20,7 +20,6 @@
 
 from beets import config, library, ui, util
 from beets.plugins import BeetsPlugin
-from beets.util import syspath
 
 
 class IPFSPlugin(BeetsPlugin):
@@ -193,7 +192,7 @@ def ipfs_get_from_hash(self, lib, _hash):
         # This uses a relative path, hence we cannot use util.syspath(_hash,
         # prefix=True). However, that should be fine since the hash will not
         # exceed MAX_PATH.
-        shutil.rmtree(syspath(_hash, prefix=False))
+        shutil.rmtree(util.syspath(_hash, prefix=False))
 
     def ipfs_publish(self, lib):
         with tempfile.NamedTemporaryFile() as tmp:
@@ -299,9 +298,7 @@ def create_new_album(self, album, tmplib):
                     break
             except AttributeError:
                 pass
-            item_path = os.path.basename(item.path).decode(
-                util._fsencoding(), "ignore"
-            )
+            item_path = os.fsdecode(os.path.basename(item.path))
             # Clear current path from item
             item.path = f"/ipfs/{album.ipfs}/{item_path}"
 

beetsplug/thumbnails.py

@@ -27,7 +27,6 @@
 
 from xdg import BaseDirectory
 
-from beets import util
 from beets.plugins import BeetsPlugin
 from beets.ui import Subcommand, decargs
 from beets.util import bytestring_path, displayable_path, syspath
@@ -288,6 +287,6 @@ def uri(self, path):
             self.libgio.g_free(uri_ptr)
 
         try:
-            return uri.decode(util._fsencoding())
+            return os.fsdecode(uri)
         except UnicodeDecodeError:
             raise RuntimeError(f"Could not decode filename from GIO: {uri!r}")

beetsplug/web/__init__.py

@@ -315,13 +315,8 @@ def item_file(item_id):
         item_path = os.fsdecode(item.path)
 
     base_filename = os.path.basename(item_path)
-    # FIXME: Arguably, this should just use `displayable_path`: The latter
-    # tries `_fsencoding()` first, but then falls back to `utf-8`, too.
     if isinstance(base_filename, bytes):
-        try:
-            unicode_base_filename = base_filename.decode("utf-8")
-        except UnicodeError:
-            unicode_base_filename = util.displayable_path(base_filename)
+        unicode_base_filename = util.displayable_path(base_filename)
     else:
         unicode_base_filename = base_filename
 

test/plugins/test_convert.py

@@ -147,7 +147,7 @@ def run_convert_path(self, path, *args):
         """Run the `convert` command on a given path."""
         # The path is currently a filesystem bytestring. Convert it to
         # an argument bytestring.
-        path = path.decode(util._fsencoding()).encode(util.arg_encoding())
+        path = os.fsencode(os.fsdecode(path))
 
         args = args + (b"path:" + path,)
         return self.run_command("convert", *args)

test/plugins/test_ipfs.py

@@ -17,7 +17,7 @@
 
 from beets.test import _common
 from beets.test.helper import PluginTestCase
-from beets.util import _fsencoding, bytestring_path
+from beets.util import bytestring_path
 from beetsplug.ipfs import IPFSPlugin
 
 
@@ -36,9 +36,7 @@ def test_stored_hashes(self):
         for check_item in added_album.items():
             try:
                 if check_item.get("ipfs", with_album=False):
-                    ipfs_item = os.path.basename(want_item.path).decode(
-                        _fsencoding(),
-                    )
+                    ipfs_item = os.fsdecode(os.path.basename(want_item.path))
                     want_path = "/ipfs/{}/{}".format(test_album.ipfs, ipfs_item)
                     want_path = bytestring_path(want_path)
                     assert check_item.path == want_path