← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/symbol_versioning.py

  • Committer: Jelmer Vernooij
  • Date: 2012-01-28 02:10:19 UTC
  • mto: This revision was merged to the branch mainline in revision 6450.
  • Revision ID: jelmer@samba.org-20120128021019-047mhvjsr9t72xfi
Fix reading weave files.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/symbol_versioning.py
1
 
# Copyright (C) 2006 by Canonical Ltd
2
 
#   Authors: Robert Collins <robert.collins@canonical.com>
 
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
 
20
19
The methods here allow for api symbol versioning.
21
20
"""
22
21
 
 
22
from __future__ import absolute_import
 
23
 
23
24
__all__ = ['deprecated_function',
 
25
           'deprecated_in',
24
26
           'deprecated_list',
25
27
           'deprecated_method',
26
28
           'DEPRECATED_PARAMETER',
27
29
           'deprecated_passed',
28
 
           'warn', 'set_warning_method', 'zero_seven',
29
 
           'zero_eight',
30
 
           'zero_nine',
31
 
           'zero_ten',
32
 
           'zero_eleven',
 
30
           'set_warning_method',
 
31
           'warn',
33
32
           ]
34
33
 
 
34
 
 
35
import warnings
 
36
# Import the 'warn' symbol so bzrlib can call it even if we redefine it
35
37
from warnings import warn
36
38
 
 
39
import bzrlib
 
40
 
37
41
 
38
42
DEPRECATED_PARAMETER = "A deprecated parameter marker."
39
 
zero_seven = "%s was deprecated in version 0.7."
40
 
zero_eight = "%s was deprecated in version 0.8."
41
 
zero_nine = "%s was deprecated in version 0.9."
42
 
zero_ten = "%s was deprecated in version 0.10."
43
 
zero_eleven = "%s was deprecated in version 0.11."
 
43
 
 
44
 
 
45
def deprecated_in(version_tuple):
 
46
    """Generate a message that something was deprecated in a release.
 
47
 
 
48
    >>> deprecated_in((1, 4, 0))
 
49
    '%s was deprecated in version 1.4.0.'
 
50
    """
 
51
    return ("%%s was deprecated in version %s."
 
52
            % bzrlib._format_version_tuple(version_tuple))
44
53
 
45
54
 
46
55
def set_warning_method(method):
66
75
        have a single %s operator in it. a_callable will be turned into a nice
67
76
        python symbol and then substituted into deprecation_version.
68
77
    """
 
78
    # We also want to handle old-style classes, in particular exception, and
 
79
    # they don't have an im_class attribute.
69
80
    if getattr(a_callable, 'im_class', None) is None:
70
81
        symbol = "%s.%s" % (a_callable.__module__,
71
82
                            a_callable.__name__)
82
93
 
83
94
    def function_decorator(callable):
84
95
        """This is the function python calls to perform the decoration."""
85
 
        
 
96
 
86
97
        def decorated_function(*args, **kwargs):
87
98
            """This is the decorated function."""
 
99
            from bzrlib import trace
 
100
            trace.mutter_callsite(4, "Deprecated function called")
88
101
            warn(deprecation_string(callable, deprecation_version),
89
102
                DeprecationWarning, stacklevel=2)
90
103
            return callable(*args, **kwargs)
96
109
 
97
110
def deprecated_method(deprecation_version):
98
111
    """Decorate a method so that use of it will trigger a warning.
99
 
    
 
112
 
 
113
    To deprecate a static or class method, use
 
114
 
 
115
        @staticmethod
 
116
        @deprecated_function
 
117
        def ...
 
118
 
100
119
    To deprecate an entire class, decorate __init__.
101
120
    """
102
121
 
103
122
    def method_decorator(callable):
104
123
        """This is the function python calls to perform the decoration."""
105
 
        
 
124
 
106
125
        def decorated_method(self, *args, **kwargs):
107
126
            """This is the decorated method."""
108
 
            symbol = "%s.%s.%s" % (self.__class__.__module__,
109
 
                                   self.__class__.__name__,
110
 
                                   callable.__name__
111
 
                                   )
 
127
            from bzrlib import trace
 
128
            if callable.__name__ == '__init__':
 
129
                symbol = "%s.%s" % (self.__class__.__module__,
 
130
                                    self.__class__.__name__,
 
131
                                    )
 
132
            else:
 
133
                symbol = "%s.%s.%s" % (self.__class__.__module__,
 
134
                                       self.__class__.__name__,
 
135
                                       callable.__name__
 
136
                                       )
 
137
            trace.mutter_callsite(4, "Deprecated method called")
112
138
            warn(deprecation_version % symbol, DeprecationWarning, stacklevel=2)
113
139
            return callable(self, *args, **kwargs)
114
140
        _populate_decorated(callable, deprecation_version, "method",
119
145
 
120
146
def deprecated_passed(parameter_value):
121
147
    """Return True if parameter_value was used."""
122
 
    # FIXME: it might be nice to have a parameter deprecation decorator. 
 
148
    # FIXME: it might be nice to have a parameter deprecation decorator.
123
149
    # it would need to handle positional and *args and **kwargs parameters,
124
150
    # which means some mechanism to describe how the parameter was being
125
151
    # passed before deprecation, and some way to deprecate parameters that
127
153
    # we cannot just forward to a new method name.I.e. in the following
128
154
    # examples we would want to have callers that pass any value to 'bad' be
129
155
    # given a warning - because we have applied:
130
 
    # @deprecated_parameter('bad', zero_seven)
 
156
    # @deprecated_parameter('bad', deprecated_in((1, 5, 0))
131
157
    #
132
158
    # def __init__(self, bad=None)
133
159
    # def __init__(self, bad, other)
145
171
    if len(docstring_lines) == 0:
146
172
        decorated_callable.__doc__ = deprecation_version % ("This " + label)
147
173
    elif len(docstring_lines) == 1:
148
 
        decorated_callable.__doc__ = (callable.__doc__ 
 
174
        decorated_callable.__doc__ = (callable.__doc__
149
175
                                    + "\n"
150
176
                                    + "\n"
151
177
                                    + deprecation_version % ("This " + label)
170
196
    decorated_callable.is_deprecated = True
171
197
 
172
198
 
 
199
def _dict_deprecation_wrapper(wrapped_method):
 
200
    """Returns a closure that emits a warning and calls the superclass"""
 
201
    def cb(dep_dict, *args, **kwargs):
 
202
        msg = 'access to %s' % (dep_dict._variable_name, )
 
203
        msg = dep_dict._deprecation_version % (msg,)
 
204
        if dep_dict._advice:
 
205
            msg += ' ' + dep_dict._advice
 
206
        warn(msg, DeprecationWarning, stacklevel=2)
 
207
        return wrapped_method(dep_dict, *args, **kwargs)
 
208
    return cb
 
209
 
 
210
 
 
211
class DeprecatedDict(dict):
 
212
    """A dictionary that complains when read or written."""
 
213
 
 
214
    is_deprecated = True
 
215
 
 
216
    def __init__(self,
 
217
        deprecation_version,
 
218
        variable_name,
 
219
        initial_value,
 
220
        advice,
 
221
        ):
 
222
        """Create a dict that warns when read or modified.
 
223
 
 
224
        :param deprecation_version: string for the warning format to raise,
 
225
            typically from deprecated_in()
 
226
        :param initial_value: The contents of the dict
 
227
        :param variable_name: This allows better warnings to be printed
 
228
        :param advice: String of advice on what callers should do instead
 
229
            of using this variable.
 
230
        """
 
231
        self._deprecation_version = deprecation_version
 
232
        self._variable_name = variable_name
 
233
        self._advice = advice
 
234
        dict.__init__(self, initial_value)
 
235
 
 
236
    # This isn't every possible method but it should trap anyone using the
 
237
    # dict -- add more if desired
 
238
    __len__ = _dict_deprecation_wrapper(dict.__len__)
 
239
    __getitem__ = _dict_deprecation_wrapper(dict.__getitem__)
 
240
    __setitem__ = _dict_deprecation_wrapper(dict.__setitem__)
 
241
    __delitem__ = _dict_deprecation_wrapper(dict.__delitem__)
 
242
    keys = _dict_deprecation_wrapper(dict.keys)
 
243
    __contains__ = _dict_deprecation_wrapper(dict.__contains__)
 
244
 
 
245
 
173
246
def deprecated_list(deprecation_version, variable_name,
174
247
                    initial_value, extra=None):
175
248
    """Create a list that warns when modified
176
249
 
177
 
    :param deprecation_version: something like zero_nine
 
250
    :param deprecation_version: string for the warning format to raise,
 
251
        typically from deprecated_in()
178
252
    :param initial_value: The contents of the list
179
253
    :param variable_name: This allows better warnings to be printed
180
254
    :param extra: Extra info to print when printing a warning
193
267
        def _warn_deprecated(self, func, *args, **kwargs):
194
268
            warn(msg, DeprecationWarning, stacklevel=3)
195
269
            return func(self, *args, **kwargs)
196
 
            
 
270
 
197
271
        def append(self, obj):
198
272
            """appending to %s is deprecated""" % (variable_name,)
199
273
            return self._warn_deprecated(list.append, obj)
211
285
            return self._warn_deprecated(list.remove, value)
212
286
 
213
287
        def pop(self, index=None):
214
 
            """pop'ing from from %s is deprecated""" % (variable_name,)
 
288
            """pop'ing from %s is deprecated""" % (variable_name,)
215
289
            if index:
216
290
                return self._warn_deprecated(list.pop, index)
217
291
            else:
219
293
                return self._warn_deprecated(list.pop)
220
294
 
221
295
    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)