← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/symbol_versioning.py

  • Committer: Martin Pool
  • Date: 2009-01-13 03:06:36 UTC
  • mfrom: (3932.2.3 1.11)
  • mto: This revision was merged to the branch mainline in revision 3937.
  • Revision ID: mbp@sourcefrog.net-20090113030636-dqx4t8yaaqgdvam5
Merge 1.11rc1

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
24
           'deprecated_in',
26
25
           'deprecated_list',
29
28
           'deprecated_passed',
30
29
           'set_warning_method',
31
30
           'warn',
 
31
           'zero_seven',
 
32
           'zero_eight',
 
33
           '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',
32
54
           ]
33
55
 
34
 
 
35
 
import warnings
36
 
# Import the 'warn' symbol so bzrlib can call it even if we redefine it
37
56
from warnings import warn
38
57
 
39
58
import bzrlib
40
59
 
41
60
 
42
61
DEPRECATED_PARAMETER = "A deprecated parameter marker."
 
62
zero_seven = "%s was deprecated in version 0.7."
 
63
zero_eight = "%s was deprecated in version 0.8."
 
64
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."
43
85
 
44
86
 
45
87
def deprecated_in(version_tuple):
46
88
    """Generate a message that something was deprecated in a release.
47
89
 
48
90
    >>> deprecated_in((1, 4, 0))
49
 
    '%s was deprecated in version 1.4.0.'
 
91
    '%s was deprecated in version 1.4.'
50
92
    """
51
93
    return ("%%s was deprecated in version %s."
52
94
            % bzrlib._format_version_tuple(version_tuple))
93
135
 
94
136
    def function_decorator(callable):
95
137
        """This is the function python calls to perform the decoration."""
96
 
 
 
138
        
97
139
        def decorated_function(*args, **kwargs):
98
140
            """This is the decorated function."""
99
141
            from bzrlib import trace
110
152
def deprecated_method(deprecation_version):
111
153
    """Decorate a method so that use of it will trigger a warning.
112
154
 
113
 
    To deprecate a static or class method, use
 
155
    To deprecate a static or class method, use 
114
156
 
115
157
        @staticmethod
116
158
        @deprecated_function
117
159
        def ...
118
 
 
 
160
    
119
161
    To deprecate an entire class, decorate __init__.
120
162
    """
121
163
 
122
164
    def method_decorator(callable):
123
165
        """This is the function python calls to perform the decoration."""
124
 
 
 
166
        
125
167
        def decorated_method(self, *args, **kwargs):
126
168
            """This is the decorated method."""
127
169
            from bzrlib import trace
145
187
 
146
188
def deprecated_passed(parameter_value):
147
189
    """Return True if parameter_value was used."""
148
 
    # FIXME: it might be nice to have a parameter deprecation decorator.
 
190
    # FIXME: it might be nice to have a parameter deprecation decorator. 
149
191
    # it would need to handle positional and *args and **kwargs parameters,
150
192
    # which means some mechanism to describe how the parameter was being
151
193
    # passed before deprecation, and some way to deprecate parameters that
171
213
    if len(docstring_lines) == 0:
172
214
        decorated_callable.__doc__ = deprecation_version % ("This " + label)
173
215
    elif len(docstring_lines) == 1:
174
 
        decorated_callable.__doc__ = (callable.__doc__
 
216
        decorated_callable.__doc__ = (callable.__doc__ 
175
217
                                    + "\n"
176
218
                                    + "\n"
177
219
                                    + deprecation_version % ("This " + label)
225
267
            typically from deprecated_in()
226
268
        :param initial_value: The contents of the dict
227
269
        :param variable_name: This allows better warnings to be printed
228
 
        :param advice: String of advice on what callers should do instead
 
270
        :param advice: String of advice on what callers should do instead 
229
271
            of using this variable.
230
272
        """
231
273
        self._deprecation_version = deprecation_version
267
309
        def _warn_deprecated(self, func, *args, **kwargs):
268
310
            warn(msg, DeprecationWarning, stacklevel=3)
269
311
            return func(self, *args, **kwargs)
270
 
 
 
312
            
271
313
        def append(self, obj):
272
314
            """appending to %s is deprecated""" % (variable_name,)
273
315
            return self._warn_deprecated(list.append, obj)
285
327
            return self._warn_deprecated(list.remove, value)
286
328
 
287
329
        def pop(self, index=None):
288
 
            """pop'ing from %s is deprecated""" % (variable_name,)
 
330
            """pop'ing from from %s is deprecated""" % (variable_name,)
289
331
            if index:
290
332
                return self._warn_deprecated(list.pop, index)
291
333
            else:
297
339
 
298
340
def _check_for_filter(error_only):
299
341
    """Check if there is already a filter for deprecation warnings.
300
 
 
 
342
    
301
343
    :param error_only: Only match an 'error' filter
302
344
    :return: True if a filter is found, False otherwise
303
345
    """
 
346
    import warnings
304
347
    for filter in warnings.filters:
305
348
        if issubclass(DeprecationWarning, filter[2]):
306
349
            # This filter will effect DeprecationWarning
309
352
    return False
310
353
 
311
354
 
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
355
def suppress_deprecation_warnings(override=True):
326
356
    """Call this function to suppress all deprecation warnings.
327
357
 
331
361
 
332
362
    :param override: If True, always set the ignore, if False, only set the
333
363
        ignore if there isn't already a filter.
334
 
 
335
 
    :return: A callable to remove the new warnings this added.
336
364
    """
 
365
    import warnings
337
366
    if not override and _check_for_filter(error_only=False):
338
367
        # If there is already a filter effecting suppress_deprecation_warnings,
339
368
        # 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)
 
369
        return
 
370
    warnings.filterwarnings('ignore', category=DeprecationWarning)
345
371
 
346
372
 
347
373
def activate_deprecation_warnings(override=True):
358
384
    :param override: If False, only add a filter if there isn't an error filter
359
385
        already. (This slightly differs from suppress_deprecation_warnings, in
360
386
        because it always overrides everything but -Werror).
361
 
 
362
 
    :return: A callable to remove the new warnings this added.
363
387
    """
 
388
    import warnings
364
389
    if not override and _check_for_filter(error_only=True):
365
390
        # DeprecationWarnings are already turned into errors, don't downgrade
366
391
        # 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)
 
392
        return
 
393
    warnings.filterwarnings('default', category=DeprecationWarning)