Remove gevent dependency, move back to Python threading

Author: Hexxeh

README.md

@@ -25,9 +25,9 @@ Experimental client
 Included is an experimental client called respotify, based on this API. It's almost identical to
 despotify-simple in terms of functionality. Be sure to have the following installed:
 
-* requests 1.0.4
-* gevent 1.0 (install from Git, you'll also need cython and libev installed)
+* requests >= 1.0
 * cherrypy
+* ws4py
 
 Once you've installed these, you can run the client like this:
 

clients/respotify/respotify-helper.py

@@ -3,7 +3,6 @@
 import sys; sys.path.append("../..")
 from spotify_web.friendly import Spotify
 import cherrypy
-from gevent import wsgi
 
 class SpotifyURIHandler(object):
   def default(self, uri = None):

clients/respotify/respotify.py

@@ -2,10 +2,9 @@
 
 import sys; sys.path.append("../..")
 from spotify_web.friendly import Spotify, SpotifyTrack, SpotifyUserlist
-from gevent.fileobject import FileObject
-from threading import Lock
+from threading import Thread, Lock, Event
 from mpd import MPDClient
-import os, subprocess, gevent
+import os, subprocess, time
 
 playing_playlist = None
 current_playlist = None
@@ -185,8 +184,11 @@ def command_help(*args):
 	for k, v in command_map.items():
 		print k+"\t\t"+v[1]
 
+quitting = False
 def command_quit(*args):
 	spotify.logout()
+	global quitting
+	quitting = True
 
 def command_current_playlist(*args):
 	display_playlist(playing_playlist)
@@ -210,8 +212,7 @@ def command_current_playlist(*args):
 def command_loop():
 	header()
 	command_help()
-	sys.stdin = FileObject(sys.stdin)
-	while spotify.api.disconnecting == False:
+	while spotify.api.disconnecting == False and quitting == False:
 		sys.stdout.write("\n> ")
 		sys.stdout.flush()
 		command = raw_input().split(" ")
@@ -223,11 +224,12 @@ def command_loop():
 		else:
 			command_help()
 
+heartbeat_marker = Event()
 def heartbeat_handler():
 	while client != None:
 		with client:
 			client.status()
-		gevent.sleep(15)
+		heartbeat_marker.get(timeout=15)
 
 if len(sys.argv) < 2:
 	print "Usage: "+sys.argv[0]+" <username> <password>"
@@ -239,13 +241,14 @@ def heartbeat_handler():
 	uri_resolver = subprocess.Popen([sys.executable, "respotify-helper.py", sys.argv[1], sys.argv[2]])
 	with client:
 		client.connect(host="localhost", port="6600")
-	gevent.spawn(heartbeat_handler)
+	Thread(target=heartbeat_handler).start()
 	command_loop()
 	os.system("clear")
 	with client:
 		client.clear()
 		client.disconnect()
 		client = None
+		heartbeat_marker.set()
 	uri_resolver.kill()
 else:
 	print "Login failed"

examples/blocking.py

@@ -68,3 +68,5 @@ def display_playlist(playlist):
 		print "Track is available!"
 	else:
 		print "Track is NOT available! Double-check this using the official client"
+
+sp.disconnect()

examples/nonblocking.py

@@ -25,3 +25,4 @@ def login_callback(sp, logged_in):
 else:
 	sp = SpotifyAPI(login_callback)
 	sp.connect(sys.argv[1], sys.argv[2])
+	

install-deps.sh

@@ -5,7 +5,4 @@ VER=$TRAVIS_PYTHON_VERSION
 
 apt-get update -yqq || true
 apt-get install -yqq python$VER
-curl -sSLO --retry 5 --fail https://github.com/downloads/denik/packages/python2.7-cython_0.17.1_i386.deb
-dpkg -i python2.7-cython_0.17.1_i386.deb
-pip install -q requests greenlet protobuf cherrypy ws4py python-mpd2 lxml web.py --upgrade
-pip install -q git+https://github.com/SiteSupport/gevent.git --upgrade
+pip install -q requests protobuf cherrypy ws4py python-mpd2 lxml web.py --upgrade

spotify_web/friendly.py

@@ -2,6 +2,7 @@
 from spotify_web.proto import mercury_pb2, metadata_pb2
 from functools import partial
 from lxml import etree
+from threading import Thread
 import sys
 
 class Cache(object):
@@ -317,7 +318,7 @@ def getPlaylists(self, username = None):
 			playlist_uris += ["spotify:user:"+username+":starred"]
 
 		playlist_uris += [playlist.uri for playlist in self.api.playlists_request(username).contents.items]
-		return [self.objectFromURI(playlist_uri) for playlist_uri in playlist_uris]
+		return self.objectFromURI(playlist_uris)
 
 	def getUserToplist(self, toplist_content_type = "track", username = None):
 		return SpotifyToplist(self, toplist_content_type, "user", username, None)
@@ -360,7 +361,17 @@ def objectFromURI(self, uris, asArray = False):
 		if uri_type == False:
 			return None
 		elif uri_type == "playlist":
-			results =  [SpotifyPlaylist(self, uri=uri) for uri in uris]
+			if len(uris) == 1:
+				results = [SpotifyPlaylist(self, uri=uris[0])]
+			else:
+				results = []
+				def worker(spotify, uri, results):
+					results.append(SpotifyPlaylist(spotify, uri=uri))
+				threads = [Thread(target=worker, args=(self, uri, results)) for uri in uris]
+				for thread in threads:
+					thread.start()
+				for thread in threads:
+					thread.join()
 		elif uri_type in ["track", "album", "artist"]:
 			uris = [uri for uri in uris if not SpotifyUtil.is_local(uri)]
 			objs = self.api.metadata_request(uris)

spotify_web/spotify.py

@@ -1,8 +1,8 @@
 #!/usr/bin/python
 
-from gevent import monkey; monkey.patch_all()
-from ws4py.client.geventclient import WebSocketClient
-import base64, binascii, json, pprint, re, requests, string, sys, time, gevent, operator
+from ws4py.client.threadedclient import WebSocketClient
+from threading import Thread, Event
+import base64, binascii, json, re, requests, sys, operator
 
 from .proto import mercury_pb2, metadata_pb2
 from .proto import playlist4changes_pb2, playlist4content_pb2
@@ -38,7 +38,7 @@ class WrapAsync():
 	timeout = 10
 
 	def __init__(self, callback, func, *args):
-		self.marker = gevent.event.AsyncResult()
+		self.marker = Event()
 
 		if callback == None:
 			callback = self.callback
@@ -50,17 +50,20 @@ def __init__(self, callback, func, *args):
 		func(*args, callback=callback)
 
 	def callback(self, *args):
-		self.marker.set(args)
+		self.data = args
+		self.marker.set()
 
 	def get_data(self):
 		try:
-			data = self.marker.get(timeout = self.timeout)
+			self.marker.wait(timeout = self.timeout)
 
-			if len(data) > 0 and type(data[0] == SpotifyAPI):
-				data = data[1:]
+			if len(self.data) > 0 and type(self.data[0] == SpotifyAPI):
+				self.data = self.data[1:]
 
-			return data if len(data) > 1 else data[0]
+			return self.data if len(self.data) > 1 else self.data[0]
 		except:
+			print "There was an error, disconnecting! Details below:"
+			print sys.exc_info()
 			return False
 
 class SpotifyClient(WebSocketClient):
@@ -70,6 +73,12 @@ def set_api(self, api):
 	def opened(self):
 		self.api_object.login()
 
+	def received_message(self, m):
+		self.api_object.recv_packet(m)
+
+	def closed(self, code, message):
+		self.api_object.shutdown()
+
 class SpotifyUtil():
 	@staticmethod
 	def gid2id(gid):
@@ -127,7 +136,8 @@ class SpotifyAPI():
 	def __init__(self, login_callback_func = False):
 		self.auth_server = "play.spotify.com"
 
-		self.logged_in_marker = gevent.event.AsyncResult()
+		self.logged_in_marker = Event()
+		self.heartbeat_marker = Event()
 		self.username = None
 		self.password = None
 		self.account_type = None
@@ -186,9 +196,6 @@ def auth(self, username, password):
 
 		self.settings = resp.json()["config"]
 
-	def auth_from_json(self, json):
-		self.settings = json
-
 	def populate_userdata_callback(self, sp, resp, callback_data):
 		self.username = resp["user"]
 		self.country = resp["country"]
@@ -197,7 +204,7 @@ def populate_userdata_callback(self, sp, resp, callback_data):
 		if self.login_callback != False:
 			self.do_login_callback(True)
 		else:
-			self.logged_in_marker.set(True)
+			self.logged_in_marker.set()
 		self.chain_callback(sp, resp, callback_data)
 
 	def logged_in(self, sp, resp):
@@ -213,9 +220,9 @@ def login(self):
 
 	def do_login_callback(self, result):
 		if self.login_callback != False:
-			gevent.spawn(self.login_callback, self, result)
+			Thread(target=self.login_callback, args=(self, result)).start()
 		else:
-			self.logged_in_marker.set(False)
+			self.logged_in_marker.set()
 
 	def track_uri(self, track, callback = False):
 		tid = self.recurse_alternatives(track)
@@ -599,18 +606,10 @@ def handle_error(self, err):
 		else:
 			Logging.error(major_str + " - " + minor_str)
 
-	def event_handler(self):
-		while self.disconnecting == False:
-			m = self.ws.receive()
-			if m is not None:
-				self.recv_packet(str(m))
-			else:
-				break
-
 	def heartbeat_handler(self):
 		while self.disconnecting == False:
-			gevent.sleep(15)
 			self.heartbeat()
+			self.heartbeat_marker.wait(timeout=15)
 
 	def connect(self, username, password, timeout = 10):
 		if self.settings == None:
@@ -620,27 +619,29 @@ def connect(self, username, password, timeout = 10):
 			 self.password = password
 
 		Logging.notice("Connecting to "+self.settings["aps"]["ws"][0])
-		
+
 		try:
 			self.ws = SpotifyClient(self.settings["aps"]["ws"][0])
 			self.ws.set_api(self)
 			self.ws.connect()
-			self.greenlets = [
-				gevent.spawn(self.event_handler),
-				gevent.spawn(self.heartbeat_handler)
-			]
+			Thread(target=self.heartbeat_handler).start()
 			if self.login_callback != False:
-				gevent.joinall(self.greenlets)
+				return
 			else:
 				try:
-					return self.logged_in_marker.get(timeout=timeout)
+					self.logged_in_marker.wait(timeout=timeout)
+					return self.is_logged_in
 				except:
 					return False
 		except:
 			self.disconnect()
+			print "There was an error, disconnecting! Details below:"
+			print sys.exc_info()
 			return False
 
-	def disconnect(self):
+	def shutdown(self):
 		self.disconnecting = True
-		gevent.sleep(1)
-		gevent.killall(self.greenlets)
+		self.heartbeat_marker.set()
+
+	def disconnect(self):
+		self.ws.close()

test.py

@@ -10,6 +10,9 @@ def setUp(self):
 		if self.spotify.logged_in() != True:
 			print "Login failed"
 
+	def tearDown(self):
+		self.spotify.logout()
+
 	def test_get_track_by_uri(self):
 		test_uris = {
 			"spotify:track:4DoiEk7AaubTkIkYencvx7": {