Merge lp:~rockstar/entertainer/storage-branch into lp:entertainer

[Paul Hummer]

[Paul Hummer (rockstar)]

This branch does a few things. The original reason for this branch was to
define an abstract interface that would stand as the contract for which all
other storage facilities can inherit and implement. This allows Entertainer's
client to know nothing about HOW it's getting its info, and just receive it
based on a storage object implementing this base Storage class. When the
client wants all the music tracks, it just calls storage.music_tracks, and the
storage implementation hides the gory details from the client.

One of my next branches will implement this Storage in a LocalStorage flavor,
allowing me to demonstrate how this will work, and to work out an kinks in the
implementation (and truly there will be).

Along with that, I started consolidating exceptions into the
entertainerlib.exceptions module. This will allow us to keep track of what
types of Exceptions we have already created, so we don't go creating more. I
haven't grabbed all the Entertainer specific exceptions, but I at least wanted
to demonstrate what I was trying to achieve.

There is a lint warning R0921 that is my fault. It's detected that Storage is
an abstract class and lets me know I haven't implemented it anywhere.
Apparently pylint doesn't like disabling of the refactoring warnings, and since
it's a temporary warning, I thought we could let it slide. If you as the
reviewer feel I should do something about it, then I'll probably create an
empty class that "implement" Storage for now.

--
Paul Hummer
http://theironlion.net
1024/862FF08F C921 E962 58F8 5547 6723 0E8C 1C4D 8AC5 862F F08F

[Matt Layman (mblayman)]

 approve merge_conditional

pylint --rcfile=pylintrc entertainer* tools/*.py setup.py
************* Module entertainerlib.frontend.frontend_client
W0612: 50:FrontendClient.__init__: Unused variable 'system_tray_icon'
************* Module entertainerlib.tests.test_storage
W0612: 20:TestStorage.test_not_implemented: Unused variable 'albums'
************* Module entertainerlib.storage.base
R0921: 4:Storage: Abstract class not referenced

I know that one warning isn't from your branch, but since this would probably be the next branch merged to trunk, it would be a good time to fix them.

I'm okay with the R0921 because it will have an associated implementation soon.

review: Approve

[lp:~rockstar/entertainer/storage-branch]

347. By Paul Hummer on 2009-02-10

Merge from trunk

348. By Paul Hummer on 2009-02-10

Fixed lint issues

=== added file 'entertainerlib/exceptions.py'
--- entertainerlib/exceptions.py	1970-01-01 00:00:00 +0000
+++ entertainerlib/exceptions.py	2009-02-06 06:17:51 +0000
@@ -0,0 +1,15 @@
+'''Various Exceptions for Entertainer.'''
+
+
+class ThumbnailerException(Exception):
+    '''Abstract thumbnailer exception'''
+
+
+class ImageThumbnailerException(ThumbnailerException):
+    '''An exception specific to the ImageThumbnailer'''
+
+
+class VideoThumbnailerException(ThumbnailerException):
+    '''An exception specific to the video thumbnailer'''
+
+

=== added directory 'entertainerlib/storage'
=== added file 'entertainerlib/storage/__init__.py'
--- entertainerlib/storage/__init__.py	1970-01-01 00:00:00 +0000
+++ entertainerlib/storage/__init__.py	2009-02-06 06:52:14 +0000
@@ -0,0 +1,4 @@
+'''Storage facilities for Entertainer (used by the client/frontend).'''
+# pylint: disable-msg=W0611
+from entertainerlib.storage.base import Storage
+

=== added file 'entertainerlib/storage/base.py'
--- entertainerlib/storage/base.py	1970-01-01 00:00:00 +0000
+++ entertainerlib/storage/base.py	2009-02-06 06:34:20 +0000
@@ -0,0 +1,37 @@
+'''Base classes for Entertainer Storages.'''
+
+
+class Storage(object):
+    '''Base Storage class.'''
+
+    @property
+    def music_tracks(self):
+        '''Return a list of all music tracks.'''
+        raise NotImplementedError
+
+    @property
+    def music_albums(self):
+        '''Return a list of all music tracks.'''
+        raise NotImplementedError
+
+    @property
+    def photo_albums(self):
+        '''Return a list of all music tracks.'''
+        raise NotImplementedError
+
+    @property
+    def photo_images(self):
+        '''Return a list of all music tracks.'''
+        raise NotImplementedError
+
+    @property
+    def video_files(self):
+        '''Return a list of all music tracks.'''
+        raise NotImplementedError
+
+    @property
+    def video_series(self):
+        '''Return a list of all music tracks.'''
+        raise NotImplementedError
+
+

=== added file 'entertainerlib/tests/test_storage.py'
--- entertainerlib/tests/test_storage.py	1970-01-01 00:00:00 +0000
+++ entertainerlib/tests/test_storage.py	2009-02-06 06:37:55 +0000
@@ -0,0 +1,54 @@
+'''Test the Storage classes.'''
+from entertainerlib.storage import Storage
+from entertainerlib.tests import EntertainerTest
+
+class TestStorage(EntertainerTest):
+    '''Test for entertainerlib.storage.base.Storage.'''
+
+    def test_create(self):
+        '''Test the instantiation of a Storage object.'''
+        storage = Storage()
+        self.assertTrue(isinstance(storage, Storage))
+
+    def test_not_implemented(self):
+        '''Test the calls to the various methods raise NotImplementedError.'''
+        storage = Storage()
+
+        # The try/except blocks are used instead of assertRaises because these
+        # attributes are not callable.
+        try:
+            albums = storage.music_albums
+            self.fail()
+        except NotImplementedError:
+            pass
+
+        try:
+            albums = storage.music_tracks
+            self.fail()
+        except NotImplementedError:
+            pass
+
+        try:
+            albums = storage.photo_albums
+            self.fail()
+        except NotImplementedError:
+            pass
+
+        try:
+            albums = storage.photo_images
+            self.fail()
+        except NotImplementedError:
+            pass
+
+        try:
+            albums = storage.video_files
+            self.fail()
+        except NotImplementedError:
+            pass
+
+        try:
+            albums = storage.video_series
+            self.fail()
+        except NotImplementedError:
+            pass
+

=== modified file 'entertainerlib/utils/image_thumbnailer.py'
--- entertainerlib/utils/image_thumbnailer.py	2009-01-11 00:17:47 +0000
+++ entertainerlib/utils/image_thumbnailer.py	2009-02-06 06:18:09 +0000
@@ -6,11 +6,10 @@
 __maintainer__ = "Paul Hummer <[e-mail]>"
 
 import Image
+
+from entertainerlib.exceptions import ImageThumbnailerException
 from entertainerlib.utils import thumbnailer
 
-class ImageThumbnailerException(Exception):
-    '''An exception specific to the ImageThumbnailer'''
-
 class ImageThumbnailer(thumbnailer.Thumbnailer):
     """Thumbnailer for image files."""
 

=== modified file 'entertainerlib/utils/thumbnailer.py'
--- entertainerlib/utils/thumbnailer.py	2009-01-11 02:13:04 +0000
+++ entertainerlib/utils/thumbnailer.py	2009-02-06 06:34:20 +0000
@@ -11,11 +11,9 @@
 except ImportError:
     import md5
 
+from entertainerlib.exceptions import ThumbnailerException
 from entertainerlib.utils.configuration import Configuration
 
-class ThumbnailerException(Exception):
-    '''Abstract thumbnailer exception'''
-
 class Thumbnailer(object):
     """ Thumbnailer interface for video and image thumbnailers. """
 
@@ -60,4 +58,5 @@
         thumbnail directory in JPEG format. Thumbnail filename should be a MD5
         hash of the absolute path of the original file.
         """
-        raise Exception('Method not implemented')
+        raise NotImplementedError
+

=== modified file 'entertainerlib/utils/video_thumbnailer.py'
--- entertainerlib/utils/video_thumbnailer.py	2009-01-11 02:25:00 +0000
+++ entertainerlib/utils/video_thumbnailer.py	2009-02-06 06:18:09 +0000
@@ -17,13 +17,10 @@
 import Image
 import ImageStat
 
+from entertainerlib.exceptions import VideoThumbnailerException
 from entertainerlib.utils import thumbnailer
 
 
-class VideoThumbnailerException(Exception):
-    '''An exception specific to the video thumbnailer'''
-
-
 class VideoThumbnailer(thumbnailer.Thumbnailer):
     ''' VideoThumbnailer does exactly what it's name demonstrates it does:
     create thumbnailed images of the videos.'''