← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/symbol_versioning.py

  • Committer: Andrew Bennetts
  • Date: 2010-10-08 08:15:14 UTC
  • mto: This revision was merged to the branch mainline in revision 5498.
  • Revision ID: andrew.bennetts@canonical.com-20101008081514-dviqzrdfwyzsqbz2
Split NEWS into per-release doc/en/release-notes/bzr-*.txt

Show diffs side-by-side

added added

removed removed

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