/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/cleanup.py

  • Committer: Jelmer Vernooij
  • Date: 2017-06-10 16:40:42 UTC
  • mfrom: (6653.6.7 rename-controldir)
  • mto: This revision was merged to the branch mainline in revision 6690.
  • Revision ID: jelmer@jelmer.uk-20170610164042-zrxqgy2htyduvke2
Merge rename-controldir branch.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/cleanup.py
41
41
details.
42
42
"""
43
43
 
 
44
from __future__ import absolute_import
44
45
 
45
46
from collections import deque
46
47
import sys
47
 
from bzrlib import (
 
48
from . import (
48
49
    debug,
49
50
    trace,
50
51
    )
66
67
        func(*args, **kwargs)
67
68
    except KeyboardInterrupt:
68
69
        raise
69
 
    except Exception, exc:
 
70
    except Exception as exc:
70
71
        _log_cleanup_error(exc)
71
72
        return False
72
73
    return True
78
79
        _run_cleanup(func, *args, **kwargs)
79
80
 
80
81
 
81
 
class OperationWithCleanups(object):
 
82
class ObjectWithCleanups(object):
 
83
    """A mixin for objects that hold a cleanup list.
 
84
 
 
85
    Subclass or client code can call add_cleanup and then later `cleanup_now`.
 
86
    """
 
87
    def __init__(self):
 
88
        self.cleanups = deque()
 
89
 
 
90
    def add_cleanup(self, cleanup_func, *args, **kwargs):
 
91
        """Add a cleanup to run.
 
92
 
 
93
        Cleanups may be added at any time.  
 
94
        Cleanups will be executed in LIFO order.
 
95
        """
 
96
        self.cleanups.appendleft((cleanup_func, args, kwargs))
 
97
 
 
98
    def cleanup_now(self):
 
99
        _run_cleanups(self.cleanups)
 
100
        self.cleanups.clear()
 
101
 
 
102
 
 
103
class OperationWithCleanups(ObjectWithCleanups):
82
104
    """A way to run some code with a dynamic cleanup list.
83
105
 
84
106
    This provides a way to add cleanups while the function-with-cleanups is
102
124
    """
103
125
 
104
126
    def __init__(self, func):
 
127
        super(OperationWithCleanups, self).__init__()
105
128
        self.func = func
106
 
        self.cleanups = deque()
107
 
 
108
 
    def add_cleanup(self, cleanup_func, *args, **kwargs):
109
 
        """Add a cleanup to run.
110
 
 
111
 
        Cleanups may be added at any time before or during the execution of
112
 
        self.func.  Cleanups will be executed in LIFO order.
113
 
        """
114
 
        self.cleanups.appendleft((cleanup_func, args, kwargs))
115
129
 
116
130
    def run(self, *args, **kwargs):
117
131
        return _do_with_cleanups(
121
135
        return _do_with_cleanups(
122
136
            self.cleanups, self.func, *args, **kwargs)
123
137
 
124
 
    def cleanup_now(self):
125
 
        _run_cleanups(self.cleanups)
126
 
        self.cleanups.clear()
127
 
 
128
138
 
129
139
def _do_with_cleanups(cleanup_funcs, func, *args, **kwargs):
130
140
    """Run `func`, then call all the cleanup_funcs.
151
161
    Unike `_run_cleanup`, `_do_with_cleanups` can propagate an exception from a
152
162
    cleanup, but only if there is no exception from func.
153
163
    """
154
 
    # As correct as Python 2.4 allows.
155
164
    try:
156
165
        result = func(*args, **kwargs)
157
166
    except:
158
167
        # We have an exception from func already, so suppress cleanup errors.
159
168
        _run_cleanups(cleanup_funcs)
160
169
        raise
161
 
    else:
162
 
        # No exception from func, so allow the first exception from
163
 
        # cleanup_funcs to propagate if one occurs (but only after running all
164
 
        # of them).
165
 
        exc_info = None
166
 
        for cleanup, c_args, c_kwargs in cleanup_funcs:
167
 
            # XXX: Hmm, if KeyboardInterrupt arrives at exactly this line, we
168
 
            # won't run all cleanups... perhaps we should temporarily install a
169
 
            # SIGINT handler?
170
 
            if exc_info is None:
171
 
                try:
172
 
                    cleanup(*c_args, **c_kwargs)
173
 
                except:
174
 
                    # This is the first cleanup to fail, so remember its
175
 
                    # details.
176
 
                    exc_info = sys.exc_info()
177
 
            else:
178
 
                # We already have an exception to propagate, so log any errors
179
 
                # but don't propagate them.
180
 
                _run_cleanup(cleanup, *c_args, **kwargs)
181
 
        if exc_info is not None:
182
 
            raise exc_info[0], exc_info[1], exc_info[2]
183
 
        # No error, so we can return the result
184
 
        return result
185
 
 
186
 
 
 
170
    # No exception from func, so allow first cleanup error to propgate.
 
171
    pending_cleanups = iter(cleanup_funcs)
 
172
    try:
 
173
        for cleanup, c_args, c_kwargs in pending_cleanups:
 
174
            cleanup(*c_args, **c_kwargs)
 
175
    except:
 
176
        # Still run the remaining cleanups but suppress any further errors.
 
177
        _run_cleanups(pending_cleanups)
 
178
        raise
 
179
    # No error, so we can return the result
 
180
    return result