]> kaliko git repositories - mpd-sima.git/blobdiff - sima/lib/meta.py
MPD client: Tries to resolve MusicBrainzArtistID when possible (fixed b36c71a)
[mpd-sima.git] / sima / lib / meta.py
index 2877b2fa833f7239d392c8cee9c110119360412d..e6b9f46229554e008422017281de51db7d9be680 100644 (file)
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# Copyright (c) 2013, 2014, 2015 Jack Kaliko <kaliko@azylum.org>
+# Copyright (c) 2013, 2014, 2015, 2021 kaliko <kaliko@azylum.org>
 #
 #  This file is part of sima
 #
 Defines some object to handle audio file metadata
 """
 
-try:
-    from collections.abc import Set # python >= 3.3
-except ImportError:
-    from collections import Set # python 3.2
+
+from collections.abc import Set
 import logging
 import re
 
-UUID_RE = r'^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$'
-# The Track Object is collapsing multiple tags into a single string using this
+UUID_RE = r'^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[89AB][a-f0-9]{3}-[a-f0-9]{12}$'
+#: The Track Object is collapsing multiple tags into a single string using this
 # separator. It is used then to split back the string to tags list.
 SEPARATOR = chr(0x1F)  # ASCII Unit Separator
 
@@ -46,7 +44,7 @@ def is_uuid4(uuid):
 
 class MetaException(Exception):
     """Generic Meta Exception"""
-    pass
+
 
 def mbidfilter(func):
     def wrapper(*args, **kwargs):
@@ -59,6 +57,15 @@ def mbidfilter(func):
     return wrapper
 
 
+def serialize(func):
+    def wrapper(*args, **kwargs):
+        ans = func(*args, **kwargs)
+        if isinstance(ans, set):
+            return {s.replace("'", r"\'") for s in ans}
+        return ans.replace("'", r"\'")
+    return wrapper
+
+
 class Meta:
     """
     A generic Class to handle tracks metadata such as artist, album, albumartist
@@ -77,22 +84,22 @@ class Meta:
 
     def __init__(self, **kwargs):
         """Meta(name=<str>[, mbid=UUID4])"""
-        self.__name = None #TODO: should be immutable
+        self.__name = None  # TODO: should be immutable
         self.__mbid = None
         self.__aliases = set()
         self.log = logging.getLogger(__name__)
         if 'name' not in kwargs or not kwargs.get('name'):
             raise MetaException('Need a "name" argument (str type)')
-        elif not isinstance(kwargs.get('name'), str):
+        if not isinstance(kwargs.get('name'), str):
             raise MetaException('"name" argument not a string')
         else:
-            self.__name = kwargs.pop('name')
+            self.__name = kwargs.pop('name').split(SEPARATOR)[0]
         if 'mbid' in kwargs and kwargs.get('mbid'):
-            if is_uuid4(kwargs.get('mbid')):
-                self.__mbid = kwargs.pop('mbid').lower()
+            mbid = kwargs.get('mbid').lower().split(SEPARATOR)[0]
+            if is_uuid4(mbid):
+                self.__mbid = mbid
             else:
-                self.log.warning('Wrong mbid %s:%s', self.__name,
-                                 kwargs.get('mbid'))
+                self.log.warning('Wrong mbid %s:%s', self.__name, mbid)
             # mbid immutable as hash rests on
         self.__dict__.update(**kwargs)
 
@@ -110,9 +117,9 @@ class Meta:
         #if hasattr(other, 'mbid'):  # better isinstance?
         if isinstance(other, Meta) and self.mbid and other.mbid:
             return self.mbid == other.mbid
-        elif isinstance(other, Meta):
+        if isinstance(other, Meta):
             return bool(self.names & other.names)
-        elif getattr(other, '__str__', None):
+        if getattr(other, '__str__', None):
             # is other.__str__() in self.__name or self.__aliases
             return other.__str__() in self.names
         return False
@@ -129,12 +136,12 @@ class Meta:
 
         :param str other: Alias to add, could be any object with ``__str__`` method.
         """
+        if isinstance(other, Meta):
+            self.__aliases |= other.__aliases
+            self.__aliases -= {self.name}
         if getattr(other, '__str__', None):
             if callable(other.__str__) and other.__str__() != self.name:
                 self.__aliases |= {other.__str__()}
-        elif isinstance(other, Meta):
-            if other.name != self.name:
-                self.__aliases |= other.__aliases
         else:
             raise MetaException('No __str__ method found in {!r}'.format(other))
 
@@ -142,6 +149,11 @@ class Meta:
     def name(self):
         return self.__name
 
+    @property
+    @serialize
+    def name_sz(self):
+        return self.name
+
     @property
     def mbid(self):
         return self.__mbid
@@ -150,35 +162,50 @@ class Meta:
     def aliases(self):
         return self.__aliases
 
+    @property
+    @serialize
+    def aliases_sz(self):
+        return self.aliases
+
     @property
     def names(self):
         """aliases + name"""
         return self.__aliases | {self.__name,}
 
+    @property
+    @serialize
+    def names_sz(self):
+        return self.names
+
 
 class Album(Meta):
     """Album object"""
 
+    @mbidfilter
+    def __init__(self, name=None, mbid=None, **kwargs):
+        if kwargs.get('musicbrainz_albumid', False):
+            mbid = kwargs.get('musicbrainz_albumid')
+        super().__init__(name=name, mbid=mbid, **kwargs)
+
     @property
     def album(self):
         return self.name
 
+
 class Artist(Meta):
     """Artist object deriving from :class:`Meta`.
 
     :param str name: Artist name
     :param str mbid: Musicbrainz artist ID
     :param str artist: Overrides "name" argument
-    :param str albumartist: Overrides "name" and "artist" argument
+    :param str albumartist: use "name" if not set
     :param str musicbrainz_artistid: Overrides "mbid" argument
-    :param str musicbrainz_albumartistid: Overrides "musicbrainz_artistid" argument
 
     :Example:
 
     >>> trk = {'artist':'Art Name',
     >>>        'albumartist': 'Alb Art Name',           # optional
     >>>        'musicbrainz_artistid': '<UUID4>',       # optional
-    >>>        'musicbrainz_albumartistid': '<UUID4>',  # optional
     >>>       }
     >>> artobj0 = Artist(**trk)
     >>> artobj1 = Artist(name='Tool')
@@ -187,16 +214,14 @@ class Artist(Meta):
     @mbidfilter
     def __init__(self, name=None, mbid=None, **kwargs):
         if kwargs.get('artist', False):
-            name = kwargs.get('artist').split(SEPARATOR)[0]
+            name = kwargs.get('artist')
         if kwargs.get('musicbrainz_artistid', False):
-            mbid = kwargs.get('musicbrainz_artistid').split(SEPARATOR)[0]
-        if (kwargs.get('albumartist', False) and
-                kwargs.get('albumartist') != 'Various Artists'):
-            name = kwargs.get('albumartist').split(SEPARATOR)[0]
-        if (kwargs.get('musicbrainz_albumartistid', False) and
-                kwargs.get('musicbrainz_albumartistid') != '89ad4ac3-39f7-470e-963a-56509c546377'):
-            mbid = kwargs.get('musicbrainz_albumartistid').split(SEPARATOR)[0]
-        super().__init__(name=name, mbid=mbid)
+            mbid = kwargs.get('musicbrainz_artistid')
+        if name and not kwargs.get('albumartist', False):
+            kwargs['albumartist'] = name.split(SEPARATOR)[0]
+        super().__init__(name=name, mbid=mbid,
+                         albumartist=kwargs.get('albumartist'))
+
 
 class MetaContainer(Set):