Make Iq exceptions more discoverable and simpler to use.

IqError and IqTimeout now extend XMPPError, so if you don't care
about the difference, you can use:

    try:
        self.do_something_with_iqs()
    except XMPPError:
        # Error? Timeout? I don't care!
        pass

If you do need to distinguish between timeouts and error replies,
you can still continue to use:

    try:
        self.do_somethin_with_iqs()
    except IqError as err:
        pass
    except IqTimeout:
        pass

If you don't catch any Iq errors and you're processing a stanza
then an error response will be sent, just like normal if you raise
XMPPError or any other exception, except that the error messages
will be generic to prevent leaking too much information.
This commit is contained in:
Lance Stout
2011-08-19 00:08:47 -07:00
parent b98555c512
commit f92f96325a
3 changed files with 64 additions and 13 deletions

View File

@@ -13,9 +13,9 @@ import copy
import logging
import sleekxmpp
from sleekxmpp import plugins
from sleekxmpp import plugins, roster
from sleekxmpp.exceptions import IqError, IqTimeout
import sleekxmpp.roster as roster
from sleekxmpp.stanza import Message, Presence, Iq, Error, StreamError
from sleekxmpp.stanza.roster import Roster
from sleekxmpp.stanza.nick import Nick
@@ -743,6 +743,29 @@ class BaseXMPP(XMLStream):
self.event("changed_status", presence)
def exception(self, exception):
"""
Process any uncaught exceptions, notably IqError and
IqTimeout exceptions.
Overrides XMLStream.exception.
Arguments:
exception -- An unhandled exception object.
"""
if isinstance(exception, IqError):
iq = exception.iq
log.error('%s: %s' % (iq['error']['condition'],
iq['error']['text']))
log.warning('You should catch IqError exceptions')
elif isinstance(exception, IqTimeout):
iq = exception.iq
log.error('Request timed out: %s' % iq)
log.warning('You should catch IqTimeout exceptions')
else:
log.exception(exception)
# Restore the old, lowercased name for backwards compatibility.
basexmpp = BaseXMPP