Changes¶

v1.7 (2012-04-22)¶

API changes

This version works with libspotify version 11.
Artist and album browsers are now created directly from the ArtistBrowser and AlbumBrowser class constructors. The Session.browse_artist() and Session.browse_album() methods still work but have been deprecated. Also, callbacks are optional for the two browsers.
The audio sink wrappers have been cleaned up and moved to a new spotify.audiosink module. The interface is the same, but you’ll need to update your imports if you previously used either spotify.alsahelper.AlsaController (renamed to spotify.audiosink.alsa.AlsaSink) or spotify.osshelper.OssController (renamed to spotify.audiosink.oss.OssSink).
An ArtistBrowser object is now a list of Track, as it was written in the API documentation.
offset is now optional in Link.from_track().
Remove undocumented/internal method spotify.manager.SpotifySessionManager.wake(). spotify.manager.SpotifySessionManager.notify_main_thread() does the same job. Make sure you haven’t accidentally overrided notify_main_thread() in your SpotifySessionManager subclass.
Remove undocumented/internal method spotify.manager.SpotifySessionManager.terminate(). Use spotify.manager.SpotifySessionManager.disconnect() instead.

New features

Added method spotify.Playlist.owner().
Added methods spotify.Results.total_albums() and spotify.Results.total_artists().
Added methods spotify.ArtistBrowser.albums(), spotify.ArtistBrowser.similar_artists(), spotify.ArtistBrowser.tracks() and spotify.ArtistBrowser.tophit_tracks().
Added optional argument type for spotify.ArtistBrowser.
pyspotify now registers a “null handler” for logging to the spotify logger. This means that any pyspotify code is free to log debug log to any logger matching spotify.*.

By default the log statements will be swallowed by the null handler. An application developer using pyspotify may add an additional log handler which listens for log messages to the spotify logger, and thus get debug information from pyspotify.
Multi-user credential retainment using login_blob from the spotify.manager.SpotifySessionManager and the spotify.manager.SpotifySessionManager.credentials_blob_updated() method.
Added a search_type argument for searches.
Added new method spotify.Session.flush_caches().
Add new spotify.manager.SpotifySessionManager.music_delivery_safe() callback that can safely use the Spotify API without segfaulting. A little overhead is caused by serializing and passing data to the main thread, so if you are not going to use the Spotify API from your callbacks, or you’re doing your own synchronization, you can continue to use the non-safe methods with a bit less overhead.
Bundled audio sink support:
- A audio sink wrapper for PortAudio, spotify.audiosink.portaudio.PortAudioSink, have been contributed by Tommaso Barbugli. PortAudio is available on both Linux, Mac OS X, and Windows.
- A audio sink wrapper for Gstreamer, spotify.audiosink.gstreamer.GstreamerSink, have been contributed by David Buchmann. Gstreamer is available on both Linux, Mac OS X, and Windows.
- The audio sink selector code originally written by Tommaso Barbugli for the jukebox.py example app have been generalized and made available for other applications as spotify.audiosink.import_audio_sink().
Jukebox example:
- The jukebox got support for playing entire playlists. Thanks to Bjørn Schjerve.
- The jukebox now formats duration in minutes and seconds. Thanks to David Buchmann.

Other changes

For developers: pyspotify now uses libmockspotify for its mocking needs. The mock module only contains Python bindings to the libmockspotify API. To be able to run the tests, you need to pass --with-mock to your python setup.py ... command to build pyspotify with mock support. Alternatively, you can use make test to run the tests.

v1.6.1 (2011-12-29)¶

Maintenance release to fix a segfault for some users of playlist folders.

Bug fixes

Calling spotify.PlaylistFolder.is_loaded() would cause a double free(), and thus a segfault.

v1.6 (2011-11-29)¶

Updated to work with libspotify 10.1.16.

API changes

Session.is_available(track) has been moved to spotify.Track.availability(), and returns a detailed availability status of the track.
Session.is_local(track) is now spotify.Track.is_local(), and returns a boolean.
Removed methods: Session.get_friends, User.full_name, User.picture, and User.relation, as they was removed from the libspotify API.

New features

Add new method: spotify.Playlist.track_create_time(). Contributed by Benjamin Chapus.

v1.5 (2011-10-30)¶

Updated to work with libspotify 9.1.32.

New features

Remember me: when setting the remember_me parameter to True at first login, it is possible to log in again without specifying the username and password attributes. Don’t forget to logout in order to store the credentials.
Add new method: spotify.Playlist.subscribers()
Add new method: spotify.Playlist.num_subscribers()
Add new method: spotify.Playlist.update_subscribers()
Playlist folder boundaries are now recognized. Playlist containers contain both spotify.Playlist and spotify.PlaylistFolder objects. Both classes got a type() method, which returns the string playlist, folder_start, folder_end, or placeholder.

v1.4 (2011-09-24)¶

pyspotify v1.4 only works with libspotify v0.0.8. As libspotify v9.x has been released, this release of pyspotify will probably be the last release to work with libspotify v0.0.8.

API changes

All callbacks with optional userdata are now called with the userdata parameter set to None, which means they are called with the same number of parameters every time.
Messages from the Spotify service (log and user) have been converted to unicode objects.

New features

Exceptions raised in callbacks are written to stderr
spotify.Session.search() now accepts Unicode queries
Add user handling: spotify.User
Add toplist browsing: spotify.ToplistBrowser
Add new method: spotify.Playlist.rename()
Add new method: spotify.Session.get_friends(). Contributed by Francisco Jordano.
Add new method: spotify.Playlist.add_tracks(). Contributed by Andreas Franzén.
Add new method: spotify.PlaylistContainer.add_new_playlist(). Contributed by Andreas Franzén.

Bug fixes

spotify.manager.SpotifySessionManager.log_message() callback used str in place of unicode
spotify.manager.SpotifySessionManager.message_to_user() callback used str in place of unicode
Argument errors were unchecked in spotify.Session.search()
Fix crash on valid error at image creation. Fixed by Jamie Kirkpatrick.
Keep compatibility with Python 2.5. Contributed by Jamie Kirkpatrick.
Callbacks given at artist/album browser creation are now called by pyspotify. Fixed by Jamie Kirkpatrick.
Fix exception when a long was returned from spotify.manager.SpotifySessionManager.music_delivery()

v1.3 (2011-06-11)¶

It has only been four days since the v1.2 release, but we would like to get the change from bytestrings to unicode objects released before more projects start using pyspotify, as this change is really backwards incompatible.

All strings returned by pyspotify has been changed from UTF-8 encoded bytestrings to unicode objects.
Track autolinking enabled for all playlists.
Add spotify.__version__ which exposes the current pyspotify version. The API version of the libspotify used is already available as spotify.api_version.

v1.2 (2011-06-07)¶

As of May 2011, Doug Winter transfered the maintenance of pyspotify to the Mopidy project. The Mopidy developers, which depends upon pyspotify, have during the first half of 2011 been maintaining a branch of pyspotify and related Debian packages, and done some unofficial releases. With this change, we hope to get pyspotify up to speed again, and make it a useful library both for Mopidy and other projects.

Lately, Antoine Pierlot-Garcin aka bok have been doing lots of work on pyspotify, both on catching up with the features of libspotify, fixing and extending the test suite, writing documentation, and on fixing bugs. A big thanks to him!

Upgraded to libspotify 0.0.8
New managers: SpotifyPlaylistManager and SpotifyContainerManager giving access to all the Playlist{,Container} callbacks
Artist and Album browsing available. Contributed by Jamie Kirkpatrick.
Added a method to stop the playback. Contributed by Jamie Kirkpatrick.
Better error messages when not logged in and accessing user information
Added support for a playlist of all starred tracks
Get/Set starred status for a track
Better memory management