← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/symbol_versioning.py

  • Committer: Vincent Ladeuil
  • Date: 2008-01-29 15:16:31 UTC
  • mto: (3206.1.1 trunk)
  • mto: This revision was merged to the branch mainline in revision 3207.
  • Revision ID: v.ladeuil+lp@free.fr-20080129151631-vqjd13tb405mobx6
Fix two more leaking tmp dirs, by reworking TransformPreview lock handling.

* bzrlib/tests/test_transform.py:
(TestTransformMerge): Revert previous patch and cleanly call
preview.finalize now that we can.

* bzrlib/tests/test_merge.py:
(TestMerge.test_make_preview_transform): Catch TransformPreview
leak.

* bzrlib/builtins.py:
(cmd_merge._do_preview): Finalize the TransformPreview or the
limbodir will stay in /tmp.

* bzrlib/transform.py:
(TreeTransformBase.__init__): Create the _deletiondir since it's
reffered to by finalize.
(TreeTransformBase.finalize): Delete the dir only if _deletiondir
is set.
(TreeTransform.__init__): Use a temp var for deletiondir and set
the attribute after the base class __init__ has been called.
(TransformPreview.__init__): Read locks the tree since finalize
wants to unlock it (as suggested by Aaron).

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/symbol_versioning.py
1
 
# Copyright (C) 2006, 2007, 2008, 2009 Canonical Ltd
 
1
# Copyright (C) 2006, 2007 Canonical Ltd
 
2
#   Authors: Robert Collins <robert.collins@canonical.com> and others
2
3
#
3
4
# This program is free software; you can redistribute it and/or modify
4
5
# it under the terms of the GNU General Public License as published by
12
13
#
13
14
# You should have received a copy of the GNU General Public License
14
15
# 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
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
17
 
17
18
"""Symbol versioning
18
19
 
20
21
"""
21
22
 
22
23
__all__ = ['deprecated_function',
23
 
           'deprecated_in',
24
24
           'deprecated_list',
25
25
           'deprecated_method',
26
26
           'DEPRECATED_PARAMETER',
27
27
           'deprecated_passed',
28
 
           'set_warning_method',
29
 
           'warn',
 
28
           'warn', 'set_warning_method', 'zero_seven',
 
29
           'zero_eight',
 
30
           'zero_nine',
 
31
           'zero_ten',
 
32
           'zero_eleven',
 
33
           'zero_twelve',
 
34
           'zero_thirteen',
 
35
           'zero_fourteen',
 
36
           'zero_fifteen',
 
37
           'zero_sixteen',
 
38
           'zero_seventeen',
 
39
           'zero_eighteen',
 
40
           'zero_ninety',
 
41
           'zero_ninetyone',
 
42
           'zero_ninetytwo',
 
43
           'zero_ninetythree',
 
44
           'one_zero',
 
45
           'one_one',
 
46
           'one_two',
30
47
           ]
31
48
 
32
49
from warnings import warn
33
50
 
34
 
import bzrlib
35
 
 
36
51
 
37
52
DEPRECATED_PARAMETER = "A deprecated parameter marker."
38
 
 
39
 
 
40
 
def deprecated_in(version_tuple):
41
 
    """Generate a message that something was deprecated in a release.
42
 
 
43
 
    >>> deprecated_in((1, 4, 0))
44
 
    '%s was deprecated in version 1.4.0.'
45
 
    """
46
 
    return ("%%s was deprecated in version %s."
47
 
            % bzrlib._format_version_tuple(version_tuple))
48
 
 
 
53
zero_seven = "%s was deprecated in version 0.7."
 
54
zero_eight = "%s was deprecated in version 0.8."
 
55
zero_nine = "%s was deprecated in version 0.9."
 
56
zero_ten = "%s was deprecated in version 0.10."
 
57
zero_eleven = "%s was deprecated in version 0.11."
 
58
zero_twelve = "%s was deprecated in version 0.12."
 
59
zero_thirteen = "%s was deprecated in version 0.13."
 
60
zero_fourteen = "%s was deprecated in version 0.14."
 
61
zero_fifteen = "%s was deprecated in version 0.15."
 
62
zero_sixteen = "%s was deprecated in version 0.16."
 
63
zero_seventeen = "%s was deprecated in version 0.17."
 
64
zero_eighteen = "%s was deprecated in version 0.18."
 
65
zero_ninety = "%s was deprecated in version 0.90."
 
66
zero_ninetyone = "%s was deprecated in version 0.91."
 
67
zero_ninetytwo = "%s was deprecated in version 0.92."
 
68
one_zero = "%s was deprecated in version 1.0."
 
69
zero_ninetythree = one_zero # Maintained for backwards compatibility
 
70
one_one = "%s was deprecated in version 1.1."
 
71
one_two = "%s was deprecated in version 1.2."
49
72
 
50
73
def set_warning_method(method):
51
74
    """Set the warning method to be used by this module.
88
111
 
89
112
    def function_decorator(callable):
90
113
        """This is the function python calls to perform the decoration."""
91
 
 
 
114
        
92
115
        def decorated_function(*args, **kwargs):
93
116
            """This is the decorated function."""
94
 
            from bzrlib import trace
95
 
            trace.mutter_callsite(4, "Deprecated function called")
96
117
            warn(deprecation_string(callable, deprecation_version),
97
118
                DeprecationWarning, stacklevel=2)
98
119
            return callable(*args, **kwargs)
105
126
def deprecated_method(deprecation_version):
106
127
    """Decorate a method so that use of it will trigger a warning.
107
128
 
108
 
    To deprecate a static or class method, use
 
129
    To deprecate a static or class method, use 
109
130
 
110
131
        @staticmethod
111
132
        @deprecated_function
112
133
        def ...
113
 
 
 
134
    
114
135
    To deprecate an entire class, decorate __init__.
115
136
    """
116
137
 
117
138
    def method_decorator(callable):
118
139
        """This is the function python calls to perform the decoration."""
119
 
 
 
140
        
120
141
        def decorated_method(self, *args, **kwargs):
121
142
            """This is the decorated method."""
122
 
            from bzrlib import trace
123
143
            if callable.__name__ == '__init__':
124
144
                symbol = "%s.%s" % (self.__class__.__module__,
125
145
                                    self.__class__.__name__,
129
149
                                       self.__class__.__name__,
130
150
                                       callable.__name__
131
151
                                       )
132
 
            trace.mutter_callsite(4, "Deprecated method called")
133
152
            warn(deprecation_version % symbol, DeprecationWarning, stacklevel=2)
134
153
            return callable(self, *args, **kwargs)
135
154
        _populate_decorated(callable, deprecation_version, "method",
140
159
 
141
160
def deprecated_passed(parameter_value):
142
161
    """Return True if parameter_value was used."""
143
 
    # FIXME: it might be nice to have a parameter deprecation decorator.
 
162
    # FIXME: it might be nice to have a parameter deprecation decorator. 
144
163
    # it would need to handle positional and *args and **kwargs parameters,
145
164
    # which means some mechanism to describe how the parameter was being
146
165
    # passed before deprecation, and some way to deprecate parameters that
148
167
    # we cannot just forward to a new method name.I.e. in the following
149
168
    # examples we would want to have callers that pass any value to 'bad' be
150
169
    # given a warning - because we have applied:
151
 
    # @deprecated_parameter('bad', deprecated_in((1, 5, 0))
 
170
    # @deprecated_parameter('bad', zero_seven)
152
171
    #
153
172
    # def __init__(self, bad=None)
154
173
    # def __init__(self, bad, other)
166
185
    if len(docstring_lines) == 0:
167
186
        decorated_callable.__doc__ = deprecation_version % ("This " + label)
168
187
    elif len(docstring_lines) == 1:
169
 
        decorated_callable.__doc__ = (callable.__doc__
 
188
        decorated_callable.__doc__ = (callable.__doc__ 
170
189
                                    + "\n"
171
190
                                    + "\n"
172
191
                                    + deprecation_version % ("This " + label)
216
235
        ):
217
236
        """Create a dict that warns when read or modified.
218
237
 
219
 
        :param deprecation_version: string for the warning format to raise,
220
 
            typically from deprecated_in()
 
238
        :param deprecation_version: something like zero_nine
221
239
        :param initial_value: The contents of the dict
222
240
        :param variable_name: This allows better warnings to be printed
223
 
        :param advice: String of advice on what callers should do instead
 
241
        :param advice: String of advice on what callers should do instead 
224
242
            of using this variable.
225
243
        """
226
244
        self._deprecation_version = deprecation_version
242
260
                    initial_value, extra=None):
243
261
    """Create a list that warns when modified
244
262
 
245
 
    :param deprecation_version: string for the warning format to raise,
246
 
        typically from deprecated_in()
 
263
    :param deprecation_version: something like zero_nine
247
264
    :param initial_value: The contents of the list
248
265
    :param variable_name: This allows better warnings to be printed
249
266
    :param extra: Extra info to print when printing a warning
262
279
        def _warn_deprecated(self, func, *args, **kwargs):
263
280
            warn(msg, DeprecationWarning, stacklevel=3)
264
281
            return func(self, *args, **kwargs)
265
 
 
 
282
            
266
283
        def append(self, obj):
267
284
            """appending to %s is deprecated""" % (variable_name,)
268
285
            return self._warn_deprecated(list.append, obj)
280
297
            return self._warn_deprecated(list.remove, value)
281
298
 
282
299
        def pop(self, index=None):
283
 
            """pop'ing from %s is deprecated""" % (variable_name,)
 
300
            """pop'ing from from %s is deprecated""" % (variable_name,)
284
301
            if index:
285
302
                return self._warn_deprecated(list.pop, index)
286
303
            else:
288
305
                return self._warn_deprecated(list.pop)
289
306
 
290
307
    return _DeprecatedList(initial_value)
291
 
 
292
 
 
293
 
def _check_for_filter(error_only):
294
 
    """Check if there is already a filter for deprecation warnings.
295
 
 
296
 
    :param error_only: Only match an 'error' filter
297
 
    :return: True if a filter is found, False otherwise
298
 
    """
299
 
    import warnings
300
 
    for filter in warnings.filters:
301
 
        if issubclass(DeprecationWarning, filter[2]):
302
 
            # This filter will effect DeprecationWarning
303
 
            if not error_only or filter[0] == 'error':
304
 
                return True
305
 
    return False
306
 
 
307
 
 
308
 
def suppress_deprecation_warnings(override=True):
309
 
    """Call this function to suppress all deprecation warnings.
310
 
 
311
 
    When this is a final release version, we don't want to annoy users with
312
 
    lots of deprecation warnings. We only want the deprecation warnings when
313
 
    running a dev or release candidate.
314
 
 
315
 
    :param override: If True, always set the ignore, if False, only set the
316
 
        ignore if there isn't already a filter.
317
 
    """
318
 
    import warnings
319
 
    if not override and _check_for_filter(error_only=False):
320
 
        # If there is already a filter effecting suppress_deprecation_warnings,
321
 
        # then skip it.
322
 
        return
323
 
    warnings.filterwarnings('ignore', category=DeprecationWarning)
324
 
 
325
 
 
326
 
def activate_deprecation_warnings(override=True):
327
 
    """Call this function to activate deprecation warnings.
328
 
 
329
 
    When running in a 'final' release we suppress deprecation warnings.
330
 
    However, the test suite wants to see them. So when running selftest, we
331
 
    re-enable the deprecation warnings.
332
 
 
333
 
    Note: warnings that have already been issued under 'ignore' will not be
334
 
    reported after this point. The 'warnings' module has already marked them as
335
 
    handled, so they don't get issued again.
336
 
 
337
 
    :param override: If False, only add a filter if there isn't an error filter
338
 
        already. (This slightly differs from suppress_deprecation_warnings, in
339
 
        because it always overrides everything but -Werror).
340
 
    """
341
 
    import warnings
342
 
    if not override and _check_for_filter(error_only=True):
343
 
        # DeprecationWarnings are already turned into errors, don't downgrade
344
 
        # them to 'default'.
345
 
        return
346
 
    warnings.filterwarnings('default', category=DeprecationWarning)