Sphinx documentation and API cleanup

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

diff --git a/sima/lib/track.py b/sima/lib/track.py
index 1bed098f851cee6dd08d1601a3d34265bbd62bcd..b5ffc15545d0092303d51bc266d67e3adeb117ee 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, 2014 Jack Kaliko <kaliko@azylum.org>
+# Copyright (c) 2009, 2010, 2011, 2013, 2014, 2015 Jack 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,12 +23,12 @@
 
 import time
 
 
 import time
 

-from .meta import Artist
+from .meta import Artist, SEPARATOR

 
 class Track:
     """
     Track object.
 
 class Track:
     """
     Track object.

-    Instanciate with Player replies.
+    Instantiate with Player replies.

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


@@ -48,9 +48,9 @@ class Track:
         #  have tags been collapsed?
         self.collapsed_tags = list()
         # Needed for multiple tags which returns a list instead of a string
         #  have tags been collapsed?
         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.


@@ -60,10 +60,10 @@ class Track:
                 continue
             if isinstance(value, list):
                 self.collapsed_tags.append(tag)
                 continue
             if isinstance(value, list):
                 self.collapsed_tags.append(tag)

-                self.__dict__.update({tag: ', '.join(set(value))})
+                self.__dict__.update({tag: SEPARATOR.join(set(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,


@@ -99,6 +99,8 @@ class Track:
         return hash(self) != hash(other)
 
     def __bool__(self):
         return hash(self) != hash(other)
 
     def __bool__(self):

+        if not self._file:
+            return False

         return not self._empty
 
     @property
         return not self._empty
 
     @property


@@ -114,11 +116,11 @@ class Track:
         """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:`duration` for human readable time)')

 
     @property
     def duration(self):
 
     @property
     def duration(self):

-        """Compute fancy duration"""
+        """Get a fancy duration %H:%M:%S (use :attr:`time` to get duration in second only)"""

         temps = time.gmtime(int(self.time))
         if temps.tm_hour:
             fmt = '%H:%M:%S'
         temps = time.gmtime(int(self.time))
         if temps.tm_hour:
             fmt = '%H:%M:%S'


@@ -128,7 +130,12 @@ class Track:
 
     @property
     def Artist(self):
 
     @property
     def Artist(self):

-        """Get artist object from track"""
+        """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
         return Artist(**self.__dict__)
 
 # VIM MODLINE