Changelog

v2.0.0 (2015-06-01)

pyspotify 2.x is a full rewrite of pyspotify. While pyspotify 1.x is a CPython C extension, pyspotify 2.x uses CFFI to wrap the libspotify C library. It works on CPython 2.7 and 3.2+, as well as PyPy 2.6+. pyspotify 2.0 makes 100% of the libspotify 12.1.51 API available from Python, going far beyond the API coverage of pyspotify 1.x.

The following are the changes since pyspotify 2.0.0b5.

Dependency changes

  • Require cffi >= 1.0. (Fixes: #133, #160)
  • If you’re using pyspotify with PyPy or PyPy3 you need version 2.6 or newer as older versions of PyPy come with a too old cffi version.

ALSA sink

  • Changed the spotify.AlsaSink keyword argument card to device to align with pyalsaaudio 0.8.
  • Updated to work with pyalsaaudio 0.8 which changed the signature of alsaaudio.PCM. spotify.AlsaSink still works with pyalsaaudio 0.7, but 0.8 is recommended at least for Python 3 users, as it fixes a memory leak present on Python 3 (see #127). (Fixes: #162)

v2.0.0b5 (2015-05-09)

A fifth beta with a couple of bug fixes.

Minor changes

Bug fixes

v2.0.0b4 (2015-01-13)

The fourth beta includes a single API change, a couple of API additions, and otherwise minor tweaks to logging.

pyspotify 2.x has been verified to work on PyPy3, and PyPy3 is now part of the test matrix.

Minor changes

  • Added spotify.Link.url which returns an https://open.spotify.com/... URL for the link object.
  • Adjusted info, warning, and error level log messages to include the word “Spotify” or “pyspotify” for context in applications not including the logger name in the log. debug level messages have not been changed, as it is assumed that more details, including the logger name, is included in debug logs.
  • Added spotify.player.Player.state which is maintained by calls to the various Player methods.

Bug fixes

  • Fix spotify.Playlist.reorder_tracks(). It now accepts a list of track indexes instead of a list of tracks. This makes it possible to reorder any of multiple identical tracks in a playlist and is consistent with spotify.Playlist.remove_tracks(). (Fixes: #134)
  • Fix pause/resume/stop in the examples/shell.py example. (PR: #140)
  • Errors passed to session callbacks are now logged with the full error type representation, instead of just the integer value. E.g. where previously only “8” was logged, we now log “<ErrorType.UNABLE_TO_CONTACT_SERVER: 8>”.

v2.0.0b3 (2014-05-04)

The third beta includes a couple of changes to the API in the name of consistency, as well as three minor improvements.

Also worth noticing is that with this release, pyspotify 2.x has been in development for a year and a day. Happy birthday, pyspotify 2!

Refactoring: Connection cleanup

Parts of spotify.Session and spotify.Session.offline has been moved to spotify.Session.connection:

Refactoring: position vs index

Originally, pyspotify named everything identically with libspotify and have thus ended up with a mix of the terms “position” and “index” for the same concept. Now, we use “index” all over the place, as that’s also the name used in the Python world at large. This changes the signature of three methods, which may affect you if you use keyword arguments to call the methods. There’s also a number of affected events, but these changes shouldn’t stop your code from working.

Affected functions include:

Affected events include:

Minor changes

  • load() methods now return the object if it is already loaded, even if state isn’t LOGGED_IN. Previously, a RuntimeError was raised requiring the session to be logged in and online before loading already loaded objects.
  • spotify.Playlist.tracks now implements the collections.MutableSequence contract, supporting deleting items with del playlist.tracks[i], adding items with playlist.tracks[i] = track, etc.
  • spotify.Session.get_link() and all other methods accepting Spotify URIs now also understand open.spotify.com and play.spotify.com URLs.

v2.0.0b2 (2014-04-29)

The second beta is a minor bug fix release.

Bug fixes

  • Fix spotify.Playlist.remove_tracks. It now accepts a list of track positions instead of a list of tracks. This makes it possible to remove any of multiple identical tracks in a playlist. (Fixes: #128)

Minor changes

  • Make all objects compare as equal and have the same hash if they wrap the same libspotify object. This makes it possible to find the index of a track in a playlist by doing playlist.tracks.index(track), where playlist.tracks is a custom collection always returning new Track instances. (Related to: #128)
  • spotify.Config.ca_certs_filename now works on systems where libspotify has this field. On systems where this field isn’t present in libspotify, assigning to it will have no effect. Previously, assignment to this field was a noop on all platforms because the field is missing from libspotify on OS X.

v2.0.0b1 (2014-04-24)

pyspotify 2.x is a full rewrite of pyspotify. While pyspotify 1.x is a CPython C extension, pyspotify 2.x uses CFFI to make 100% of the libspotify C library available from Python. It works on CPython 2.7 and 3.2+, as well as PyPy 2.1+.

Since the previous release, pyspotify has become thread safe. That is, pyspotify can safely be used from multiple threads. The added thread safety made an integrated event loop possible, which greatly simplifies the usage of pyspotify, as can be seen from the updated example in examples/shell.py. Audio sink helpers for ALSA and PortAudio have been added, together with updated examples that can play music. A number of bugs have been fixed, and at the time of the release, there are no known issues.

The pyspotify 2.0.0b1 release marks the completion of all planned features for pyspotify 2.x. The plans for the next releases are focused on fixing bugs as they surface, incrementally improving the documentation, and integrating feedback from increased usage of the library in the wild.

Feature: Thread safety

  • Hold the global lock while we are working with pointers returned by libspotify. This ensures that we never call libspotify from another thread while we are still working on the data returned by the previous libspotify call, which could make the data garbage.
  • Ensure we never edit shared data structures without holding the global lock.

Feature: Event loop

Feature: Audio playback

  • Add spotify.AlsaSink, an audio sink for playback through ALSA on Linux systems.
  • Add spotify.PortAudioSink, an audio sink for playback through PortAudio on most platforms, including Linux, OS X, and Windows.
  • Update examples/shell.py to use the ALSA sink to play music.
  • Add examples/play_track.py as a simpler example of audio playback.

Refactoring: Remove global state

To prepare for removing all global state, the use of the module attribute spotify.session_instance has been replaced with explicit passing of the session object to all objects that needs it. To allow for this, the following new methods have been added, and should be used instead of their old equivalents:

Refactoring: Consistent naming of Session members

With all the above getters added to the spotify.Session object, it made sense to rename some existing methods of Session for consistency:

  • spotify.Session.starred_for_user() is replaced by get_starred().
  • spotify.Session.starred to get the currently logged in user’s starred playlist is replaced by get_starred() without any arguments.
  • spotify.Session.get_published_playlists() replaces published_playlists_for_user(). As previously, it returns the published playlists for the currently logged in user if no username is provided.

Refactoring: Consistent naming of threading.Event objects

All threading.Event objects have been renamed to be consistently named across classes.

Refactoring: Change how to register image load listeners

pyspotify has two main schemes for registering listener functions:

  • Objects that only emit an event when it is done loading, like AlbumBrowser, ArtistBrowser, InboxPostResult, Search, and Toplist, accept a single callback as a callback argument to its constructor or constructor methods.
  • Objects that have multiple callback events, like Session, PlaylistContainer, and Playlist, accept the registration and unregistration of one or more listener functions for each event it emits. This can happen any time during the object’s life cycle.

Due to pyspotify’s close mapping to libspotify’s organization, Image objects used to use a third variant with two methods, add_load_callback() and remove_load_callback(), for adding and removing load callbacks. These methods have now been removed, and Image accepts a callback argument to its constructor and constructor methods:

Bug fixes

  • Remove multiple extra sp_link_add_ref() calls, potentially causing memory leaks in libspotify.
  • Add missing error check to spotify.Playlist.add_tracks().
  • Keep album, artist, image, inbox, search, and toplist objects alive until their complete/load callbacks have been called, even if the library user doesn’t keep any references to the objects. (Fixes: #121)
  • Fix flipped logic causing crash in spotify.Album.cover_link(). (Fixes: #126)
  • Work around segfault in libspotify if private_session is set before the session is logged in and the first events are processed. This is a bug in libspotify which has been reported to Spotify through their IRC channel.
  • Multiple attributes on Track raised an exception if accessed before the track was loaded. They now return None or similar as documented.
  • Fix segfault when creating local tracks without all arguments specified. NULL was used as the placeholder instead of the empty string.
  • Support negative indexes on all custom sequence types. For example, collection[-1] returns the last element in the collection.
  • We now cache playlists when created from URIs. Previously, only playlists created from sp_playlist objects were cached. This avoids a potentially large number of wrapper object recreations due to a flood of updates to the playlist when it is intially loaded. Combined with having registered a callback for the libspotify playlist_update_in_progress callback, this could cause deep call stacks reaching the maximum recursion depth. (Fixes: #122)

Minor changes

v2.0.0a1 (2014-02-14)

pyspotify 2.x is a full rewrite of pyspotify. While pyspotify 1.x is a CPython C extension, pyspotify 2.x uses CFFI to wrap the libspotify C library. It works on CPython 2.7 and 3.2+, as well as PyPy 2.1+.

This first alpha release of pyspotify 2.0.0 makes 100% of the libspotify 12.1.51 API available from Python, going far beyond the API coverage of pyspotify 1.x.

pyspotify 2.0.0a1 has an extensive test suite with 98% line coverage. All tests pass on all combinations of CPython 2.7, 3.2, 3.3, PyPy 2.2 running on Linux on i386, amd64, armel, and armhf. Mac OS X should work, but has not been tested recently.

This release does not provide:

  • thread safety,
  • an event loop for regularly processing libspotify events, or
  • audio playback drivers.

These features are planned for the upcoming prereleases.

Development milestones

  • 2014-02-13: Playlist callbacks complete. pyspotify 2.x now covers 100% of the libspotify 12 API. Docs reviewed, quickstart guide extended. Redundant getters/setters removed.
  • 2014-02-08: Playlist container callbacks complete.
  • 2014-01-31: Redesign session event listening to a model supporting multiple listeners per event, with a nicer API for registering listeners.
  • 2013-12-16: Ensure we never call libspotify from two different threads at the same time. We can’t assume that the CPython GIL will ensure this for us, as we target non-CPython interpreters like PyPy.
  • 2013-12-13: Artist browsing complete.
  • 2013-12-13: Album browsing complete.
  • 2013-11-29: Toplist subsystem complete.
  • 2013-11-27: Inbox subsystem complete.
  • 2013-10-14: Playlist subsystem almost complete.
  • 2013-06-21: Search subsystem complete.
  • 2013-06-10: Album subsystem complete.
  • 2013-06-09: Track and artist subsystem complete.
  • 2013-06-02: Session subsystem complete, with all methods.
  • 2013-06-01: Session callbacks complete.
  • 2013-05-25: Session config complete.
  • 2013-05-16: Link subsystem complete.
  • 2013-05-09: User subsystem complete.
  • 2013-05-08: Session configuration and creation, with login and logout works.
  • 2013-05-03: The Python object spotify.lib is a working CFFI wrapper around the entire libspotify 12 API. This will be the foundation for more pythonic APIs. The library currently works on CPython 2.7, 3.3 and PyPy 2.

v1.x series

See the pyspotify 1.x changelog.