/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: 2019-02-04 01:01:24 UTC
  • mto: This revision was merged to the branch mainline in revision 7268.
  • Revision ID: jelmer@jelmer.uk-20190204010124-ni0i4qc6f5tnbvux
Fix source tests.

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
 
import sys
47
 
from bzrlib import (
 
47
from . import (
48
48
    debug,
49
49
    trace,
50
50
    )
51
51
 
 
52
 
52
53
def _log_cleanup_error(exc):
53
54
    trace.mutter('Cleanup failed:')
54
55
    trace.log_exception_quietly()
55
56
    if 'cleanup' in debug.debug_flags:
56
 
        trace.warning('bzr: warning: Cleanup failed: %s', exc)
 
57
        trace.warning('brz: warning: Cleanup failed: %s', exc)
57
58
 
58
59
 
59
60
def _run_cleanup(func, *args, **kwargs):
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
 
 
88
    def __init__(self):
 
89
        self.cleanups = deque()
 
90
 
 
91
    def add_cleanup(self, cleanup_func, *args, **kwargs):
 
92
        """Add a cleanup to run.
 
93
 
 
94
        Cleanups may be added at any time.
 
95
        Cleanups will be executed in LIFO order.
 
96
        """
 
97
        self.cleanups.appendleft((cleanup_func, args, kwargs))
 
98
 
 
99
    def cleanup_now(self):
 
100
        _run_cleanups(self.cleanups)
 
101
        self.cleanups.clear()
 
102
 
 
103
 
 
104
class OperationWithCleanups(ObjectWithCleanups):
82
105
    """A way to run some code with a dynamic cleanup list.
83
106
 
84
107
    This provides a way to add cleanups while the function-with-cleanups is
102
125
    """
103
126
 
104
127
    def __init__(self, func):
 
128
        super(OperationWithCleanups, self).__init__()
105
129
        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
130
 
116
131
    def run(self, *args, **kwargs):
117
132
        return _do_with_cleanups(
121
136
        return _do_with_cleanups(
122
137
            self.cleanups, self.func, *args, **kwargs)
123
138
 
124
 
    def cleanup_now(self):
125
 
        _run_cleanups(self.cleanups)
126
 
        self.cleanups.clear()
127
 
 
128
139
 
129
140
def _do_with_cleanups(cleanup_funcs, func, *args, **kwargs):
130
141
    """Run `func`, then call all the cleanup_funcs.
151
162
    Unike `_run_cleanup`, `_do_with_cleanups` can propagate an exception from a
152
163
    cleanup, but only if there is no exception from func.
153
164
    """
154
 
    # As correct as Python 2.4 allows.
155
165
    try:
156
166
        result = func(*args, **kwargs)
157
 
    except:
 
167
    except BaseException:
158
168
        # We have an exception from func already, so suppress cleanup errors.
159
169
        _run_cleanups(cleanup_funcs)
160
170
        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
 
 
 
171
    # No exception from func, so allow first cleanup error to propgate.
 
172
    pending_cleanups = iter(cleanup_funcs)
 
173
    try:
 
174
        for cleanup, c_args, c_kwargs in pending_cleanups:
 
175
            cleanup(*c_args, **c_kwargs)
 
176
    except BaseException:
 
177
        # Still run the remaining cleanups but suppress any further errors.
 
178
        _run_cleanups(pending_cleanups)
 
179
        raise
 
180
    # No error, so we can return the result
 
181
    return result