# -*- coding: utf-8 -*-
-# Copyright (c) 2013, 2014 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
"""
-from .simastr import SimaStr
+
+from collections.abc import Set
+import logging
+import re
+
+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
+
+def is_uuid4(uuid):
+ """Controls MusicBrainz UUID4 format
+
+ :param str uuid: String representing the UUID
+ :returns: boolean
+ """
+ regexp = re.compile(UUID_RE, re.IGNORECASE)
+ if regexp.match(uuid):
+ return True
+ return False
class MetaException(Exception):
"""Generic Meta Exception"""
- pass
-class NotSameArtist(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
+
+
+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:
- """Generic Class for Meta object"""
+ """
+ A generic Class to handle tracks metadata such as artist, album, albumartist
+ names and their associated MusicBrainz's ID.
+
+
+ Using generic kwargs in constructor for convenience but the actual signature is:
+
+ >>> Meta(name, mbid=None, **kwargs)
+
+ :param str name: set name attribute
+ :param str mbid: set MusicBrainz ID
+ """
+ use_mbid = True
+ """Class attribute to disable use of MusicBrainz IDs"""
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)
+ """Meta(name=<str>[, mbid=UUID4])"""
+ 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)')
+ if not isinstance(kwargs.get('name'), str):
+ raise MetaException('"name" argument not a string')
+ else:
+ self.__name = kwargs.pop('name').split(SEPARATOR)[0]
+ if 'mbid' in kwargs and kwargs.get('mbid'):
+ 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, 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:
- return self.mbid == other.mbid
- return SimaStr(str(self)) == SimaStr(str(other))
+ #if hasattr(other, 'mbid'): # better isinstance?
+ if isinstance(other, Meta) and self.mbid and other.mbid:
+ return self.mbid == other.mbid
+ if isinstance(other, Meta):
+ return bool(self.names & other.names)
+ if getattr(other, '__str__', None):
+ # is other.__str__() in self.__name or self.__aliases
+ return other.__str__() in self.names
+ 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):
+ """Add alternative name to `aliases` attibute.
+
+ `other` can be a :class:`sima.lib.meta.Meta` object in which case aliases are merged.
+
+ :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__()}
else:
- return id(self)
+ raise MetaException('No __str__ method found in {!r}'.format(other))
- def __bool__(self): # empty name not possible for a valid obj
- return bool(self.name)
+ @property
+ def name(self):
+ return self.__name
-class Album(Meta):
- __hash__ = Meta.__hash__
+ @property
+ @serialize
+ def name_sz(self):
+ return self.name
- def __init__(self, **kwargs):
- super().__init__(**kwargs)
+ @property
+ def mbid(self):
+ return self.__mbid
- 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)
+ @property
+ 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):
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: use "name" if not set
+ :param str musicbrainz_artistid: Overrides "mbid" argument
+
+ :Example:
+
+ >>> trk = {'artist':'Art Name',
+ >>> 'albumartist': 'Alb Art Name', # optional
+ >>> 'musicbrainz_artistid': '<UUID4>', # optional
+ >>> }
+ >>> artobj0 = Artist(**trk)
+ >>> artobj1 = Artist(name='Tool')
+ """
+
+ @mbidfilter
+ def __init__(self, name=None, mbid=None, **kwargs):
+ if kwargs.get('artist', False):
+ name = kwargs.get('artist')
+ if kwargs.get('musicbrainz_artistid', False):
+ 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):
+
+ def __init__(self, iterable):
+ self.elements = lst = []
+ for value in iterable:
+ if value not in lst:
+ lst.append(value)
+ else:
+ for inlst in lst:
+ if value == inlst:
+ inlst.add_alias(value)
- def __init__(self, **kwargs):
- self._aliases = set()
- super().__init__(**kwargs)
+ def __iter__(self):
+ return iter(self.elements)
- def append(self, name):
- self._aliases.update({name,})
+ def __contains__(self, value):
+ return value in self.elements
- @property
- def names(self):
- 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))
+ def __len__(self):
+ return len(self.elements)
+
+ def __repr__(self):
+ return repr(self.elements)
+# VIM MODLINE
# vim: ai ts=4 sw=4 sts=4 expandtab
home / dev / repositories / mpd-sima.git / blobdiff