pep/slixmpp
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
slixmpp/sleekxmpp/exceptions.py

87 lines
2.9 KiB
Python
Raw Normal View History

changed license to MIT
2010-03-26 21:32:16 +00:00
"""
SleekXMPP: The Sleek XMPP Library
Copyright (C) 2010 Nathanael C. Fritz
This file is part of SleekXMPP.
Updated sleekxmpp.exceptions with PEP8 style and docs.
2010-08-11 22:21:12 +00:00
See the file LICENSE for copying permission.
changed license to MIT
2010-03-26 21:32:16 +00:00
"""
More PEP8 compliance cleanups. Cleaned up the atom entry stanza.
2010-10-06 19:12:39 +00:00
* major stanza improvements * raise XMPPError in handler to reply with error stanza * started work on pubsub stanzas
2010-01-05 21:56:48 +00:00
class XMPPError(Exception):
Updated sleekxmpp.exceptions with PEP8 style and docs.
2010-08-11 22:21:12 +00:00
"""
A generic exception that may be raised while processing an XMPP stanza
to indicate that an error response stanza should be sent.
The exception method for stanza objects extending RootStanza will create
an error stanza and initialize any additional substanzas using the
extension information included in the exception.
Meant for use in SleekXMPP plugins and applications using SleekXMPP.
"""
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.
2011-08-19 07:08:47 +00:00
def __init__(self, condition='undefined-condition', text=None,
etype='cancel', extension=None, extension_ns=None,
extension_args=None, clear=True):
Updated sleekxmpp.exceptions with PEP8 style and docs.
2010-08-11 22:21:12 +00:00
"""
Create a new XMPPError exception.
Extension information can be included to add additional XML elements
to the generated error stanza.
Arguments:
condition -- The XMPP defined error condition.
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.
2011-08-19 07:08:47 +00:00
Defaults to 'undefined-condition'.
Updated sleekxmpp.exceptions with PEP8 style and docs.
2010-08-11 22:21:12 +00:00
text -- Human readable text describing the error.
etype -- The XMPP error type, such as cancel or modify.
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.
2011-08-19 07:08:47 +00:00
Defaults to 'cancel'.
Updated sleekxmpp.exceptions with PEP8 style and docs.
2010-08-11 22:21:12 +00:00
extension -- Tag name of the extension's XML content.
extension_ns -- XML namespace of the extensions' XML content.
extension_args -- Content and attributes for the extension
element. Same as the additional arguments to
the ET.Element constructor.
XMPPError exceptions can keep a stanza's contents. This allows exceptions to include the original content of a stanza in the error response by including the parameter clear=False when raising the exception.
2011-02-11 20:20:26 +00:00
clear -- Indicates if the stanza's contents should be
removed before replying with an error.
Defaults to True.
Updated sleekxmpp.exceptions with PEP8 style and docs.
2010-08-11 22:21:12 +00:00
"""
Made exceptions work. Raising an XMPPError exception from an event handler now works, even if from a threaded handler. Added stream tests to verify. We should start using XMPPError, it really makes things simple!
2010-10-25 19:09:56 +00:00
if extension_args is None:
extension_args = {}
Updated sleekxmpp.exceptions with PEP8 style and docs.
2010-08-11 22:21:12 +00:00
self.condition = condition
self.text = text
self.etype = etype
XMPPError exceptions can keep a stanza's contents. This allows exceptions to include the original content of a stanza in the error response by including the parameter clear=False when raising the exception.
2011-02-11 20:20:26 +00:00
self.clear = clear
Updated sleekxmpp.exceptions with PEP8 style and docs.
2010-08-11 22:21:12 +00:00
self.extension = extension
self.extension_ns = extension_ns
self.extension_args = extension_args
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'.
2011-05-31 19:48:43 +00:00
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.
2011-08-19 07:08:47 +00:00
class IqTimeout(XMPPError):
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'.
2011-05-31 19:48:43 +00:00
"""
An exception which indicates that an IQ request response has not been
received within the alloted time window.
"""
IqTimeout now references the original sent stanza. A little extra bit of docs for IqError.
2011-06-01 22:28:33 +00:00
def __init__(self, iq):
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.
2011-08-19 07:08:47 +00:00
super(IqTimeout, self).__init__(
condition='remote-server-timeout',
etype='cancel')
IqTimeout now references the original sent stanza. A little extra bit of docs for IqError.
2011-06-01 22:28:33 +00:00
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.
2011-08-19 07:08:47 +00:00
self.iq = iq
PEP8 edits
2011-08-18 09:46:48 +00:00
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.
2011-08-19 07:08:47 +00:00
class IqError(XMPPError):
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'.
2011-05-31 19:48:43 +00:00
IqTimeout now references the original sent stanza. A little extra bit of docs for IqError.
2011-06-01 22:28:33 +00:00
"""
An exception raised when an Iq stanza of type 'error' is received
after making a blocking send call.
"""
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'.
2011-05-31 19:48:43 +00:00
def __init__(self, iq):
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.
2011-08-19 07:08:47 +00:00
super(IqError, self).__init__(
condition=iq['error']['condition'],
text=iq['error']['text'],
etype=iq['error']['type'])
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'.
2011-05-31 19:48:43 +00:00
self.iq = iq
Reference in a new issue Copy permalink