]> kaliko git repositories - mpd-sima.git/blobdiff - sima/lib/meta.py
simaecho get_toptrack set artist mbid if missing
[mpd-sima.git] / sima / lib / meta.py
index 4e481e64ab4bfd5349569ae61e70fe36dc15060b..78c6e790da198bc351e0c58c79a7307b5b5db2c0 100644 (file)
 Defines some object to handle audio file metadata
 """
 
-from .simastr import SimaStr
-from .track import Track
+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}$'
+
+def is_uuid4(uuid):
+    regexp = re.compile(UUID_RE, re.IGNORECASE)
+    if regexp.match(uuid):
+        return True
+    raise WrongUUID4(uuid)
 
 class MetaException(Exception):
     """Generic Meta Exception"""
     pass
 
-class NotSameArtist(MetaException):
+class WrongUUID4(MetaException):
     pass
 
+def mbidfilter(func):
+    def wrapper(*args, **kwargs):
+        cls = args[0]
+        if not cls.use_mbid:
+            kwargs.pop('mbid', None)
+            kwargs.pop('musicbrainz_artistid', None)
+            kwargs.pop('musicbrainz_albumartistid', None)
+        func(*args, **kwargs)
+    return wrapper
+
 
 class Meta:
-    """Generic Class for Meta object"""
+    """Generic Class for Meta object
+    Meta(name=<str>[, mbid=UUID4])
+    """
+    use_mbid = True
 
     def __init__(self, **kwargs):
-        self.name = None
-        self.mbid = None
-        if 'name' not in kwargs:
-            raise MetaException('need at least a "name" argument')
-        self.__dict__.update(kwargs)
+        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')
+        else:
+            self.__name = kwargs.pop('name')
+        if 'mbid' in kwargs and kwargs.get('mbid'):
+            try:
+                is_uuid4(kwargs.get('mbid'))
+                self.__mbid = kwargs.pop('mbid')
+            except WrongUUID4:
+                self.log.warning('Wrong mbid {}:{}'.format(self.__name,
+                                                         kwargs.get('mbid')))
+            # mbid immutable as hash rests on
+        self.__dict__.update(**kwargs)
 
     def __repr__(self):
-        fmt = '{0}(name="{1.name}", mbid="{1.mbid}")'
+        fmt = '{0}(name={1.name!r}, mbid={1.mbid!r})'
         return fmt.format(self.__class__.__name__, self)
 
     def __str__(self):
-        return str(self.name)
+        return self.__name.__str__()
 
     def __eq__(self, other):
         """
-        Perform mbid equality test if present,
-        else fallback on fuzzy equality
+        Perform mbid equality test
         """
-        if hasattr(other, 'mbid'):
-            if other.mbid and self.mbid:
+        #if hasattr(other, 'mbid'):  # better isinstance?
+        if isinstance(other, Meta) and self.mbid and other.mbid:
+            if self.mbid and other.mbid:
                 return self.mbid == other.mbid
-        return SimaStr(str(self)) == SimaStr(str(other))
+        else:
+            return (other.__str__() == self.__str__() or
+                    other.__str__() in self.__aliases)
+        return False
 
     def __hash__(self):
-        if self.mbid is not None:
+        if self.mbid:
             return hash(self.mbid)
+        return hash(self.__name)
+
+    def add_alias(self, other):
+        if getattr(other, '__str__', None):
+            if callable(other.__str__):
+                self.__aliases |= {other.__str__()}
+        elif isinstance(other, Meta):
+            self.__aliases |= other.__aliases
         else:
-            return id(self)
-
-
-class Album(Meta):
-    __hash__ = Meta.__hash__
-
-    def __init__(self, **kwargs):
-        super().__init__(**kwargs)
-
-    def __eq__(self, other):
-        """
-        Perform mbid equality test if present,
-        else fallback on self.name equality
-        """
-        if hasattr(other, 'mbid'):
-            if other.mbid and self.mbid:
-                return self.mbid == other.mbid
-        return str(self) == str(other)
+            raise MetaException('No __str__ method found in {!r}'.format(other))
 
     @property
-    def album(self):
-        return self.name
-
-
-class Artist(Meta):
+    def name(self):
+        return self.__name
 
-    def __init__(self, **kwargs):
-        self._aliases = []
-        super().__init__(**kwargs)
+    @property
+    def mbid(self):
+        return self.__mbid
 
-    def append(self, name):
-        self._aliases.append(name)
+    @property
+    def aliases(self):
+        return self.__aliases
 
     @property
     def names(self):
-        return self._aliases + [self.name]
+        return self.__aliases | {self.__name,}
 
-    def __add__(self, other):
-        if isinstance(other, Artist):
-            if self.mbid == other.mbid:
-                res = Artist(**self.__dict__)
-                res._aliases.extend(other.names)
-                return res
-            else:
-                raise NotSameArtist('different mbids: {0} and {1}'.format(self, other))
 
+class Album(Meta):
 
-class TrackMB(Track):
+    @property
+    def album(self):
+        return self.name
 
-    def __init__(self, **kwargs):
-        super().__init__(**kwargs)
-        if hasattr(self, 'musicbrainz_artistid'):
-            self.artist = Artist(mbid=self.musicbrainz_artistid,
-                                 name=self.artist)
+class Artist(Meta):
 
+    @mbidfilter
+    def __init__(self, name=None, mbid=None, **kwargs):
+        """Artist object built from a mapping dict containing at least an
+        "artist" entry:
+            >>> trk = {'artist':'Art Name',
+            >>>        'albumartist': 'Alb Art Name',           # optional
+            >>>        'musicbrainz_artistid': '<UUID4>'    ,   # optional
+            >>>        'musicbrainz_albumartistid': '<UUID4>',  # optional
+            >>>       }
+            >>> artobj0 = Artist(**trk)
+            >>> artobj1 = Artist(name='Tool')
+        """
+        name = kwargs.get('artist', name)
+        mbid = kwargs.get('musicbrainz_artistid', mbid)
+        if (kwargs.get('albumartist', False) and
+                kwargs.get('albumartist') != 'Various Artists'):
+            name = kwargs.get('albumartist').split(', ')[0]
+        if (kwargs.get('musicbrainz_albumartistid', False) and
+                kwargs.get('musicbrainz_albumartistid') != '89ad4ac3-39f7-470e-963a-56509c546377'):
+            mbid = kwargs.get('musicbrainz_albumartistid').split(', ')[0]
+        super().__init__(name=name, mbid=mbid)
+
+# VIM MODLINE
 # vim: ai ts=4 sw=4 sts=4 expandtab
-