from difflib import get_close_matches
from functools import wraps
from logging import getLogger
+from select import select
# external module
from musicpd import MPDClient, MPDError
from .lib.track import Track
from .lib.simastr import SimaStr
from .utils.leven import levenshtein_ratio
+from .utils.utils import MPDSimaException
-class PlayerError(Exception):
+class PlayerError(MPDSimaException):
"""Fatal error in the player."""
cls = args[0]
if not cls.database:
return func(*args, **kwargs)
- results = func(*args, **kwargs)
- if not results:
+ result = func(*args, **kwargs)
+ if not result:
return None
- for art in results.names:
- mbid = results.mbid
- if not mbid:
- mbid = cls._find_musicbrainz_artistid(results)
- artist = Artist(name=art, mbid=mbid)
+ for art in result.names:
+ artist = Artist(name=art, mbid=result.mbid)
if cls.database.get_bl_artist(artist, add=False):
cls.log.debug('Artist in blocklist: %s', artist)
return None
- return results
+ return result
+ return wrapper
+
+
+def set_artist_mbid(func):
+ def wrapper(*args, **kwargs):
+ cls = args[0]
+ result = func(*args, **kwargs)
+ if Meta.use_mbid:
+ if result and not result.mbid:
+ mbid = cls._find_musicbrainz_artistid(result)
+ artist = Artist(name=result.name, mbid=mbid)
+ artist.add_alias(result)
+ return artist
+ return result
return wrapper
def tracks_wrapper(func):
- """Convert plain track mapping as returned by MPDClient into :py:obj:Track
+ """Convert plain track mapping as returned by MPDClient into :py:obj:`sima.lib.track.Track`
objects. This decorator accepts single track or list of tracks as input.
"""
@wraps(func)
"""
Player instance inheriting from MPDClient (python-musicpd).
- Some methods are overridden to format objects as sima.lib.Track for
+ Some methods are overridden to format objects as :py:obj:`sima.lib.track.Track` for
instance, other are calling parent class directly through super().
cf. MPD.__getattr__
def __init__(self, config):
super().__init__()
+ self.socket_timeout = 10
self.use_mbid = True
self.log = getLogger('sima')
self.config = config
def __getattr__(self, cmd):
"""Wrapper around MPDClient calls for abstract overriding"""
track_wrapped = {'currentsong', 'find', 'playlistinfo', }
- if cmd in track_wrapped:
- return tracks_wrapper(super().__getattr__(cmd))
- return super().__getattr__(cmd)
+ try:
+ if cmd in track_wrapped:
+ return tracks_wrapper(super().__getattr__(cmd))
+ return super().__getattr__(cmd)
+ except OSError as err: # socket errors
+ raise PlayerError(err) from err
+ except MPDError as err: # hight level MPD client errors
+ raise PlayerError(err) from err
def disconnect(self):
"""Overriding explicitly MPDClient.disconnect()"""
try:
super().connect(host, port)
# Catch socket errors
- except IOError as err:
- raise PlayerError('Could not connect to "%s:%s": %s' %
- (host, port, err.strerror))
+ except OSError as err:
+ raise PlayerError(f'Could not connect to "{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))
+ raise PlayerError(f'Could not connect to "{host}:{port}": {err}') from err
if password:
try:
self.password(password)
- except (MPDError, IOError) as err:
- raise PlayerError("Could not connect to '%s': %s" % (host, err))
+ except (MPDError, OSError) as err:
+ raise PlayerError(f"Could not connect to '{host}': {err}") from err
# 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))
+ 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()))
+ 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)
# 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!')
* skipped current track skipped
"""
curr = self.current
- try:
- ret = self.idle('database', 'playlist', 'player', 'options')
- except (MPDError, IOError) as err:
- raise PlayerError("Couldn't init idle: %s" % err)
- if self._skipped_track(curr):
- ret.append('skipped')
- if 'database' in ret:
- self._reset_cache()
- return ret
+ select_timeout = 5
+ while True:
+ self.send_idle('database', 'playlist', 'player', 'options')
+ _read, _, _ = select([self], [], [], select_timeout)
+ if _read: # tries to read response
+ ret = self.fetch_idle()
+ if self._skipped_track(curr):
+ ret.append('skipped')
+ if 'database' in ret:
+ 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
def clean(self):
"""Clean blocking event (idle) and pending commands
def add(self, payload):
"""Overriding MPD's add method to accept Track objects
- :param Track,list payload: Either a single :py:obj:`Track` or a list of it
+ :param Track,list payload: Either a single track or a list of it
"""
if isinstance(payload, Track):
super().__getattr__('add')(payload.file)
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
>>> player.find_tracks(Album('In Utero', artist=Artist('Nirvana'))
:param Artist,Album what: Artist or Album to fetch track from
-
- Returns a list of :py:obj:Track objects
+ :return: A list of track objects
+ :rtype: list(Track)
"""
if isinstance(what, Artist):
return self._find_art(what)
for name in artist.names:
tracks |= set(self.find('artist', name))
# album blocklist
- albums = {Album(trk.album, mbid=trk.musicbrainz_albumid)
+ albums = {Album(trk.Album.name, mbid=trk.musicbrainz_albumid)
for trk in tracks}
bl_albums = {Album(a.get('album'), mbid=a.get('musicbrainz_album'))
for a in self.database.view_bl() if a.get('album')}
# #### Search Methods #####
def _find_musicbrainz_artistid(self, artist):
+ """Find MusicBrainzArtistID when possible.
+ """
if not self.use_mbid:
return None
- mbids = self.list('MUSICBRAINZ_ARTISTID',
- f'(artist == "{artist.name_sz}")')
+ mbids = None
+ for name in artist.names_sz:
+ filt = f'((artist == "{name}") AND (MUSICBRAINZ_ARTISTID != ""))'
+ mbids = self.list('MUSICBRAINZ_ARTISTID', filt)
+ if mbids:
+ break
if not mbids:
return None
if len(mbids) > 1:
artist.name, mbids[0], artist.mbid)
else:
return mbids[0]
+ return None
@bl_artist
+ @set_artist_mbid
def search_artist(self, artist):
"""
Search artists based on a fuzzy search in the media library
>>> ['The Beatles', 'Beatles', 'the beatles']
:param Artist artist: Artist to look for in MPD music library
-
- Returns an Artist object
+ :return: Artist object
+ :rtype: Artist
"""
found = False
if artist.mbid:
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
home / dev / repositories / mpd-sima.git / blobdiff