← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/symbol_versioning.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2006-06-16 14:33:42 UTC
  • mfrom: (1770.2.1 config)
  • Revision ID: pqm@pqm.ubuntu.com-20060616143342-8f7f4a4f77c1e4c8
Use create_signature for signing policy, deprecate check_signatures for this

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/symbol_versioning.py
1
 
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
2
 
#   Authors: Robert Collins <robert.collins@canonical.com> and others
 
1
# Copyright (C) 2006 by Canonical Ltd
 
2
#   Authors: Robert Collins <robert.collins@canonical.com>
3
3
#
4
4
# This program is free software; you can redistribute it and/or modify
5
5
# it under the terms of the GNU General Public License as published by
21
21
"""
22
22
 
23
23
__all__ = ['deprecated_function',
24
 
           'deprecated_in',
25
 
           'deprecated_list',
26
24
           'deprecated_method',
27
25
           'DEPRECATED_PARAMETER',
28
26
           'deprecated_passed',
29
 
           'set_warning_method',
30
 
           'warn',
31
 
           'zero_seven',
 
27
           'warn', 'set_warning_method', 'zero_seven',
32
28
           'zero_eight',
33
29
           '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',
54
30
           ]
55
31
 
56
32
from warnings import warn
57
33
 
58
 
import bzrlib
59
 
 
60
34
 
61
35
DEPRECATED_PARAMETER = "A deprecated parameter marker."
62
36
zero_seven = "%s was deprecated in version 0.7."
63
37
zero_eight = "%s was deprecated in version 0.8."
64
38
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."
85
 
 
86
 
 
87
 
def deprecated_in(version_tuple):
88
 
    """Generate a message that something was deprecated in a release.
89
 
 
90
 
    >>> deprecated_in((1, 4, 0))
91
 
    '%s was deprecated in version 1.4.'
92
 
    """
93
 
    return ("%%s was deprecated in version %s."
94
 
            % bzrlib._format_version_tuple(version_tuple))
95
39
 
96
40
 
97
41
def set_warning_method(method):
108
52
# add that on top of the primitives, once we have all three written
109
53
# - RBC 20050105
110
54
 
111
 
 
112
 
def deprecation_string(a_callable, deprecation_version):
113
 
    """Generate an automatic deprecation string for a_callable.
114
 
 
115
 
    :param a_callable: The callable to substitute into deprecation_version.
116
 
    :param deprecation_version: A deprecation format warning string. This should
117
 
        have a single %s operator in it. a_callable will be turned into a nice
118
 
        python symbol and then substituted into deprecation_version.
119
 
    """
120
 
    # We also want to handle old-style classes, in particular exception, and
121
 
    # they don't have an im_class attribute.
122
 
    if getattr(a_callable, 'im_class', None) is None:
123
 
        symbol = "%s.%s" % (a_callable.__module__,
124
 
                            a_callable.__name__)
125
 
    else:
126
 
        symbol = "%s.%s.%s" % (a_callable.im_class.__module__,
127
 
                               a_callable.im_class.__name__,
128
 
                               a_callable.__name__
129
 
                               )
130
 
    return deprecation_version % symbol
131
 
 
132
 
 
133
55
def deprecated_function(deprecation_version):
134
56
    """Decorate a function so that use of it will trigger a warning."""
135
57
 
138
60
        
139
61
        def decorated_function(*args, **kwargs):
140
62
            """This is the decorated function."""
141
 
            from bzrlib import trace
142
 
            trace.mutter_callsite(4, "Deprecated function called")
143
 
            warn(deprecation_string(callable, deprecation_version),
144
 
                DeprecationWarning, stacklevel=2)
 
63
            symbol = "%s.%s" % (callable.__module__, 
 
64
                                callable.__name__
 
65
                                )
 
66
            warn(deprecation_version % symbol, DeprecationWarning, stacklevel=2)
145
67
            return callable(*args, **kwargs)
146
68
        _populate_decorated(callable, deprecation_version, "function",
147
69
                            decorated_function)
151
73
 
152
74
def deprecated_method(deprecation_version):
153
75
    """Decorate a method so that use of it will trigger a warning.
154
 
 
155
 
    To deprecate a static or class method, use 
156
 
 
157
 
        @staticmethod
158
 
        @deprecated_function
159
 
        def ...
160
76
    
161
77
    To deprecate an entire class, decorate __init__.
162
78
    """
166
82
        
167
83
        def decorated_method(self, *args, **kwargs):
168
84
            """This is the decorated method."""
169
 
            from bzrlib import trace
170
 
            if callable.__name__ == '__init__':
171
 
                symbol = "%s.%s" % (self.__class__.__module__,
172
 
                                    self.__class__.__name__,
173
 
                                    )
174
 
            else:
175
 
                symbol = "%s.%s.%s" % (self.__class__.__module__,
176
 
                                       self.__class__.__name__,
177
 
                                       callable.__name__
178
 
                                       )
179
 
            trace.mutter_callsite(4, "Deprecated method called")
 
85
            symbol = "%s.%s.%s" % (self.__class__.__module__, 
 
86
                                   self.__class__.__name__,
 
87
                                   callable.__name__
 
88
                                   )
180
89
            warn(deprecation_version % symbol, DeprecationWarning, stacklevel=2)
181
90
            return callable(self, *args, **kwargs)
182
91
        _populate_decorated(callable, deprecation_version, "method",
195
104
    # we cannot just forward to a new method name.I.e. in the following
196
105
    # examples we would want to have callers that pass any value to 'bad' be
197
106
    # given a warning - because we have applied:
198
 
    # @deprecated_parameter('bad', deprecated_in((1, 5, 0))
 
107
    # @deprecated_parameter('bad', zero_seven)
199
108
    #
200
109
    # def __init__(self, bad=None)
201
110
    # def __init__(self, bad, other)
236
145
    decorated_callable.__module__ = callable.__module__
237
146
    decorated_callable.__name__ = callable.__name__
238
147
    decorated_callable.is_deprecated = True
239
 
 
240
 
 
241
 
def _dict_deprecation_wrapper(wrapped_method):
242
 
    """Returns a closure that emits a warning and calls the superclass"""
243
 
    def cb(dep_dict, *args, **kwargs):
244
 
        msg = 'access to %s' % (dep_dict._variable_name, )
245
 
        msg = dep_dict._deprecation_version % (msg,)
246
 
        if dep_dict._advice:
247
 
            msg += ' ' + dep_dict._advice
248
 
        warn(msg, DeprecationWarning, stacklevel=2)
249
 
        return wrapped_method(dep_dict, *args, **kwargs)
250
 
    return cb
251
 
 
252
 
 
253
 
class DeprecatedDict(dict):
254
 
    """A dictionary that complains when read or written."""
255
 
 
256
 
    is_deprecated = True
257
 
 
258
 
    def __init__(self,
259
 
        deprecation_version,
260
 
        variable_name,
261
 
        initial_value,
262
 
        advice,
263
 
        ):
264
 
        """Create a dict that warns when read or modified.
265
 
 
266
 
        :param deprecation_version: string for the warning format to raise,
267
 
            typically from deprecated_in()
268
 
        :param initial_value: The contents of the dict
269
 
        :param variable_name: This allows better warnings to be printed
270
 
        :param advice: String of advice on what callers should do instead 
271
 
            of using this variable.
272
 
        """
273
 
        self._deprecation_version = deprecation_version
274
 
        self._variable_name = variable_name
275
 
        self._advice = advice
276
 
        dict.__init__(self, initial_value)
277
 
 
278
 
    # This isn't every possible method but it should trap anyone using the
279
 
    # dict -- add more if desired
280
 
    __len__ = _dict_deprecation_wrapper(dict.__len__)
281
 
    __getitem__ = _dict_deprecation_wrapper(dict.__getitem__)
282
 
    __setitem__ = _dict_deprecation_wrapper(dict.__setitem__)
283
 
    __delitem__ = _dict_deprecation_wrapper(dict.__delitem__)
284
 
    keys = _dict_deprecation_wrapper(dict.keys)
285
 
    __contains__ = _dict_deprecation_wrapper(dict.__contains__)
286
 
 
287
 
 
288
 
def deprecated_list(deprecation_version, variable_name,
289
 
                    initial_value, extra=None):
290
 
    """Create a list that warns when modified
291
 
 
292
 
    :param deprecation_version: string for the warning format to raise,
293
 
        typically from deprecated_in()
294
 
    :param initial_value: The contents of the list
295
 
    :param variable_name: This allows better warnings to be printed
296
 
    :param extra: Extra info to print when printing a warning
297
 
    """
298
 
 
299
 
    subst_text = 'Modifying %s' % (variable_name,)
300
 
    msg = deprecation_version % (subst_text,)
301
 
    if extra:
302
 
        msg += ' ' + extra
303
 
 
304
 
    class _DeprecatedList(list):
305
 
        __doc__ = list.__doc__ + msg
306
 
 
307
 
        is_deprecated = True
308
 
 
309
 
        def _warn_deprecated(self, func, *args, **kwargs):
310
 
            warn(msg, DeprecationWarning, stacklevel=3)
311
 
            return func(self, *args, **kwargs)
312
 
            
313
 
        def append(self, obj):
314
 
            """appending to %s is deprecated""" % (variable_name,)
315
 
            return self._warn_deprecated(list.append, obj)
316
 
 
317
 
        def insert(self, index, obj):
318
 
            """inserting to %s is deprecated""" % (variable_name,)
319
 
            return self._warn_deprecated(list.insert, index, obj)
320
 
 
321
 
        def extend(self, iterable):
322
 
            """extending %s is deprecated""" % (variable_name,)
323
 
            return self._warn_deprecated(list.extend, iterable)
324
 
 
325
 
        def remove(self, value):
326
 
            """removing from %s is deprecated""" % (variable_name,)
327
 
            return self._warn_deprecated(list.remove, value)
328
 
 
329
 
        def pop(self, index=None):
330
 
            """pop'ing from from %s is deprecated""" % (variable_name,)
331
 
            if index:
332
 
                return self._warn_deprecated(list.pop, index)
333
 
            else:
334
 
                # Can't pass None
335
 
                return self._warn_deprecated(list.pop)
336
 
 
337
 
    return _DeprecatedList(initial_value)
338
 
 
339
 
 
340
 
def _check_for_filter(error_only):
341
 
    """Check if there is already a filter for deprecation warnings.
342
 
    
343
 
    :param error_only: Only match an 'error' filter
344
 
    :return: True if a filter is found, False otherwise
345
 
    """
346
 
    import warnings
347
 
    for filter in warnings.filters:
348
 
        if issubclass(DeprecationWarning, filter[2]):
349
 
            # This filter will effect DeprecationWarning
350
 
            if not error_only or filter[0] == 'error':
351
 
                return True
352
 
    return False
353
 
 
354
 
 
355
 
def suppress_deprecation_warnings(override=True):
356
 
    """Call this function to suppress all deprecation warnings.
357
 
 
358
 
    When this is a final release version, we don't want to annoy users with
359
 
    lots of deprecation warnings. We only want the deprecation warnings when
360
 
    running a dev or release candidate.
361
 
 
362
 
    :param override: If True, always set the ignore, if False, only set the
363
 
        ignore if there isn't already a filter.
364
 
    """
365
 
    import warnings
366
 
    if not override and _check_for_filter(error_only=False):
367
 
        # If there is already a filter effecting suppress_deprecation_warnings,
368
 
        # then skip it.
369
 
        return
370
 
    warnings.filterwarnings('ignore', category=DeprecationWarning)
371
 
 
372
 
 
373
 
def activate_deprecation_warnings(override=True):
374
 
    """Call this function to activate deprecation warnings.
375
 
 
376
 
    When running in a 'final' release we suppress deprecation warnings.
377
 
    However, the test suite wants to see them. So when running selftest, we
378
 
    re-enable the deprecation warnings.
379
 
 
380
 
    Note: warnings that have already been issued under 'ignore' will not be
381
 
    reported after this point. The 'warnings' module has already marked them as
382
 
    handled, so they don't get issued again.
383
 
 
384
 
    :param override: If False, only add a filter if there isn't an error filter
385
 
        already. (This slightly differs from suppress_deprecation_warnings, in
386
 
        because it always overrides everything but -Werror).
387
 
    """
388
 
    import warnings
389
 
    if not override and _check_for_filter(error_only=True):
390
 
        # DeprecationWarnings are already turned into errors, don't downgrade
391
 
        # them to 'default'.
392
 
        return
393
 
    warnings.filterwarnings('default', category=DeprecationWarning)