# -*- coding: utf-8 -*-
-# Copyright (c) 2013, 2014 Jack Kaliko <kaliko@azylum.org>
+# Copyright (c) 2013, 2014, 2015 kaliko <kaliko@azylum.org>
#
# This file is part of sima
#
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
+# 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
- raise WrongUUID4(uuid)
+ return False
class MetaException(Exception):
"""Generic Meta Exception"""
pass
-class WrongUUID4(MetaException):
- pass
-
def mbidfilter(func):
def wrapper(*args, **kwargs):
cls = args[0]
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
- Meta(name=<str>[, mbid=UUID4])
+ """
+ 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 #TODO: should be immutable
+ """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')
+ raise MetaException('Need a "name" argument (str type)')
+ elif not isinstance(kwargs.get('name'), str):
+ raise MetaException('"name" argument not a string')
else:
self.__name = kwargs.pop('name')
if 'mbid' in kwargs and kwargs.get('mbid'):
- try:
- is_uuid4(kwargs.get('mbid'))
+ if is_uuid4(kwargs.get('mbid')):
self.__mbid = kwargs.pop('mbid').lower()
- except WrongUUID4:
+ else:
self.log.warning('Wrong mbid %s:%s', self.__name,
kwargs.get('mbid'))
# mbid immutable as hash rests on
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 getattr(other, '__str__', None):
if callable(other.__str__) and other.__str__() != self.name:
self.__aliases |= {other.__str__()}
def name(self):
return self.__name
+ @property
+ @serialize
+ def name_sz(self):
+ return self.name
+
@property
def mbid(self):
return self.__mbid
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):
+ 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 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')
+ """
@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).split(', ')[0]
- mbid = kwargs.get('musicbrainz_artistid', mbid)
+ if kwargs.get('artist', False):
+ name = kwargs.get('artist').split(SEPARATOR)[0]
+ 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(', ')[0]
+ 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(', ')[0]
+ mbid = kwargs.get('musicbrainz_albumartistid').split(SEPARATOR)[0]
super().__init__(name=name, mbid=mbid)
class MetaContainer(Set):
home / dev / repositories / mpd-sima.git / blobdiff