Exposes genres in Track objets

[mpd-sima.git] / sima / lib / track.py

diff --git a/sima/lib/track.py b/sima/lib/track.py
index 87c96fc144fac9ca2b6ae0316d8e288fccc52d97..329392c93746c8098cfe6b6fb99b8e63ac59c5a3 100644 (file)
--- a/sima/lib/track.py
+++ b/sima/lib/track.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
 # -*- coding: utf-8 -*-
 

-# Copyright (c) 2009, 2010, 2011, 2013 Jack Kaliko <kaliko@azylum.org>
+# Copyright (c) 2009-2021 kaliko <kaliko@azylum.org>

 # Copyright (c) 2009 J. Alexander Treuman (Tag collapse method)
 # Copyright (c) 2008 Rick van Hattem
 #
 # Copyright (c) 2009 J. Alexander Treuman (Tag collapse method)
 # Copyright (c) 2008 Rick van Hattem
 #


@@ -23,31 +23,40 @@
 
 import time
 
 
 import time
 

+from .meta import Artist, SEPARATOR

 
 

-class Track(object):
+class Track:

     """
     Track object.
     """
     Track object.

-    Instanciate with Player replies.
+    Instantiate with Player replies.
+
+    :param str file: media file, defaults to ``None``
+    :param int time: duration in second, defaults to 0
+    :param int pos: position in queue, defaults to -1
+    :param str title|artist|album: defaults to ""
+    :param str musicbrainz_artistid|musicbrainz_albumartistid: MusicBrainz IDs, defaults to ``None``

     """
 
     """
 

-    def __init__(self, file=None, time=0, pos=0, **kwargs):
+    def __init__(self, file=None, time=0, pos=-1, **kwargs):

         self.title = self.artist = self.album = self.albumartist = ''
         self.title = self.artist = self.album = self.albumartist = ''

-        self._pos = pos
-        self.empty = False
+        self.musicbrainz_artistid = self.musicbrainz_albumartistid = None
+        self.pos = int(pos)

         self._file = file
         self._file = file

+        self._empty = False
+        self._time = time

         if not kwargs:
         if not kwargs:

-            self.empty = True
-        self.time = time
+            self._empty = True

         self.__dict__.update(**kwargs)
         self.__dict__.update(**kwargs)

-        self.tags_to_collapse = list(['artist', 'album', 'title', 'date',
-            'genre', 'albumartist'])
+        self.tags_to_collapse = ['artist', 'album', 'title', 'date',
+                                 'genre', 'albumartist',
+                                 'musicbrainz_artistid',
+                                 'musicbrainz_albumartistid']

         #  have tags been collapsed?
         #  have tags been collapsed?

-        self.collapse_tags_bool = False

         self.collapsed_tags = list()
         # Needed for multiple tags which returns a list instead of a string
         self.collapsed_tags = list()
         # Needed for multiple tags which returns a list instead of a string

-        self.collapse_tags()
+        self._collapse_tags()

 
 

-    def collapse_tags(self):
+    def _collapse_tags(self):

         """
         Necessary to deal with tags defined multiple times.
         These entries are set as lists instead of strings.
         """
         Necessary to deal with tags defined multiple times.
         These entries are set as lists instead of strings.


@@ -56,18 +65,11 @@ class Track(object):
             if tag not in self.tags_to_collapse:
                 continue
             if isinstance(value, list):
             if tag not in self.tags_to_collapse:
                 continue
             if isinstance(value, list):

-                self.collapse_tags_bool = True

                 self.collapsed_tags.append(tag)
                 self.collapsed_tags.append(tag)

-                self.__dict__.update({tag: ', '.join(set(value))})
-
-    def get_filename(self):
-        """return filename"""
-        if not self.file:
-            return None
-        return self.file
+                self.__dict__.update({tag: SEPARATOR.join(value)})

 
     def __repr__(self):
 
     def __repr__(self):

-        return '%s(artist="%s", album="%s", title="%s", filename="%s")' % (
+        return '%s(artist="%s", album="%s", title="%s", file="%s")' % (

             self.__class__.__name__,
             self.artist,
             self.album,
             self.__class__.__name__,
             self.artist,
             self.album,


@@ -76,8 +78,8 @@ class Track(object):
         )
 
     def __str__(self):
         )
 
     def __str__(self):

-        return '{artist} - {album} - {title} ({duration})'.format(
-                duration=self.duration,
+        return '{artist} - {album} - {title} ({length})'.format(
+                length=self.length,

                 **self.__dict__
                 )
 
                 **self.__dict__
                 )
 


@@ -93,8 +95,7 @@ class Track(object):
     def __hash__(self):
         if self.file:
             return hash(self.file)
     def __hash__(self):
         if self.file:
             return hash(self.file)

-        else:
-            return id(self)
+        return id(self)

 
     def __eq__(self, other):
         return hash(self) == hash(other)
 
     def __eq__(self, other):
         return hash(self) == hash(other)


@@ -103,12 +104,9 @@ class Track(object):
         return hash(self) != hash(other)
 
     def __bool__(self):
         return hash(self) != hash(other)
 
     def __bool__(self):

-        return not self.empty
-
-    @property
-    def pos(self):
-        """return position of track in the playlist"""
-        return int(self._pos)
+        if not self._file:
+            return False
+        return not self._empty

 
     @property
     def file(self):
 
     @property
     def file(self):


@@ -123,25 +121,42 @@ class Track(object):
         """set time property"""
         self._time = int(value)
 
         """set time property"""
         self._time = int(value)
 

-    time = property(get_time, set_time, doc='song duration in seconds')
+    time = property(get_time, set_time, doc='song duration in seconds (use :attr:`length` for human readable time)')

 
     @property
 
     @property

-    def duration(self):
-        """Compute fancy duration"""
-        temps = time.gmtime(int(self.time))
+    def length(self):
+        """Get a fancy duration as ``%H:%M:%S`` (use :attr:`time` to get duration in second only)"""
+        temps = time.gmtime(int(self.time))  #TODO: returns a date not a duration

         if temps.tm_hour:
             fmt = '%H:%M:%S'
         else:
             fmt = '%M:%S'
         return time.strftime(fmt, temps)
 
         if temps.tm_hour:
             fmt = '%H:%M:%S'
         else:
             fmt = '%M:%S'
         return time.strftime(fmt, temps)
 

+    @property
+    def genres(self):
+        """Fetches Genres for the track
+        Multivalue genre are dealt with:
+          * when genre tag is multivalued
+          * when single tag uses coma or semi-colon separator
+        """
+        if 'genre' not in self.__dict__:
+            return []
+        genres = self.genre.split(SEPARATOR)
+        for sep in [',', ';']:
+            if sep in self.genre:
+                genres = [g for multi in genres for g in multi.split(sep) if g]
+        return list(map(str.strip, genres))

 
 

-def main():
-    pass
-
-# Script starts here
-if __name__ == '__main__':
-    main()
+    @property
+    def Artist(self):
+        """Get the :class:`sima.lib.meta.Artist` associated to this track"""
+        if not self.artist:
+            if not self.musicbrainz_artistid:
+                return Artist(name='[unknown]',
+                              mbid='125ec42a-7229-4250-afc5-e057484327fe')
+            return Artist(name='[unknown]', **self.__dict__)
+        return Artist(**self.__dict__)

 
 # VIM MODLINE
 # vim: ai ts=4 sw=4 sts=4 expandtab
 
 # VIM MODLINE
 # vim: ai ts=4 sw=4 sts=4 expandtab