← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/symbol_versioning.py

Merge up bzr.dev.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/symbol_versioning.py
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2006, 2007, 2008 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
 
19
20
The methods here allow for api symbol versioning.
20
21
"""
21
22
 
22
 
from __future__ import absolute_import
23
 
 
24
23
__all__ = ['deprecated_function',
25
24
           'deprecated_in',
26
25
           'deprecated_list',
29
28
           'deprecated_passed',
30
29
           'set_warning_method',
31
30
           'warn',
 
31
           'zero_seven',
 
32
           'zero_eight',
 
33
           'zero_nine',
 
34
           'zero_ten',
 
35
           'zero_eleven',
 
36
           'zero_twelve',
 
37
           'zero_thirteen',
 
38
           'zero_fourteen',
 
39
           'zero_fifteen',
 
40
           'zero_sixteen',
 
41
           'zero_seventeen',
 
42
           'zero_eighteen',
 
43
           'zero_ninety',
 
44
           'zero_ninetyone',
 
45
           'zero_ninetytwo',
 
46
           'zero_ninetythree',
 
47
           'one_zero',
 
48
           'one_one',
 
49
           'one_two',
 
50
           'one_three',
 
51
           'one_four',
 
52
           'one_five',
 
53
           'one_six',
32
54
           ]
33
55
 
34
 
 
35
 
import warnings
36
 
# Import the 'warn' symbol so bzrlib can call it even if we redefine it
37
56
from warnings import warn
38
57
 
39
58
import bzrlib
40
59
 
41
60
 
42
61
DEPRECATED_PARAMETER = "A deprecated parameter marker."
 
62
zero_seven = "%s was deprecated in version 0.7."
 
63
zero_eight = "%s was deprecated in version 0.8."
 
64
zero_nine = "%s was deprecated in version 0.9."
 
65
zero_ten = "%s was deprecated in version 0.10."
 
66
zero_eleven = "%s was deprecated in version 0.11."
 
67
zero_twelve = "%s was deprecated in version 0.12."
 
68
zero_thirteen = "%s was deprecated in version 0.13."
 
69
zero_fourteen = "%s was deprecated in version 0.14."
 
70
zero_fifteen = "%s was deprecated in version 0.15."
 
71
zero_sixteen = "%s was deprecated in version 0.16."
 
72
zero_seventeen = "%s was deprecated in version 0.17."
 
73
zero_eighteen = "%s was deprecated in version 0.18."
 
74
zero_ninety = "%s was deprecated in version 0.90."
 
75
zero_ninetyone = "%s was deprecated in version 0.91."
 
76
zero_ninetytwo = "%s was deprecated in version 0.92."
 
77
one_zero = "%s was deprecated in version 1.0."
 
78
zero_ninetythree = one_zero # Maintained for backwards compatibility
 
79
one_one = "%s was deprecated in version 1.1."
 
80
one_two = "%s was deprecated in version 1.2."
 
81
one_three = "%s was deprecated in version 1.3."
 
82
one_four = "%s was deprecated in version 1.4."
 
83
one_five = "%s was deprecated in version 1.5."
 
84
one_six = "%s was deprecated in version 1.6."
43
85
 
44
86
 
45
87
def deprecated_in(version_tuple):
46
88
    """Generate a message that something was deprecated in a release.
47
89
 
48
90
    >>> deprecated_in((1, 4, 0))
49
 
    '%s was deprecated in version 1.4.0.'
 
91
    '%s was deprecated in version 1.4'
50
92
    """
51
 
    return ("%%s was deprecated in version %s."
52
 
            % bzrlib._format_version_tuple(version_tuple))
 
93
    return ("%s was deprecated in version "
 
94
            + bzrlib._format_version_tuple(version_tuple))
53
95
 
54
96
 
55
97
def set_warning_method(method):
93
135
 
94
136
    def function_decorator(callable):
95
137
        """This is the function python calls to perform the decoration."""
96
 
 
 
138
        
97
139
        def decorated_function(*args, **kwargs):
98
140
            """This is the decorated function."""
99
 
            from bzrlib import trace
100
 
            trace.mutter_callsite(4, "Deprecated function called")
101
141
            warn(deprecation_string(callable, deprecation_version),
102
142
                DeprecationWarning, stacklevel=2)
103
143
            return callable(*args, **kwargs)
110
150
def deprecated_method(deprecation_version):
111
151
    """Decorate a method so that use of it will trigger a warning.
112
152
 
113
 
    To deprecate a static or class method, use
 
153
    To deprecate a static or class method, use 
114
154
 
115
155
        @staticmethod
116
156
        @deprecated_function
117
157
        def ...
118
 
 
 
158
    
119
159
    To deprecate an entire class, decorate __init__.
120
160
    """
121
161
 
122
162
    def method_decorator(callable):
123
163
        """This is the function python calls to perform the decoration."""
124
 
 
 
164
        
125
165
        def decorated_method(self, *args, **kwargs):
126
166
            """This is the decorated method."""
127
 
            from bzrlib import trace
128
167
            if callable.__name__ == '__init__':
129
168
                symbol = "%s.%s" % (self.__class__.__module__,
130
169
                                    self.__class__.__name__,
134
173
                                       self.__class__.__name__,
135
174
                                       callable.__name__
136
175
                                       )
137
 
            trace.mutter_callsite(4, "Deprecated method called")
138
176
            warn(deprecation_version % symbol, DeprecationWarning, stacklevel=2)
139
177
            return callable(self, *args, **kwargs)
140
178
        _populate_decorated(callable, deprecation_version, "method",
145
183
 
146
184
def deprecated_passed(parameter_value):
147
185
    """Return True if parameter_value was used."""
148
 
    # FIXME: it might be nice to have a parameter deprecation decorator.
 
186
    # FIXME: it might be nice to have a parameter deprecation decorator. 
149
187
    # it would need to handle positional and *args and **kwargs parameters,
150
188
    # which means some mechanism to describe how the parameter was being
151
189
    # passed before deprecation, and some way to deprecate parameters that
171
209
    if len(docstring_lines) == 0:
172
210
        decorated_callable.__doc__ = deprecation_version % ("This " + label)
173
211
    elif len(docstring_lines) == 1:
174
 
        decorated_callable.__doc__ = (callable.__doc__
 
212
        decorated_callable.__doc__ = (callable.__doc__ 
175
213
                                    + "\n"
176
214
                                    + "\n"
177
215
                                    + deprecation_version % ("This " + label)
225
263
            typically from deprecated_in()
226
264
        :param initial_value: The contents of the dict
227
265
        :param variable_name: This allows better warnings to be printed
228
 
        :param advice: String of advice on what callers should do instead
 
266
        :param advice: String of advice on what callers should do instead 
229
267
            of using this variable.
230
268
        """
231
269
        self._deprecation_version = deprecation_version
267
305
        def _warn_deprecated(self, func, *args, **kwargs):
268
306
            warn(msg, DeprecationWarning, stacklevel=3)
269
307
            return func(self, *args, **kwargs)
270
 
 
 
308
            
271
309
        def append(self, obj):
272
310
            """appending to %s is deprecated""" % (variable_name,)
273
311
            return self._warn_deprecated(list.append, obj)
285
323
            return self._warn_deprecated(list.remove, value)
286
324
 
287
325
        def pop(self, index=None):
288
 
            """pop'ing from %s is deprecated""" % (variable_name,)
 
326
            """pop'ing from from %s is deprecated""" % (variable_name,)
289
327
            if index:
290
328
                return self._warn_deprecated(list.pop, index)
291
329
            else:
293
331
                return self._warn_deprecated(list.pop)
294
332
 
295
333
    return _DeprecatedList(initial_value)
296
 
 
297
 
 
298
 
def _check_for_filter(error_only):
299
 
    """Check if there is already a filter for deprecation warnings.
300
 
 
301
 
    :param error_only: Only match an 'error' filter
302
 
    :return: True if a filter is found, False otherwise
303
 
    """
304
 
    for filter in warnings.filters:
305
 
        if issubclass(DeprecationWarning, filter[2]):
306
 
            # This filter will effect DeprecationWarning
307
 
            if not error_only or filter[0] == 'error':
308
 
                return True
309
 
    return False
310
 
 
311
 
 
312
 
def _remove_filter_callable(filter):
313
 
    """Build and returns a callable removing filter from the warnings.
314
 
 
315
 
    :param filter: The filter to remove (can be None).
316
 
 
317
 
    :return: A callable that will remove filter from warnings.filters.
318
 
    """
319
 
    def cleanup():
320
 
        if filter:
321
 
            warnings.filters.remove(filter)
322
 
    return cleanup
323
 
 
324
 
 
325
 
def suppress_deprecation_warnings(override=True):
326
 
    """Call this function to suppress all deprecation warnings.
327
 
 
328
 
    When this is a final release version, we don't want to annoy users with
329
 
    lots of deprecation warnings. We only want the deprecation warnings when
330
 
    running a dev or release candidate.
331
 
 
332
 
    :param override: If True, always set the ignore, if False, only set the
333
 
        ignore if there isn't already a filter.
334
 
 
335
 
    :return: A callable to remove the new warnings this added.
336
 
    """
337
 
    if not override and _check_for_filter(error_only=False):
338
 
        # If there is already a filter effecting suppress_deprecation_warnings,
339
 
        # then skip it.
340
 
        filter = None
341
 
    else:
342
 
        warnings.filterwarnings('ignore', category=DeprecationWarning)
343
 
        filter = warnings.filters[0]
344
 
    return _remove_filter_callable(filter)
345
 
 
346
 
 
347
 
def activate_deprecation_warnings(override=True):
348
 
    """Call this function to activate deprecation warnings.
349
 
 
350
 
    When running in a 'final' release we suppress deprecation warnings.
351
 
    However, the test suite wants to see them. So when running selftest, we
352
 
    re-enable the deprecation warnings.
353
 
 
354
 
    Note: warnings that have already been issued under 'ignore' will not be
355
 
    reported after this point. The 'warnings' module has already marked them as
356
 
    handled, so they don't get issued again.
357
 
 
358
 
    :param override: If False, only add a filter if there isn't an error filter
359
 
        already. (This slightly differs from suppress_deprecation_warnings, in
360
 
        because it always overrides everything but -Werror).
361
 
 
362
 
    :return: A callable to remove the new warnings this added.
363
 
    """
364
 
    if not override and _check_for_filter(error_only=True):
365
 
        # DeprecationWarnings are already turned into errors, don't downgrade
366
 
        # them to 'default'.
367
 
        filter = None
368
 
    else:
369
 
        warnings.filterwarnings('default', category=DeprecationWarning)
370
 
        filter = warnings.filters[0]
371
 
    return _remove_filter_callable(filter)