X-Git-Url: https://git.kaliko.me/?a=blobdiff_plain;f=sima%2Flib%2Fmeta.py;h=26da9ca66efc05918a9c45b87a8de39ea08a345b;hb=b93b19e230fd0753d190f3107da50b78c719bf7f;hp=ebf5026a7fa95dfce5eb0adc4472a1f33cb7e5ab;hpb=bec6761572dc942c0772f955b6a84273e2754c6e;p=mpd-sima.git

diff --git a/sima/lib/meta.py b/sima/lib/meta.py
index ebf5026..26da9ca 100644
--- a/sima/lib/meta.py
+++ b/sima/lib/meta.py
@@ -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
 #
@@ -21,10 +21,8 @@
 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
 
@@ -34,17 +32,19 @@ UUID_RE = r'^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{1
 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):
@@ -56,34 +56,47 @@ def mbidfilter(func):
         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 string name: set name attribute
-    :param string mbid: set MusicBrainz ID (optional)
+    :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=<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')
+            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')
         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
@@ -103,9 +116,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
@@ -116,6 +129,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__()}
@@ -129,6 +148,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
@@ -137,27 +161,43 @@ 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):
+        super().__init__(name=name, mbid=mbid, **kwargs)
+
     @property
     def album(self):
         return self.name
 
+
 class Artist(Meta):
     """Artist object deriving from :class:`Meta`.
 
-    :param string name: Artist name, default ``None``
-    :param string mbid: Musicbrainz artist ID, defautl ``None``
-    :param string artist: Overrides "name" argument
-    :param string albumartist: Overrides "name" and "artist" argument
-    :param string musicbrainz_artistid: Overrides "mbid" argument
-    :param string musicbrainz_albumartistid: Overrides "musicbrainz_artistid" argument
+    :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: