Merge lp:~mblayman/entertainer/complain-fixme-todo into lp:entertainer

[Matt Layman]

pylint now complains about TODOs in the code.

[Matt Layman (mblayman)]

This branch enables checking for TODO comments (we are already checking for FIXME). Because of that, I've also deleted all the TODO lines that were still in the code. I have provided a rationale for removal of each TODO in my commit messages so `bzr log -l <7 or 8>` should explain all my reasoning. Only one TODO was appropriate to convert to XXX. I have reported a bug to go with that XXX (Bug 374326).

This branch will help weed out any TODOs in the future and close Bug 311272.

[Paul Hummer (rockstar)]

 review approve
 status approved

Thanks for the branch!

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

review: Approve

=== modified file 'entertainerlib/frontend/gui/screens/photo.py'
--- entertainerlib/frontend/gui/screens/photo.py	2009-04-27 03:32:30 +0000
+++ entertainerlib/frontend/gui/screens/photo.py	2009-05-10 02:30:05 +0000
@@ -79,7 +79,6 @@
         @param texture: Texture to scale
         @param zoom_level: Zoom level - Default value is 1 (no zoom)
         """
-        # TODO: Zoom feature is not implemented completely!
         # Center position when zoomed
         width = texture.get_width()
         height = texture.get_height()

=== modified file 'entertainerlib/frontend/gui/tabs/lyrics_tab.py'
--- entertainerlib/frontend/gui/tabs/lyrics_tab.py	2009-04-21 21:04:56 +0000
+++ entertainerlib/frontend/gui/tabs/lyrics_tab.py	2009-05-10 02:41:26 +0000
@@ -49,7 +49,6 @@
         This function is called when lyrics search is over.
         @param lyrics: Lyrics or None if lyrics weren't found
         """
-        #TODO: We could smoothly fade away throbber
         self.throbber.hide()
 
         # Save the results to help determine if the tab can activate

=== modified file 'entertainerlib/frontend/gui/widgets/grid_menu.py'
--- entertainerlib/frontend/gui/widgets/grid_menu.py	2009-02-08 08:44:46 +0000
+++ entertainerlib/frontend/gui/widgets/grid_menu.py	2009-05-10 02:31:34 +0000
@@ -14,13 +14,6 @@
     scrollable, multirow menus. Real menus should inherit this class
     and override few methods.
     """
-    #TODO:
-    # - Scroll content over (first item comes after the last one)
-    # - Fix animated cursor/content move (do we even want this?)
-    # - Add support for PageUp/PageDown and Home/End
-    # - Add search functionality
-    # - Optimize performance: Hide/unrealize items that are not currently on
-    #   screen
 
     # Orientation constants
     HORIZONTAL = 0
@@ -468,8 +461,6 @@
         @param direction: GridMenu class variables (UP, DOWN, LEFT, RIGHT)
         @return: True if move can be executed, otherwise False
         """
-        #TODO: This method is not needed if scrolling menu is implemented
-
         # If last row is "full" we can't go wrong
         if len(self.items) % self.row_count == 0:
             return True

=== modified file 'entertainerlib/frontend/gui/widgets/menu_overlay.py'
--- entertainerlib/frontend/gui/widgets/menu_overlay.py	2008-11-17 11:20:47 +0000
+++ entertainerlib/frontend/gui/widgets/menu_overlay.py	2009-05-10 02:38:20 +0000
@@ -17,11 +17,6 @@
     provides methods fade_in() and fade_out().
     """
 
-    #TODO: If user switches quickly from OSD to menu and back, then animation
-    #      flickers because the first animation doesn't have time to finish.
-    #      This should be fixed! Detect if timeline is still running, stop it
-    #      etc.
-
     def __init__(self, theme):
         """Initialize overlay texture."""
         Texture.__init__(self, filename = theme.getImage("menu_overlay"))

=== modified file 'entertainerlib/frontend/medialibrary/feeds.py'
--- entertainerlib/frontend/medialibrary/feeds.py	2009-01-26 18:28:26 +0000
+++ entertainerlib/frontend/medialibrary/feeds.py	2009-05-10 02:27:14 +0000
@@ -28,35 +28,6 @@
         if self.number_of_feeds() == 0:
             self.empty = True
 
-    def add_feed(self, url):
-        """
-        Add feed to the library.
-        @param url: URL of the feed
-        """
-        self.set_empty(False)
-        print "not functional yet"
-        # TODO: Edit conf file and emit message to the backend
-
-    def remove_feed(self, url):
-        """
-        Remove feed from the library.
-        @param url: URL of the feed
-        """
-        #TODO Edit conf file and emit message to the backend
-        connection = sqlite.connect(self.config.FEED_DB)
-        cursor = connection.cursor()
-        cursor.execute("""DELETE FROM feed
-                          WHERE url=:url""",
-                          {"url" : url})
-        # XXX: rockstar - Why is there fetching happening on a delete
-        # statement?
-        #result = cursor.fetchall()
-        cursor.fetchall()
-        connection.commit()
-        connection.close()
-        if self.number_of_feeds() == 0:
-            self.set_empty(True)
-
     def set_empty(self, empty):
         '''Mark a feed as empty'''
         self.empty = empty

=== modified file 'entertainerlib/tests/test_frontendfeedlibrary.py'
--- entertainerlib/tests/test_frontendfeedlibrary.py	2009-02-04 04:17:37 +0000
+++ entertainerlib/tests/test_frontendfeedlibrary.py	2009-05-10 02:27:14 +0000
@@ -87,13 +87,6 @@
         db_conn.commit()
         db_conn.close()
 
-    def testRemoveFeed(self):
-        """
-        testRemoveFeed: Tests FeedLibrary.remove_feed()
-        """
-        self.library.remove_feed("url2")
-        self.assertEqual(self.library.number_of_feeds(), 9)
-
     def testIsEmptyWhenFull(self):
         """
         testIsEmptyWhenFull: Tests FeedLibrary.is_empty() when there are feeds
@@ -101,15 +94,6 @@
         """
         self.assertFalse(self.library.is_empty())
 
-    def testIsEmptyWhenEmpty(self):
-        """
-        testIsEmptyWhenEmpty: Tests FeedLibrary.is_empty() when the feed list
-        is empty
-        """
-        for i in range(10):
-            self.library.remove_feed("url"+str(i))
-        self.assertTrue(self.library.is_empty())
-
     def testGetFeeds(self):
         """
         testGetFeeds: Tests FeedLibrary.get_feeds() sorted by TITLE

=== modified file 'entertainerlib/utils/albumart_downloader.py'
--- entertainerlib/utils/albumart_downloader.py	2009-03-22 04:53:10 +0000
+++ entertainerlib/utils/albumart_downloader.py	2009-05-10 02:52:18 +0000
@@ -100,7 +100,6 @@
         # Strip
         str_input = str_input.strip ()
 
-        # TODO: Convert accented to unaccented
         str_input = str_input.replace (" - ", " ")
         str_input = str_input.replace (": ", " ")
         str_input = str_input.replace (" & ", " and ")
@@ -149,7 +148,6 @@
         self.search_artist = st_artist
         self.search_album_no_vol = st_album_no_vol
 
-        # TODO: Improve to decrease wrong cover downloads, maybe add severity?
         # Assemble list of search keywords (and thus search queries)
         if st_album == u'Unknown':
             self.keywords.append ("%s Best of" % (st_artist))

=== modified file 'entertainerlib/utils/lyrics_downloader.py'
--- entertainerlib/utils/lyrics_downloader.py	2009-03-22 04:06:48 +0000
+++ entertainerlib/utils/lyrics_downloader.py	2009-05-10 02:50:33 +0000
@@ -63,7 +63,7 @@
 
         # Convert title and artist to use in url, special symbols have to be
         # replaced by a '%' not '%xx'
-        # TODO: Find out what the special symbols are (', &, ...)
+        # XXX: laymansterms - Find out what the special symbols are (', &, ...)
         # not letters, digits, spaces and ()$^*=:;|#@}{][!,.-_\
         self.artist = urllib.quote(self.artist.encode('utf-8'),
                                    "'&()$^*=:;|#@}{][!,\\")

=== modified file 'pylintrc'
--- pylintrc	2009-02-10 02:34:38 +0000
+++ pylintrc	2009-05-10 02:27:14 +0000
@@ -294,8 +294,7 @@
 [MISCELLANEOUS]
 
 # List of note tags to take in consideration, separated by a comma.
-# XXX: rockstar - Eventually, we plan on adding back in the TODO line as well.
-notes=FIXME
+notes=FIXME,TODO
 
 
 # checks for similarities and duplicated code. This computation may be