X-Git-Url: https://git.kaliko.me/?a=blobdiff_plain;f=sima%2Flib%2Fmeta.py;h=069a904c8ec587079fcc13bbf3ef002c791d7961;hb=888614f7afac2b23fb473d209c54dcb69216b165;hp=44369a272e8cc51f1313d9b60519e0e59ac4589f;hpb=41048503e9b3cf0fdc58e14f35f483889a0b05ae;p=mpd-sima.git diff --git a/sima/lib/meta.py b/sima/lib/meta.py index 44369a2..069a904 100644 --- a/sima/lib/meta.py +++ b/sima/lib/meta.py @@ -1,5 +1,5 @@ # -*- coding: utf-8 -*- -# Copyright (c) 2013, 2014 Jack Kaliko +# Copyright (c) 2013, 2014, 2015 Jack Kaliko # # This file is part of sima # @@ -21,24 +21,33 @@ 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 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 +# 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] @@ -51,12 +60,23 @@ def mbidfilter(func): class Meta: - """Generic Class for Meta object - Meta(name=[, 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): + """Meta(name=[, mbid=UUID4])""" self.__name = None #TODO: should be immutable self.__mbid = None self.__aliases = set() @@ -66,12 +86,11 @@ class Meta: 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'))) + if is_uuid4(kwargs.get('mbid')): + self.__mbid = kwargs.pop('mbid').lower() + else: + self.log.warning('Wrong mbid %s:%s', self.__name, + kwargs.get('mbid')) # mbid immutable as hash rests on self.__dict__.update(**kwargs) @@ -88,8 +107,7 @@ class Meta: """ #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 self.mbid == other.mbid elif isinstance(other, Meta): return bool(self.names & other.names) elif getattr(other, '__str__', None): @@ -103,6 +121,12 @@ class Meta: 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__()} @@ -126,38 +150,75 @@ class Meta: @property def names(self): + """aliases + name""" return self.__aliases | {self.__name,} class Album(Meta): + """Album object""" @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': '', # optional + >>> 'musicbrainz_albumartistid': '', # 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': '' , # optional - >>> 'musicbrainz_albumartistid': '', # optional - >>> } - >>> artobj0 = Artist(**trk) - >>> artobj1 = Artist(name='Tool') - """ - name = kwargs.get('artist', name) - 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): + + 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 __iter__(self): + return iter(self.elements) + + def __contains__(self, value): + return value in self.elements + + 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