summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLance Stout <lancestout@gmail.com>2011-05-31 12:48:43 -0700
committerLance Stout <lancestout@gmail.com>2011-06-01 15:17:22 -0700
commit8aa4396e4490a964e3e1b1a5e6f555e97c16fd3d (patch)
treeed58dc66611c99710a404fe5795f9f3d4364f777
parent14693233504383d4df0ed092c870d5d7baea6538 (diff)
downloadslixmpp-8aa4396e4490a964e3e1b1a5e6f555e97c16fd3d.tar.gz
slixmpp-8aa4396e4490a964e3e1b1a5e6f555e97c16fd3d.tar.bz2
slixmpp-8aa4396e4490a964e3e1b1a5e6f555e97c16fd3d.tar.xz
slixmpp-8aa4396e4490a964e3e1b1a5e6f555e97c16fd3d.zip
Begin experimental use of exceptions.
Provides IqTimeout and IqError which are raised when an Iq response does not arrive in time, or it arrives with type='error'.
-rw-r--r--sleekxmpp/clientxmpp.py11
-rw-r--r--sleekxmpp/exceptions.py13
-rw-r--r--sleekxmpp/stanza/iq.py8
-rw-r--r--sleekxmpp/test/sleektest.py1
-rw-r--r--tests/test_stream_handlers.py5
-rw-r--r--tests/test_stream_roster.py15
6 files changed, 32 insertions, 21 deletions
diff --git a/sleekxmpp/clientxmpp.py b/sleekxmpp/clientxmpp.py
index fb5b2087..77710541 100644
--- a/sleekxmpp/clientxmpp.py
+++ b/sleekxmpp/clientxmpp.py
@@ -231,8 +231,8 @@ class ClientXMPP(BaseXMPP):
'subscription': subscription,
'groups': groups}}
response = iq.send(block, timeout, callback)
- if response in [False, None] or not isinstance(response, Iq):
- return response
+ if response is None:
+ return None
return response['type'] == 'result'
def del_roster_item(self, jid):
@@ -265,12 +265,7 @@ class ClientXMPP(BaseXMPP):
iq.enable('roster')
response = iq.send(block, timeout, callback)
- if response == False:
- self.event('roster_timeout')
-
- if response in [False, None] or not isinstance(response, Iq):
- return response
- else:
+ if callback is None:
return self._handle_roster(response, request=True)
def _handle_stream_features(self, features):
diff --git a/sleekxmpp/exceptions.py b/sleekxmpp/exceptions.py
index 4727f0c6..72c0860a 100644
--- a/sleekxmpp/exceptions.py
+++ b/sleekxmpp/exceptions.py
@@ -52,3 +52,16 @@ class XMPPError(Exception):
self.extension = extension
self.extension_ns = extension_ns
self.extension_args = extension_args
+
+
+class IqTimeout(Exception):
+
+ """
+ An exception which indicates that an IQ request response has not been
+ received within the alloted time window.
+ """
+
+class IqError(Exception):
+
+ def __init__(self, iq):
+ self.iq = iq
diff --git a/sleekxmpp/stanza/iq.py b/sleekxmpp/stanza/iq.py
index 4a12a87e..71419bc4 100644
--- a/sleekxmpp/stanza/iq.py
+++ b/sleekxmpp/stanza/iq.py
@@ -11,6 +11,7 @@ from sleekxmpp.stanza.rootstanza import RootStanza
from sleekxmpp.xmlstream import StanzaBase, ET
from sleekxmpp.xmlstream.handler import Waiter, Callback
from sleekxmpp.xmlstream.matcher import MatcherId
+from sleekxmpp.exceptions import IqTimeout, IqError
class Iq(RootStanza):
@@ -197,7 +198,12 @@ class Iq(RootStanza):
waitfor = Waiter('IqWait_%s' % self['id'], MatcherId(self['id']))
self.stream.register_handler(waitfor)
StanzaBase.send(self, now=now)
- return waitfor.wait(timeout)
+ result = waitfor.wait(timeout)
+ if not result:
+ raise IqTimeout()
+ if result['type'] == 'error':
+ raise IqError(result)
+ return result
else:
return StanzaBase.send(self, now=now)
diff --git a/sleekxmpp/test/sleektest.py b/sleekxmpp/test/sleektest.py
index 7802a9bc..b607a94b 100644
--- a/sleekxmpp/test/sleektest.py
+++ b/sleekxmpp/test/sleektest.py
@@ -16,6 +16,7 @@ import sleekxmpp
from sleekxmpp import ClientXMPP, ComponentXMPP
from sleekxmpp.stanza import Message, Iq, Presence
from sleekxmpp.test import TestSocket, TestLiveSocket
+from sleekxmpp.exceptions import XMPPError, IqTimeout, IqError
from sleekxmpp.xmlstream import ET, register_stanza_plugin
from sleekxmpp.xmlstream import ElementBase, StanzaBase
from sleekxmpp.xmlstream.tostring import tostring
diff --git a/tests/test_stream_handlers.py b/tests/test_stream_handlers.py
index dae4456d..1b831e21 100644
--- a/tests/test_stream_handlers.py
+++ b/tests/test_stream_handlers.py
@@ -90,7 +90,10 @@ class TestHandlers(SleekTest):
iq['id'] = 'test2'
iq['type'] = 'set'
iq['query'] = 'test2'
- reply = iq.send(block=True, timeout=0)
+ try:
+ reply = iq.send(block=True, timeout=0)
+ except IqTimeout:
+ pass
self.xmpp.add_event_handler('message', waiter_handler, threaded=True)
diff --git a/tests/test_stream_roster.py b/tests/test_stream_roster.py
index e1aa1766..95163744 100644
--- a/tests/test_stream_roster.py
+++ b/tests/test_stream_roster.py
@@ -111,19 +111,12 @@ class TestStreamRoster(SleekTest):
def testRosterTimeout(self):
"""Test handling a timed out roster request."""
self.stream_start()
- events = []
-
- def roster_timeout(event):
- events.append('roster_timeout')
-
- self.xmpp.add_event_handler('roster_timeout', roster_timeout)
- self.xmpp.get_roster(timeout=0)
- # Give the event queue time to process.
- time.sleep(.1)
+ def do_test():
+ self.xmpp.get_roster(timeout=0)
+ time.sleep(.1)
- self.failUnless(events == ['roster_timeout'],
- "Roster timeout event not triggered: %s." % events)
+ self.assertRaises(IqTimeout, do_test)
def testRosterCallback(self):
"""Test handling a roster request callback."""