]> kaliko git repositories - mpd-sima.git/blobdiff - sima/mpdclient.py
Cleanup PlayerError exception wrapper
[mpd-sima.git] / sima / mpdclient.py
index 53a62d0ceddfe9bd74584494a210584e37c3f719..99f69474258a513cbe6567dce875b11f012c4446 100644 (file)
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# Copyright (c) 2009-2021 kaliko <kaliko@azylum.org>
+# Copyright (c) 2009-2022, 2024 kaliko <kaliko@azylum.org>
 #
 #  This file is part of sima
 #
@@ -23,7 +23,7 @@ from logging import getLogger
 from select import select
 
 # external module
-from musicpd import MPDClient, MPDError
+from musicpd import MPDClient, MPDError as PlayerError
 
 
 # local import
@@ -31,11 +31,7 @@ from .lib.meta import Meta, Artist, Album
 from .lib.track import Track
 from .lib.simastr import SimaStr
 from .utils.leven import levenshtein_ratio
-from .utils.utils import MPDSimaException
-
-
-class PlayerError(MPDSimaException):
-    """Fatal error in the player."""
+from .utils.utils import get_decorator
 
 
 # Some decorators
@@ -81,6 +77,9 @@ def tracks_wrapper(func):
             return Track(**ret)
         return [Track(**t) for t in ret]
     return wrapper
+
+# Decorator to wrap non MPDError exceptions from musicpd in PlayerError
+we = get_decorator(errors=(OSError, TimeoutError), wrap_into=PlayerError)
 # / decorators
 
 
@@ -121,15 +120,13 @@ class MPD(MPDClient):
         self._cache = None
 
     # ######### Overriding MPDClient ###########
+    @we
     def __getattr__(self, cmd):
         """Wrapper around MPDClient calls for abstract overriding"""
         track_wrapped = {'currentsong', 'find', 'playlistinfo', }
-        try:
-            if cmd in track_wrapped:
-                return tracks_wrapper(super().__getattr__(cmd))
-            return super().__getattr__(cmd)
-        except OSError as err:
-            raise PlayerError(err) from err
+        if cmd in track_wrapped:
+            return tracks_wrapper(super().__getattr__(cmd))
+        return super().__getattr__(cmd)
 
     def disconnect(self):
         """Overriding explicitly MPDClient.disconnect()"""
@@ -144,54 +141,37 @@ class MPD(MPDClient):
         port = mpd_config.get('port')
         password = mpd_config.get('password', fallback=None)
         self.disconnect()
-        try:
-            super().connect(host, port)
-        # Catch socket errors
-        except OSError as err:
-            raise PlayerError('Could not connect to "%s:%s": %s' %
-                              (host, port, err.strerror)) from err
-        # Catch all other possible errors
-        # ConnectionError and ProtocolError are always fatal.  Others may not
-        # be, but we don't know how to handle them here, so treat them as if
-        # they are instead of ignoring them.
-        except MPDError as err:
-            raise PlayerError('Could not connect to "%s:%s": %s' %
-                              (host, port, err)) from err
+        super().connect(host, port)
         if password:
-            try:
-                self.password(password)
-            except (MPDError, OSError) as err:
-                raise PlayerError("Could not connect to '%s': %s" % (host, err)) from err
+            self.password(password)
         # Controls we have sufficient rights
         available_cmd = self.commands()
         for cmd in MPD.needed_cmds:
             if cmd not in available_cmd:
                 self.disconnect()
-                raise PlayerError('Could connect to "%s", '
-                                  'but command "%s" not available' %
-                                  (host, cmd))
-        self.tagtypes('clear')
+                raise PlayerError(f'Could connect to "{host}", but command "{cmd}" not available')
+        self.tagtypes_clear()
         for tag in MPD.needed_tags:
-            self.tagtypes('enable', tag)
-        tt = set(map(str.lower, self.tagtypes()))
+            self.tagtypes_enable(tag)
+        ltt = set(map(str.lower, self.tagtypes()))
         needed_tags = set(map(str.lower, MPD.needed_tags))
-        if len(needed_tags & tt) != len(MPD.needed_tags):
-            self.log.warning('MPD exposes: %s', tt)
+        if len(needed_tags & ltt) != len(MPD.needed_tags):
+            self.log.warning('MPD exposes: %s', ltt)
             self.log.warning('Tags needed: %s', needed_tags)
             raise PlayerError('Missing mandatory metadata!')
         for tag in MPD.needed_mbid_tags:
-            self.tagtypes('enable', tag)
+            self.tagtypes_enable(tag)
         # Controls use of MusicBrainzIdentifier
         if self.config.getboolean('sima', 'musicbrainzid'):
-            tt = set(self.tagtypes())
-            if len(MPD.needed_mbid_tags & tt) != len(MPD.needed_mbid_tags):
+            ltt = set(self.tagtypes())
+            if len(MPD.needed_mbid_tags & ltt) != len(MPD.needed_mbid_tags):
                 self.log.warning('Use of MusicBrainzIdentifier is set but MPD '
                                  'is not providing related metadata')
-                self.log.info(tt)
+                self.log.info(ltt)
                 self.log.warning('Disabling MusicBrainzIdentifier')
                 self.use_mbid = Meta.use_mbid = False
             else:
-                self.log.debug('Available metadata: %s', tt)
+                self.log.debug('Available metadata: %s', ltt)
                 self.use_mbid = Meta.use_mbid = True
         else:
             self.log.warning('Use of MusicBrainzIdentifier disabled!')
@@ -227,6 +207,7 @@ class MPD(MPDClient):
             return False
         return self.current.id != previous.id  # pylint: disable=no-member
 
+    @we
     def monitor(self):
         """Monitor player for change
         Returns a list a events among:
@@ -250,10 +231,7 @@ class MPD(MPDClient):
                     self._reset_cache()
                 return ret
             #  Nothing to read, canceling idle
-            try:  # noidle cmd does not go through __getattr__, need to catch OSError then
-                self.noidle()
-            except OSError as err:
-                raise PlayerError(err) from err
+            self.noidle()
 
     def clean(self):
         """Clean blocking event (idle) and pending commands
@@ -263,6 +241,7 @@ class MPD(MPDClient):
         elif self._pending:
             self.log.warning('pending commands: %s', self._pending)
 
+    @we
     def add(self, payload):
         """Overriding MPD's add method to accept Track objects
 
@@ -294,7 +273,7 @@ class MPD(MPDClient):
         plm = {'repeat': None, 'single': None,
                'random': None, 'consume': None, }
         for key, val in self.status().items():
-            if key in plm.keys():
+            if key in plm:
                 plm.update({key: bool(int(val))})
         return plm
 
@@ -400,6 +379,7 @@ class MPD(MPDClient):
                          artist.name, mbids[0], artist.mbid)
         else:
             return mbids[0]
+        return None
 
     @bl_artist
     @set_artist_mbid
@@ -429,12 +409,6 @@ class MPD(MPDClient):
                         if SimaStr(artist.name) == name and name != artist.name:
                             self.log.debug('add alias for %s: %s', artist, name)
                             artist.add_alias(name)
-                elif len(library) == 1 and library[0] != artist.name:
-                    new_alias = artist.name
-                    self.log.info('Update artist name %s->%s', artist, library[0])
-                    self.log.debug('Also add alias for %s: %s', artist, new_alias)
-                    artist = Artist(name=library[0], mbid=artist.mbid)
-                    artist.add_alias(new_alias)
             # Fetches remaining artists for potential match
             artists = self._cache['nombid_artists']
         else:  # not using MusicBrainzIDs
@@ -558,9 +532,9 @@ class MPD(MPDClient):
                 if artist.mbid == album_trks[0].musicbrainz_albumartistid:
                     candidates.append(album)
                     continue
-                else:
-                    self.log.debug('Discarding "%s", "%r" not set as musicbrainz_albumartistid', album, album.Artist)
-                    continue
+                self.log.debug('Discarding "%s", "%r" not set as musicbrainz_albumartistid',
+                               album, album.Artist)
+                continue
             if 'Various Artists' in album_artists:
                 self.log.debug('Discarding %s ("Various Artists" set)', album)
                 continue