Merge pull request #123 from sindrig/v1.5.0

V1.5.0

Author: sindrig

README.rst

@@ -7,13 +7,13 @@ Requirements
 
 Python 2.7 or Python 3.3+
 
-See requirements.txt for required python packages.
+See requirements.txt for required python packages. They will be automatically installed when you install via pip.
 
-You will need a Spotify Premium account.
+You will need a Spotify Premium account and a Spotify username (if you signed up via Facebook you can `follow the instructions here <https://community.spotify.com/t5/Help-Accounts-and-Subscriptions/How-do-i-find-my-username-when-using-Facebook-login/td-p/859795>`_ to get your username).
 
 You will need libspotify, libffi-dev and libasound2-dev installed.
 
-Use your distribution's package manager for libffi-dev and libasound2-dev.
+Use your distribution's package manager for libffi-dev and libasound2-dev (f.x. :code:`apt-get install libffi-dev libasound2-dev`).
 
 To install libspotify, see `Pyspotify installation <https://pyspotify.mopidy.com/en/latest/installation/#install-from-source>`_. (It's also available in the `AUR <https://aur.archlinux.org/packages/libspotify/>`_).
 
@@ -34,10 +34,7 @@ Development
 1. Create a virtualenv (python 2.7 or python 3.3+)
 2. Clone this project
 3. Activate your virtualenv
-4. Install requirements
-
-  * pip install -r requirements.txt
-
+4. Install requirements (:code:`pip install -r requirements.txt`)
 5. Run :code:`python scripts/spoppy` (you will be asked for username/password)
 
 DBus integration
@@ -46,13 +43,9 @@ DBus integration
 1. Run `make install_dbus`
 2. Make sure you have python-gobject2 installed
 3. Symlink gi (and possibly glib) to your virtualenv (that is, if you're not installing globally!)
-
-  * ln -s /usr/lib/python3.5/site-packages/gi/ $VIRTUAL_ENV/lib/python3.5/site-packages/gi
-  * ln -s /usr/lib/python3.5/site-packages/glib/ $VIRTUAL_ENV/lib/python3.5/site-packages/glib
-
 4. The service will be available at "/com/spoppy" (f.x. :code:`qdbus com.spoppy /com/spoppy com.spoppy.PlayPause`)
 
 Testing
 =========
 
-:code:`python setup.py test`
+:code:`make test`

spoppy/__init__.py

@@ -10,7 +10,7 @@
 
 
 def get_version():
-    return '1.4.6'
+    return '1.5.0'
 
 if click:
     @click.command()

spoppy/menus.py

@@ -101,6 +101,8 @@ class Menu(object):
     BACKSPACE = b'\x7f'
     UP_ARROW = b'\x1b[A'
     DOWN_ARROW = b'\x1b[B'
+    PAGE_UP = b'\x1b[5~'
+    PAGE_DOWN = b'\x1b[6~'
     PAGE = 0
 
     def __init__(self, navigator):
@@ -126,14 +128,17 @@ def get_response(self):
         if response == Menu.BACKSPACE:
             self.filter = self.filter[:-1]
             return responses.NOOP
-        elif response == Menu.UP_ARROW:
-            logger.debug('Got UP_ARROW')
+        elif response in (Menu.UP_ARROW, Menu.PAGE_UP):
+            logger.debug('Got UP_ARROW/PAGE_UP')
             self.PAGE = max([self.PAGE - 1, 0])
             return responses.NOOP
-        elif response == Menu.DOWN_ARROW:
-            logger.debug('Got DOWN_ARROW')
+        elif response in (Menu.DOWN_ARROW, Menu.PAGE_DOWN):
+            logger.debug('Got DOWN_ARROW/PAGE_DOWN')
             self.PAGE += 1
             return responses.NOOP
+        elif response.startswith(b'\x1b'):
+            logger.debug('Got unknown character %s' % repr(response))
+            return responses.NOOP
 
         self.filter += response.decode('utf-8')
         if self.filter.endswith('\n'):
@@ -211,6 +216,10 @@ def get_options(self):
             ),
             'st': MenuValue('Search for tracks', TrackSearch(self.navigator)),
             'sa': MenuValue('Search for albums', AlbumSearch(self.navigator)),
+            'ss': MenuValue(
+                'Search for artists',
+                ArtistSearch(self.navigator)
+            ),
         }
         if not self.navigator.spotipy_client:
             res['li'] = MenuValue(
@@ -386,7 +395,6 @@ def album_selected():
     def get_options_from_search(self):
         results = {}
         for i, album in enumerate(
-            album for album in
             self.search.results.results
         ):
             results[str(self.get_res_idx(i)).rjust(4)] = MenuValue(
@@ -403,6 +411,36 @@ def get_mock_playlist(self):
         )
 
 
+class ArtistSearchResults(TrackSearchResults):
+    search = None
+
+    def select_artist(self, artist_idx):
+        def artist_selected():
+            res = ArtistSelected(self.navigator)
+            res.artist = self.search.results.results[artist_idx]
+            return res
+        return artist_selected
+
+    def get_options_from_search(self):
+        results = {}
+        for i, artist_browser in enumerate(
+            self.search.results.results
+        ):
+            results[str(self.get_res_idx(i)).rjust(4)] = MenuValue(
+                artist_browser.artist.name, self.select_artist(i)
+            )
+        return results
+
+    def get_mock_playlist(self):
+        track_results = list(chain(*[
+            artist.tracks for
+            artist in self.search.results.results
+        ]))
+        return MockPlaylist(
+            self.get_mock_playlist_name(), track_results
+        )
+
+
 class TrackSearch(Menu):
     is_searching = False
     search_pattern = ''
@@ -466,6 +504,11 @@ class AlbumSearch(TrackSearch):
     result_cls = AlbumSearchResults
 
 
+class ArtistSearch(TrackSearch):
+    search_type = 'artists'
+    result_cls = ArtistSearchResults
+
+
 class PlayListSelected(Menu):
     playlist = None
     deleting = False
@@ -506,7 +549,11 @@ def cancel_delete_playlist(self):
         return self
 
     def get_tracks(self):
-        return self.playlist.tracks
+        return [
+            track for track in
+            self.playlist.tracks
+            if track.availability != TrackAvailability.UNAVAILABLE
+        ]
 
     def get_name(self):
         return self.playlist.name
@@ -517,11 +564,7 @@ def get_options(self):
             results['y'] = MenuValue('Yes', self.do_delete_playlist)
             results['n'] = MenuValue('No', self.cancel_delete_playlist)
         else:
-            for i, track in enumerate(
-                track for track in
-                self.get_tracks()
-                if track.availability != TrackAvailability.UNAVAILABLE
-            ):
+            for i, track in enumerate(self.get_tracks()):
                 results[str(i + 1).rjust(4)] = MenuValue(
                     format_track(track), self.select_song(i)
                 )
@@ -553,6 +596,12 @@ def get_header(self):
             return 'Are you sure you want to delete playlist [%s]' % (
                 self.get_name()
             )
+        return '%s (total %d tracks)' % (
+            self.get_header_text(),
+            len(self.get_tracks())
+        )
+
+    def get_header_text(self):
         return 'Playlist [%s] selected' % self.get_name()
 
 
@@ -572,10 +621,27 @@ def get_tracks(self):
     def get_name(self):
         return format_album(self.album)
 
-    def get_header(self):
+    def get_header_text(self):
         return 'Album [%s] selected' % self.get_name()
 
 
+class ArtistSelected(AlbumSelected):
+    artist = None
+    _tracks = None
+
+    def get_tracks(self):
+        if not self._tracks:
+            self._tracks = self.artist.tracks
+            logger.debug('Artist has %d tracks' % len(self._tracks))
+        return self._tracks
+
+    def get_name(self):
+        return self.artist.artist.name
+
+    def get_header_text(self):
+        return 'Artist [%s] selected' % self.get_name()
+
+
 class SongSelectedWhilePlaying(Menu):
     playlist = None
     track = None

spoppy/navigation.py

@@ -127,7 +127,9 @@ def update_progress(self, status, start, perc, end):
             end or ''
         )
         progress_width = self.get_ui_width() - len(s) + 2
-        s = s % ('#'*int(perc*progress_width)).ljust(progress_width)
+        if perc > 1:
+            perc = 1
+        s = s % ('#' * int(perc * progress_width)).ljust(progress_width)
 
         click.echo(s, nl=False)
 

spoppy/players.py

@@ -240,6 +240,7 @@ def get_ui(self):
             right_side_items = [
                 'Shuffle on' if self.shuffle else '',
                 'Repeat: %s' % self.repeat,
+                '%d of %d' % (self.current_track_idx + 1, len(self.song_order))
             ]
             songs_to_show = (
                 list(range(

spoppy/search.py

@@ -9,6 +9,7 @@
 import requests
 from spotify.track import Track, TrackAvailability
 from spotify.album import Album
+from spotify.artist import Artist
 
 logger = logging.getLogger(__name__)
 
@@ -41,7 +42,7 @@ class Search(threading.Thread):
         ),
         'artists': (
             u'/v1/search?query={query}&offset=0&limit=20&type=artist',
-            None
+            Artist
         ),
     }
     BASE_URL = 'https://api.spotify.com'
@@ -64,6 +65,8 @@ def __init__(self, session, query='', callback=None,
             self.BASE_URL + endpoint.format(query=self.query)
         )
 
+        self.results = self.get_empty_results()
+
         super(Search, self).__init__()
 
         self.start()
@@ -73,13 +76,14 @@ def run(self):
             logger.debug('Getting %s' % self.endpoint)
             r = requests.get(self.endpoint)
             r.raise_for_status()
-        except requests.exceptions.RequestException:
-            self.results = self.get_empty_results()
-        else:
             response_data = r.json()[self.search_type]
-            self.handle_results(response_data)
-
-        self.loaded_event.set()
+            self.results = self.handle_results(response_data)
+        except requests.exceptions.RequestException:
+            logger.exception('RequestException')
+        except Exception:
+            logger.exception('Something went wrong while handling results')
+        finally:
+            self.loaded_event.set()
 
     def get_empty_results(self):
         return SearchResults(self.query, [], 0, 0)
@@ -90,7 +94,7 @@ def handle_results(self, response_data):
             for item in response_data['items']
         ])
 
-        self.results = SearchResults(
+        return SearchResults(
             self.query,
             item_results,
             response_data['offset'],
@@ -111,4 +115,8 @@ def manipulate_items(self, items):
                 item.load() for item in items
                 if item.availability != TrackAvailability.UNAVAILABLE
             ]
+        elif self.search_type == 'artists':
+            return [
+                item.browse().load() for item in items
+            ]
         raise TypeError('Unknown search type %s' % self.search_type)

spoppy/util.py

@@ -56,11 +56,11 @@ def format_track(track):
     )
 
 
-def format_album(album):
+def format_album(album_browser):
     return '%s by %s [%s]' % (
-        album.album.name,
-        album.artist.name,
-        album.album.year
+        album_browser.album.name,
+        album_browser.artist.name,
+        album_browser.album.year
     )