# -*- coding: utf-8 -*-
-# Copyright (c) 2009, 2010, 2011, 2013, 2014, 2015 Jack Kaliko <kaliko@azylum.org>
+# Copyright (c) 2009-2017 kaliko <kaliko@azylum.org>
# Copyright (c) 2009 J. Alexander Treuman (Tag collapse method)
# Copyright (c) 2008 Rick van Hattem
#
class Track:
"""
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=-1, **kwargs):
# 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.
)
def __str__(self):
- return '{artist} - {album} - {title} ({duration})'.format(
- duration=self.duration,
+ return '{artist} - {album} - {title} ({length})'.format(
+ length=self.length,
**self.__dict__
)
return hash(self) != hash(other)
def __bool__(self):
+ if not self._file:
+ return False
return not self._empty
@property
"""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
- 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:
@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]',