So using sys.excepthook to catch errors only works once.

The error bubbles through the event processing loop, breaking it and hanging the application. Instead, there is now a .exception(e) method on XMLStream which may be overridden or reassigned that will receive all unhandled exceptions (read: not XMPPError) from event and stream handlers.
author: Lance Stout <lancestout@gmail.com> 2011-07-01 15:15:13 -0700
committer: Lance Stout <lancestout@gmail.com> 2011-07-01 15:18:10 -0700
commit: 2a2ac73845ffc8695e2bc55746f45e1a18d55e6c (patch)
tree: 7547644de0fa731d2d2e9f466fc0f33663262575
parent: d8d9e8df16c07bd13bbac72e4445a2930407b244 (diff)
download: slixmpp-2a2ac73845ffc8695e2bc55746f45e1a18d55e6c.tar.gz
slixmpp-2a2ac73845ffc8695e2bc55746f45e1a18d55e6c.tar.bz2
slixmpp-2a2ac73845ffc8695e2bc55746f45e1a18d55e6c.tar.xz
slixmpp-2a2ac73845ffc8695e2bc55746f45e1a18d55e6c.zip
6 files changed, 111 insertions, 38 deletions
diff --git a/sleekxmpp/stanza/rootstanza.py b/sleekxmpp/stanza/rootstanza.py
index bc11476e..9e1d1cfa 100644
--- a/sleekxmpp/stanza/rootstanza.py
+++ b/sleekxmpp/stanza/rootstanza.py
@@ -64,8 +64,7 @@ class RootStanza(StanzaBase):
             # log the error
             log.exception('Error handling {%s}%s stanza' %
                           (self.namespace, self.name))
-            # Finally raise the exception, so it can be handled (or not)
-            # at a higher level by using sys.excepthook.
-            raise e
+            # Finally raise the exception to a global exception handler
+            self.stream.exception(e)
 
 register_stanza_plugin(RootStanza, Error)
diff --git a/sleekxmpp/xmlstream/xmlstream.py b/sleekxmpp/xmlstream/xmlstream.py
index 6282c8d0..c7d0d3a8 100644
--- a/sleekxmpp/xmlstream/xmlstream.py
+++ b/sleekxmpp/xmlstream/xmlstream.py
@@ -764,7 +764,6 @@ class XMLStream(object):
                         Event handlers and the send queue will be threaded
                         regardless of this parameter's value.
         """
-        self._thread_excepthook()
         self.scheduler.process(threaded=True)
 
         def start_thread(name, target):
@@ -1052,30 +1051,16 @@ class XMLStream(object):
             self.event_queue.put(('quit', None, None))
             return
 
-    def _thread_excepthook(self):
+    def exception(self, exception):
         """
-        If a threaded event handler raises an exception, there is no way to
-        catch it except with an excepthook. Currently, each thread has its own
-        excepthook, but ideally we could use the main sys.excepthook.
+        Process an unknown exception.
 
-        Modifies threading.Thread to use sys.excepthook when an exception
-        is not caught.
-        """
-        init_old = threading.Thread.__init__
-
-        def init(self, *args, **kwargs):
-            init_old(self, *args, **kwargs)
-            run_old = self.run
+        Meant to be overridden.
 
-            def run_with_except_hook(*args, **kw):
-                try:
-                    run_old(*args, **kw)
-                except (KeyboardInterrupt, SystemExit):
-                    raise
-                except:
-                    sys.excepthook(*sys.exc_info())
-            self.run = run_with_except_hook
-        threading.Thread.__init__ = init
+        Arguments:
+            exception -- An unhandled exception object.
+        """
+        pass
 
 
 # To comply with PEP8, method names now use underscores.
diff --git a/tests/test_stream_exceptions.py b/tests/test_stream_exceptions.py
index 1143ce28..c41edbb2 100644
--- a/tests/test_stream_exceptions.py
+++ b/tests/test_stream_exceptions.py
@@ -12,7 +12,6 @@ class TestStreamExceptions(SleekTest):
     """
 
     def tearDown(self):
-        sys.excepthook = sys.__excepthook__
         self.stream_close()
 
     def testExceptionReply(self):
@@ -23,8 +22,33 @@ class TestStreamExceptions(SleekTest):
             msg['body'] = 'Body changed'
             raise XMPPError(clear=False)
 
+        self.stream_start()
+        self.xmpp.add_event_handler('message', message)
+
+        self.recv("""
+          <message>
+            <body>This is going to cause an error.</body>
+          </message>
+        """)
+
+        self.send("""
+          <message type="error">
+            <body>This is going to cause an error.</body>
+            <error type="cancel" code="500">
+              <undefined-condition
+                  xmlns="urn:ietf:params:xml:ns:xmpp-stanzas" />
+            </error>
+          </message>
+        """)
+
+    def testExceptionContinueWorking(self):
+        """Test that Sleek continues to respond after an XMPPError is raised."""
+
+        def message(msg):
+            msg.reply()
+            msg['body'] = 'Body changed'
+            raise XMPPError(clear=False)
 
-        sys.excepthook = lambda *args, **kwargs: None
         self.stream_start()
         self.xmpp.add_event_handler('message', message)
 
@@ -44,6 +68,22 @@ class TestStreamExceptions(SleekTest):
           </message>
         """)
 
+        self.recv("""
+          <message>
+            <body>This is going to cause an error.</body>
+          </message>
+        """)
+
+        self.send("""
+          <message type="error">
+            <body>This is going to cause an error.</body>
+            <error type="cancel" code="500">
+              <undefined-condition
+                  xmlns="urn:ietf:params:xml:ns:xmpp-stanzas" />
+            </error>
+          </message>
+        """)
+
     def testXMPPErrorException(self):
         """Test raising an XMPPError exception."""
 
@@ -153,9 +193,8 @@ class TestStreamExceptions(SleekTest):
         def catch_error(*args, **kwargs):
             raised_errors.append(True)
 
-        sys.excepthook = catch_error
-
         self.stream_start()
+        self.xmpp.exception = catch_error
         self.xmpp.add_event_handler('message', message)
 
         self.recv("""
@@ -178,6 +217,58 @@ class TestStreamExceptions(SleekTest):
 
         self.assertEqual(raised_errors, [True], "Exception was not raised: %s" % raised_errors)
 
+    def testUnknownException(self):
+        """Test Sleek continues to respond after an unknown exception."""
+
+        raised_errors = []
+
+        def message(msg):
+            raise ValueError("Did something wrong")
+
+        def catch_error(*args, **kwargs):
+            raised_errors.append(True)
+
+        self.stream_start()
+        self.xmpp.exception = catch_error
+        self.xmpp.add_event_handler('message', message)
+
+        self.recv("""
+          <message>
+            <body>This is going to cause an error.</body>
+          </message>
+        """)
+
+        self.send("""
+          <message type="error">
+            <error type="cancel" code="500">
+              <undefined-condition
+                  xmlns="urn:ietf:params:xml:ns:xmpp-stanzas" />
+              <text xmlns="urn:ietf:params:xml:ns:xmpp-stanzas">
+                SleekXMPP got into trouble.
+              </text>
+            </error>
+          </message>
+        """)
+
+        self.recv("""
+          <message>
+            <body>This is going to cause an error.</body>
+          </message>
+        """)
+
+        self.send("""
+          <message type="error">
+            <error type="cancel" code="500">
+              <undefined-condition
+                  xmlns="urn:ietf:params:xml:ns:xmpp-stanzas" />
+              <text xmlns="urn:ietf:params:xml:ns:xmpp-stanzas">
+                SleekXMPP got into trouble.
+              </text>
+            </error>
+          </message>
+        """)
+
+        self.assertEqual(raised_errors, [True, True], "Exceptions were not raised: %s" % raised_errors)
 
 
 suite = unittest.TestLoader().loadTestsFromTestCase(TestStreamExceptions)
diff --git a/tests/test_stream_xep_0030.py b/tests/test_stream_xep_0030.py
index c960fc7a..1666d3a1 100644
--- a/tests/test_stream_xep_0030.py
+++ b/tests/test_stream_xep_0030.py
@@ -12,7 +12,6 @@ class TestStreamDisco(SleekTest):
     """
 
     def tearDown(self):
-        sys.excepthook = sys.__excepthook__
         self.stream_close()
 
     def testInfoEmptyDefaultNode(self):
@@ -531,11 +530,6 @@ class TestStreamDisco(SleekTest):
 
         raised_exceptions = []
 
-        def catch_exception(*args, **kwargs):
-            raised_exceptions.append(True)
-
-        sys.excepthook = catch_exception
-
         self.stream_start(mode='client',
                           plugins=['xep_0030', 'xep_0059'])
 
@@ -544,8 +538,14 @@ class TestStreamDisco(SleekTest):
                                                   iterator=True)
         results.amount = 10
 
+        def run_test():
+            try:
+                results.next()
+            except StopIteration:
+                raised_exceptions.append(True)
+
         t = threading.Thread(name="get_items_iterator",
-                             target=results.next)
+                             target=run_test)
         t.start()
 
         self.send("""
diff --git a/tests/test_stream_xep_0128.py b/tests/test_stream_xep_0128.py
index 6fee6556..42fc9143 100644
--- a/tests/test_stream_xep_0128.py
+++ b/tests/test_stream_xep_0128.py
@@ -13,7 +13,6 @@ class TestStreamExtendedDisco(SleekTest):
     """
 
     def tearDown(self):
-        sys.excepthook = sys.__excepthook__
         self.stream_close()
 
     def testUsingExtendedInfo(self):
diff --git a/tests/test_stream_xep_0249.py b/tests/test_stream_xep_0249.py
index f49d1f7e..9a25253f 100644
--- a/tests/test_stream_xep_0249.py
+++ b/tests/test_stream_xep_0249.py
@@ -13,7 +13,6 @@ class TestStreamDirectInvite(SleekTest):
     """
 
     def tearDown(self):
-        sys.excepthook = sys.__excepthook__
         self.stream_close()
 
     def testReceiveInvite(self):
author	Lance Stout <lancestout@gmail.com>	2011-07-01 15:15:13 -0700
committer	Lance Stout <lancestout@gmail.com>	2011-07-01 15:18:10 -0700
commit	2a2ac73845ffc8695e2bc55746f45e1a18d55e6c (patch)
tree	7547644de0fa731d2d2e9f466fc0f33663262575
parent	d8d9e8df16c07bd13bbac72e4445a2930407b244 (diff)
download	slixmpp-2a2ac73845ffc8695e2bc55746f45e1a18d55e6c.tar.gz slixmpp-2a2ac73845ffc8695e2bc55746f45e1a18d55e6c.tar.bz2 slixmpp-2a2ac73845ffc8695e2bc55746f45e1a18d55e6c.tar.xz slixmpp-2a2ac73845ffc8695e2bc55746f45e1a18d55e6c.zip