← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/symbol_versioning.py

Fix typos

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
 
           'deprecated_in',
26
24
           'deprecated_list',
27
25
           'deprecated_method',
28
26
           'DEPRECATED_PARAMETER',
29
27
           'deprecated_passed',
30
 
           'set_warning_method',
31
 
           'warn',
 
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',
 
43
           'zero_ninetythree',
 
44
           'one_zero',
 
45
           'one_one',
 
46
           'one_two',
 
47
           'one_three',
32
48
           ]
33
49
 
34
 
 
35
 
import warnings
36
 
# Import the 'warn' symbol so bzrlib can call it even if we redefine it
37
50
from warnings import warn
38
51
 
39
 
import bzrlib
40
 
 
41
52
 
42
53
DEPRECATED_PARAMETER = "A deprecated parameter marker."
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))
53
 
 
 
54
zero_seven = "%s was deprecated in version 0.7."
 
55
zero_eight = "%s was deprecated in version 0.8."
 
56
zero_nine = "%s was deprecated in version 0.9."
 
57
zero_ten = "%s was deprecated in version 0.10."
 
58
zero_eleven = "%s was deprecated in version 0.11."
 
59
zero_twelve = "%s was deprecated in version 0.12."
 
60
zero_thirteen = "%s was deprecated in version 0.13."
 
61
zero_fourteen = "%s was deprecated in version 0.14."
 
62
zero_fifteen = "%s was deprecated in version 0.15."
 
63
zero_sixteen = "%s was deprecated in version 0.16."
 
64
zero_seventeen = "%s was deprecated in version 0.17."
 
65
zero_eighteen = "%s was deprecated in version 0.18."
 
66
zero_ninety = "%s was deprecated in version 0.90."
 
67
zero_ninetyone = "%s was deprecated in version 0.91."
 
68
zero_ninetytwo = "%s was deprecated in version 0.92."
 
69
one_zero = "%s was deprecated in version 1.0."
 
70
zero_ninetythree = one_zero # Maintained for backwards compatibility
 
71
one_one = "%s was deprecated in version 1.1."
 
72
one_two = "%s was deprecated in version 1.2."
 
73
one_three = "%s was deprecated in version 1.3."
 
74
one_four = "%s was deprecated in version 1.4."
54
75
 
55
76
def set_warning_method(method):
56
77
    """Set the warning method to be used by this module.
93
114
 
94
115
    def function_decorator(callable):
95
116
        """This is the function python calls to perform the decoration."""
96
 
 
 
117
        
97
118
        def decorated_function(*args, **kwargs):
98
119
            """This is the decorated function."""
99
 
            from bzrlib import trace
100
 
            trace.mutter_callsite(4, "Deprecated function called")
101
120
            warn(deprecation_string(callable, deprecation_version),
102
121
                DeprecationWarning, stacklevel=2)
103
122
            return callable(*args, **kwargs)
110
129
def deprecated_method(deprecation_version):
111
130
    """Decorate a method so that use of it will trigger a warning.
112
131
 
113
 
    To deprecate a static or class method, use
 
132
    To deprecate a static or class method, use 
114
133
 
115
134
        @staticmethod
116
135
        @deprecated_function
117
136
        def ...
118
 
 
 
137
    
119
138
    To deprecate an entire class, decorate __init__.
120
139
    """
121
140
 
122
141
    def method_decorator(callable):
123
142
        """This is the function python calls to perform the decoration."""
124
 
 
 
143
        
125
144
        def decorated_method(self, *args, **kwargs):
126
145
            """This is the decorated method."""
127
 
            from bzrlib import trace
128
146
            if callable.__name__ == '__init__':
129
147
                symbol = "%s.%s" % (self.__class__.__module__,
130
148
                                    self.__class__.__name__,
134
152
                                       self.__class__.__name__,
135
153
                                       callable.__name__
136
154
                                       )
137
 
            trace.mutter_callsite(4, "Deprecated method called")
138
155
            warn(deprecation_version % symbol, DeprecationWarning, stacklevel=2)
139
156
            return callable(self, *args, **kwargs)
140
157
        _populate_decorated(callable, deprecation_version, "method",
145
162
 
146
163
def deprecated_passed(parameter_value):
147
164
    """Return True if parameter_value was used."""
148
 
    # FIXME: it might be nice to have a parameter deprecation decorator.
 
165
    # FIXME: it might be nice to have a parameter deprecation decorator. 
149
166
    # it would need to handle positional and *args and **kwargs parameters,
150
167
    # which means some mechanism to describe how the parameter was being
151
168
    # passed before deprecation, and some way to deprecate parameters that
153
170
    # we cannot just forward to a new method name.I.e. in the following
154
171
    # examples we would want to have callers that pass any value to 'bad' be
155
172
    # given a warning - because we have applied:
156
 
    # @deprecated_parameter('bad', deprecated_in((1, 5, 0))
 
173
    # @deprecated_parameter('bad', zero_seven)
157
174
    #
158
175
    # def __init__(self, bad=None)
159
176
    # def __init__(self, bad, other)
171
188
    if len(docstring_lines) == 0:
172
189
        decorated_callable.__doc__ = deprecation_version % ("This " + label)
173
190
    elif len(docstring_lines) == 1:
174
 
        decorated_callable.__doc__ = (callable.__doc__
 
191
        decorated_callable.__doc__ = (callable.__doc__ 
175
192
                                    + "\n"
176
193
                                    + "\n"
177
194
                                    + deprecation_version % ("This " + label)
221
238
        ):
222
239
        """Create a dict that warns when read or modified.
223
240
 
224
 
        :param deprecation_version: string for the warning format to raise,
225
 
            typically from deprecated_in()
 
241
        :param deprecation_version: something like zero_nine
226
242
        :param initial_value: The contents of the dict
227
243
        :param variable_name: This allows better warnings to be printed
228
 
        :param advice: String of advice on what callers should do instead
 
244
        :param advice: String of advice on what callers should do instead 
229
245
            of using this variable.
230
246
        """
231
247
        self._deprecation_version = deprecation_version
247
263
                    initial_value, extra=None):
248
264
    """Create a list that warns when modified
249
265
 
250
 
    :param deprecation_version: string for the warning format to raise,
251
 
        typically from deprecated_in()
 
266
    :param deprecation_version: something like zero_nine
252
267
    :param initial_value: The contents of the list
253
268
    :param variable_name: This allows better warnings to be printed
254
269
    :param extra: Extra info to print when printing a warning
267
282
        def _warn_deprecated(self, func, *args, **kwargs):
268
283
            warn(msg, DeprecationWarning, stacklevel=3)
269
284
            return func(self, *args, **kwargs)
270
 
 
 
285
            
271
286
        def append(self, obj):
272
287
            """appending to %s is deprecated""" % (variable_name,)
273
288
            return self._warn_deprecated(list.append, obj)
285
300
            return self._warn_deprecated(list.remove, value)
286
301
 
287
302
        def pop(self, index=None):
288
 
            """pop'ing from %s is deprecated""" % (variable_name,)
 
303
            """pop'ing from from %s is deprecated""" % (variable_name,)
289
304
            if index:
290
305
                return self._warn_deprecated(list.pop, index)
291
306
            else:
293
308
                return self._warn_deprecated(list.pop)
294
309
 
295
310
    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)