← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/cleanup.py

  • Committer: Martin Pool
  • Date: 2005-05-26 02:13:57 UTC
  • Revision ID: mbp@sourcefrog.net-20050526021357-9a56decdca0c174f
- All top-level classes inherit from object
  (Python new-style classes)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/cleanup.py
1
 
# Copyright (C) 2009 Canonical Ltd
2
 
#
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.
7
 
#
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.
12
 
#
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
16
 
 
17
 
"""Helpers for managing cleanup functions and the errors they might raise.
18
 
 
19
 
The usual way to run cleanup code in Python is::
20
 
 
21
 
    try:
22
 
        do_something()
23
 
    finally:
24
 
        cleanup_something()
25
 
 
26
 
However if both `do_something` and `cleanup_something` raise an exception
27
 
Python will forget the original exception and propagate the one from
28
 
cleanup_something.  Unfortunately, this is almost always much less useful than
29
 
the original exception.
30
 
 
31
 
If you want to be certain that the first, and only the first, error is raised,
32
 
then use::
33
 
 
34
 
    operation = OperationWithCleanups(lambda operation: do_something())
35
 
    operation.add_cleanup(cleanup_something)
36
 
    operation.run()
37
 
 
38
 
This is more inconvenient (because you need to make every try block a
39
 
function), but will ensure that the first error encountered is the one raised,
40
 
while also ensuring all cleanups are run.  See OperationWithCleanups for more
41
 
details.
42
 
"""
43
 
 
44
 
 
45
 
from collections import deque
46
 
import sys
47
 
from bzrlib import (
48
 
    debug,
49
 
    trace,
50
 
    )
51
 
 
52
 
def _log_cleanup_error(exc):
53
 
    trace.mutter('Cleanup failed:')
54
 
    trace.log_exception_quietly()
55
 
    if 'cleanup' in debug.debug_flags:
56
 
        trace.warning('bzr: warning: Cleanup failed: %s', exc)
57
 
 
58
 
 
59
 
def _run_cleanup(func, *args, **kwargs):
60
 
    """Run func(*args, **kwargs), logging but not propagating any error it
61
 
    raises.
62
 
 
63
 
    :returns: True if func raised no errors, else False.
64
 
    """
65
 
    try:
66
 
        func(*args, **kwargs)
67
 
    except KeyboardInterrupt:
68
 
        raise
69
 
    except Exception, exc:
70
 
        _log_cleanup_error(exc)
71
 
        return False
72
 
    return True
73
 
 
74
 
 
75
 
def _run_cleanups(funcs):
76
 
    """Run a series of cleanup functions."""
77
 
    for func, args, kwargs in funcs:
78
 
        _run_cleanup(func, *args, **kwargs)
79
 
 
80
 
 
81
 
class OperationWithCleanups(object):
82
 
    """A way to run some code with a dynamic cleanup list.
83
 
 
84
 
    This provides a way to add cleanups while the function-with-cleanups is
85
 
    running.
86
 
 
87
 
    Typical use::
88
 
 
89
 
        operation = OperationWithCleanups(some_func)
90
 
        operation.run(args...)
91
 
 
92
 
    where `some_func` is::
93
 
 
94
 
        def some_func(operation, args, ...):
95
 
            do_something()
96
 
            operation.add_cleanup(something)
97
 
            # etc
98
 
 
99
 
    Note that the first argument passed to `some_func` will be the
100
 
    OperationWithCleanups object.  To invoke `some_func` without that, use
101
 
    `run_simple` instead of `run`.
102
 
    """
103
 
 
104
 
    def __init__(self, func):
105
 
        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
 
 
116
 
    def run(self, *args, **kwargs):
117
 
        return _do_with_cleanups(
118
 
            self.cleanups, self.func, self, *args, **kwargs)
119
 
 
120
 
    def run_simple(self, *args, **kwargs):
121
 
        return _do_with_cleanups(
122
 
            self.cleanups, self.func, *args, **kwargs)
123
 
 
124
 
    def cleanup_now(self):
125
 
        _run_cleanups(self.cleanups)
126
 
        self.cleanups.clear()
127
 
 
128
 
 
129
 
def _do_with_cleanups(cleanup_funcs, func, *args, **kwargs):
130
 
    """Run `func`, then call all the cleanup_funcs.
131
 
 
132
 
    All the cleanup_funcs are guaranteed to be run.  The first exception raised
133
 
    by func or any of the cleanup_funcs is the one that will be propagted by
134
 
    this function (subsequent errors are caught and logged).
135
 
 
136
 
    Conceptually similar to::
137
 
 
138
 
        try:
139
 
            return func(*args, **kwargs)
140
 
        finally:
141
 
            for cleanup, cargs, ckwargs in cleanup_funcs:
142
 
                cleanup(*cargs, **ckwargs)
143
 
 
144
 
    It avoids several problems with using try/finally directly:
145
 
     * an exception from func will not be obscured by a subsequent exception
146
 
       from a cleanup.
147
 
     * an exception from a cleanup will not prevent other cleanups from
148
 
       running (but the first exception encountered is still the one
149
 
       propagated).
150
 
 
151
 
    Unike `_run_cleanup`, `_do_with_cleanups` can propagate an exception from a
152
 
    cleanup, but only if there is no exception from func.
153
 
    """
154
 
    # As correct as Python 2.4 allows.
155
 
    try:
156
 
        result = func(*args, **kwargs)
157
 
    except:
158
 
        # We have an exception from func already, so suppress cleanup errors.
159
 
        _run_cleanups(cleanup_funcs)
160
 
        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