1
# Copyright (C) 2011 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21
class CatchingExceptionThread(threading.Thread):
22
"""A thread that keeps track of exceptions.
24
If an exception occurs during the thread execution, it's caught and
25
re-raised when the thread is joined().
28
def __init__(self, *args, **kwargs):
29
# There are cases where the calling thread must wait, yet, if an
30
# exception occurs, the event should be set so the caller is not
31
# blocked. The main example is a calling thread that want to wait for
32
# the called thread to be in a given state before continuing.
34
sync_event = kwargs.pop('sync_event')
36
# If the caller didn't pass a specific event, create our own
37
sync_event = threading.Event()
38
super(CatchingExceptionThread, self).__init__(*args, **kwargs)
39
self.set_sync_event(sync_event)
41
self.ignored_exceptions = None # see set_ignored_exceptions
43
# compatibility thunk for python-2.4 and python-2.5...
44
if sys.version_info < (2, 6):
45
name = property(threading.Thread.getName, threading.Thread.setName)
47
def set_sync_event(self, event):
48
"""Set the ``sync_event`` event used to synchronize exception catching.
50
When the thread uses an event to synchronize itself with another thread
51
(setting it when the other thread can wake up from a ``wait`` call),
52
the event must be set after catching an exception or the other thread
55
Some threads require multiple events and should set the relevant one
58
Note that the event should be cleared so the caller can wait() on him
59
and be released when the thread set the event.
61
self.sync_event = event
63
def set_ignored_exceptions(self, ignored):
64
"""Declare which exceptions will be ignored.
66
:param ignored: Can be either:
67
- None: all exceptions will be raised,
68
- an exception class: the instances of this class will be ignored,
69
- a tuple of exception classes: the instances of any class of the
71
- a callable: that will be passed the exception object
72
and should return True if the exception should be ignored
75
self.ignored_exceptions = None
76
elif isinstance(ignored, (Exception, tuple)):
77
self.ignored_exceptions = lambda e: isinstance(e, ignored)
79
self.ignored_exceptions = ignored
82
"""Overrides Thread.run to capture any exception."""
83
self.sync_event.clear()
86
super(CatchingExceptionThread, self).run()
88
self.exception = sys.exc_info()
90
# Make sure the calling thread is released
94
def join(self, timeout=None):
95
"""Overrides Thread.join to raise any exception caught.
97
Calling join(timeout=0) will raise the caught exception or return None
98
if the thread is still alive.
100
super(CatchingExceptionThread, self).join(timeout)
101
if self.exception is not None:
102
exc_class, exc_value, exc_tb = self.exception
103
self.exception = None # The exception should be raised only once
104
if (self.ignored_exceptions is None
105
or not self.ignored_exceptions(exc_value)):
106
# Raise non ignored exceptions
107
raise exc_class, exc_value, exc_tb
109
def pending_exception(self):
110
"""Raise the caught exception.
112
This does nothing if no exception occurred.
added
removed
bzrlib/thread.py
