← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/symbol_versioning.py

  • Committer: Robert Collins
  • Date: 2010-05-06 23:54:05 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506235405-wii4elupfhzl3jvy
Add __str__ to the new helper classes.

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, 2007, 2008, 2009 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',
42
 
           'zero_ninetytwo',
 
28
           'set_warning_method',
 
29
           'warn',
43
30
           ]
44
31
 
45
32
from warnings import warn
46
33
 
 
34
import bzrlib
 
35
 
47
36
 
48
37
DEPRECATED_PARAMETER = "A deprecated parameter marker."
49
 
zero_seven = "%s was deprecated in version 0.7."
50
 
zero_eight = "%s was deprecated in version 0.8."
51
 
zero_nine = "%s was deprecated in version 0.9."
52
 
zero_ten = "%s was deprecated in version 0.10."
53
 
zero_eleven = "%s was deprecated in version 0.11."
54
 
zero_twelve = "%s was deprecated in version 0.12."
55
 
zero_thirteen = "%s was deprecated in version 0.13."
56
 
zero_fourteen = "%s was deprecated in version 0.14."
57
 
zero_fifteen = "%s was deprecated in version 0.15."
58
 
zero_sixteen = "%s was deprecated in version 0.16."
59
 
zero_seventeen = "%s was deprecated in version 0.17."
60
 
zero_eighteen = "%s was deprecated in version 0.18."
61
 
zero_ninety = "%s was deprecated in version 0.90."
62
 
zero_ninetyone = "%s was deprecated in version 0.91."
63
 
zero_ninetytwo = "%s was deprecated in version 0.92."
 
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))
64
48
 
65
49
 
66
50
def set_warning_method(method):
104
88
 
105
89
    def function_decorator(callable):
106
90
        """This is the function python calls to perform the decoration."""
107
 
        
 
91
 
108
92
        def decorated_function(*args, **kwargs):
109
93
            """This is the decorated function."""
 
94
            from bzrlib import trace
 
95
            trace.mutter_callsite(4, "Deprecated function called")
110
96
            warn(deprecation_string(callable, deprecation_version),
111
97
                DeprecationWarning, stacklevel=2)
112
98
            return callable(*args, **kwargs)
119
105
def deprecated_method(deprecation_version):
120
106
    """Decorate a method so that use of it will trigger a warning.
121
107
 
122
 
    To deprecate a static or class method, use 
 
108
    To deprecate a static or class method, use
123
109
 
124
110
        @staticmethod
125
111
        @deprecated_function
126
112
        def ...
127
 
    
 
113
 
128
114
    To deprecate an entire class, decorate __init__.
129
115
    """
130
116
 
131
117
    def method_decorator(callable):
132
118
        """This is the function python calls to perform the decoration."""
133
 
        
 
119
 
134
120
        def decorated_method(self, *args, **kwargs):
135
121
            """This is the decorated method."""
 
122
            from bzrlib import trace
136
123
            if callable.__name__ == '__init__':
137
124
                symbol = "%s.%s" % (self.__class__.__module__,
138
125
                                    self.__class__.__name__,
142
129
                                       self.__class__.__name__,
143
130
                                       callable.__name__
144
131
                                       )
 
132
            trace.mutter_callsite(4, "Deprecated method called")
145
133
            warn(deprecation_version % symbol, DeprecationWarning, stacklevel=2)
146
134
            return callable(self, *args, **kwargs)
147
135
        _populate_decorated(callable, deprecation_version, "method",
152
140
 
153
141
def deprecated_passed(parameter_value):
154
142
    """Return True if parameter_value was used."""
155
 
    # FIXME: it might be nice to have a parameter deprecation decorator. 
 
143
    # FIXME: it might be nice to have a parameter deprecation decorator.
156
144
    # it would need to handle positional and *args and **kwargs parameters,
157
145
    # which means some mechanism to describe how the parameter was being
158
146
    # passed before deprecation, and some way to deprecate parameters that
160
148
    # we cannot just forward to a new method name.I.e. in the following
161
149
    # examples we would want to have callers that pass any value to 'bad' be
162
150
    # given a warning - because we have applied:
163
 
    # @deprecated_parameter('bad', zero_seven)
 
151
    # @deprecated_parameter('bad', deprecated_in((1, 5, 0))
164
152
    #
165
153
    # def __init__(self, bad=None)
166
154
    # def __init__(self, bad, other)
178
166
    if len(docstring_lines) == 0:
179
167
        decorated_callable.__doc__ = deprecation_version % ("This " + label)
180
168
    elif len(docstring_lines) == 1:
181
 
        decorated_callable.__doc__ = (callable.__doc__ 
 
169
        decorated_callable.__doc__ = (callable.__doc__
182
170
                                    + "\n"
183
171
                                    + "\n"
184
172
                                    + deprecation_version % ("This " + label)
228
216
        ):
229
217
        """Create a dict that warns when read or modified.
230
218
 
231
 
        :param deprecation_version: something like zero_nine
 
219
        :param deprecation_version: string for the warning format to raise,
 
220
            typically from deprecated_in()
232
221
        :param initial_value: The contents of the dict
233
222
        :param variable_name: This allows better warnings to be printed
234
 
        :param advice: String of advice on what callers should do instead 
 
223
        :param advice: String of advice on what callers should do instead
235
224
            of using this variable.
236
225
        """
237
226
        self._deprecation_version = deprecation_version
253
242
                    initial_value, extra=None):
254
243
    """Create a list that warns when modified
255
244
 
256
 
    :param deprecation_version: something like zero_nine
 
245
    :param deprecation_version: string for the warning format to raise,
 
246
        typically from deprecated_in()
257
247
    :param initial_value: The contents of the list
258
248
    :param variable_name: This allows better warnings to be printed
259
249
    :param extra: Extra info to print when printing a warning
272
262
        def _warn_deprecated(self, func, *args, **kwargs):
273
263
            warn(msg, DeprecationWarning, stacklevel=3)
274
264
            return func(self, *args, **kwargs)
275
 
            
 
265
 
276
266
        def append(self, obj):
277
267
            """appending to %s is deprecated""" % (variable_name,)
278
268
            return self._warn_deprecated(list.append, obj)
290
280
            return self._warn_deprecated(list.remove, value)
291
281
 
292
282
        def pop(self, index=None):
293
 
            """pop'ing from from %s is deprecated""" % (variable_name,)
 
283
            """pop'ing from %s is deprecated""" % (variable_name,)
294
284
            if index:
295
285
                return self._warn_deprecated(list.pop, index)
296
286
            else:
298
288
                return self._warn_deprecated(list.pop)
299
289
 
300
290
    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)