/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/symbol_versioning.py

  • Committer: Martin Pool
  • Date: 2008-04-09 02:32:18 UTC
  • mto: This revision was merged to the branch mainline in revision 3352.
  • Revision ID: mbp@sourcefrog.net-20080409023218-js7bteu4qrdn3coe
LockableFiles should warn but not automatically unlock

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006, 2007, 2008, 2009 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
 
20
21
"""
21
22
 
22
23
__all__ = ['deprecated_function',
23
 
           'deprecated_in',
24
24
           'deprecated_list',
25
25
           'deprecated_method',
26
26
           'DEPRECATED_PARAMETER',
27
27
           'deprecated_passed',
28
 
           'set_warning_method',
29
 
           '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',
30
48
           ]
31
49
 
32
50
from warnings import warn
33
51
 
34
 
import bzrlib
35
 
 
36
52
 
37
53
DEPRECATED_PARAMETER = "A deprecated parameter marker."
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))
48
 
 
 
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."
49
75
 
50
76
def set_warning_method(method):
51
77
    """Set the warning method to be used by this module.
88
114
 
89
115
    def function_decorator(callable):
90
116
        """This is the function python calls to perform the decoration."""
91
 
 
 
117
        
92
118
        def decorated_function(*args, **kwargs):
93
119
            """This is the decorated function."""
94
 
            from bzrlib import trace
95
 
            trace.mutter_callsite(4, "Deprecated function called")
96
120
            warn(deprecation_string(callable, deprecation_version),
97
121
                DeprecationWarning, stacklevel=2)
98
122
            return callable(*args, **kwargs)
105
129
def deprecated_method(deprecation_version):
106
130
    """Decorate a method so that use of it will trigger a warning.
107
131
 
108
 
    To deprecate a static or class method, use
 
132
    To deprecate a static or class method, use 
109
133
 
110
134
        @staticmethod
111
135
        @deprecated_function
112
136
        def ...
113
 
 
 
137
    
114
138
    To deprecate an entire class, decorate __init__.
115
139
    """
116
140
 
117
141
    def method_decorator(callable):
118
142
        """This is the function python calls to perform the decoration."""
119
 
 
 
143
        
120
144
        def decorated_method(self, *args, **kwargs):
121
145
            """This is the decorated method."""
122
 
            from bzrlib import trace
123
146
            if callable.__name__ == '__init__':
124
147
                symbol = "%s.%s" % (self.__class__.__module__,
125
148
                                    self.__class__.__name__,
129
152
                                       self.__class__.__name__,
130
153
                                       callable.__name__
131
154
                                       )
132
 
            trace.mutter_callsite(4, "Deprecated method called")
133
155
            warn(deprecation_version % symbol, DeprecationWarning, stacklevel=2)
134
156
            return callable(self, *args, **kwargs)
135
157
        _populate_decorated(callable, deprecation_version, "method",
140
162
 
141
163
def deprecated_passed(parameter_value):
142
164
    """Return True if parameter_value was used."""
143
 
    # FIXME: it might be nice to have a parameter deprecation decorator.
 
165
    # FIXME: it might be nice to have a parameter deprecation decorator. 
144
166
    # it would need to handle positional and *args and **kwargs parameters,
145
167
    # which means some mechanism to describe how the parameter was being
146
168
    # passed before deprecation, and some way to deprecate parameters that
148
170
    # we cannot just forward to a new method name.I.e. in the following
149
171
    # examples we would want to have callers that pass any value to 'bad' be
150
172
    # given a warning - because we have applied:
151
 
    # @deprecated_parameter('bad', deprecated_in((1, 5, 0))
 
173
    # @deprecated_parameter('bad', zero_seven)
152
174
    #
153
175
    # def __init__(self, bad=None)
154
176
    # def __init__(self, bad, other)
166
188
    if len(docstring_lines) == 0:
167
189
        decorated_callable.__doc__ = deprecation_version % ("This " + label)
168
190
    elif len(docstring_lines) == 1:
169
 
        decorated_callable.__doc__ = (callable.__doc__
 
191
        decorated_callable.__doc__ = (callable.__doc__ 
170
192
                                    + "\n"
171
193
                                    + "\n"
172
194
                                    + deprecation_version % ("This " + label)
216
238
        ):
217
239
        """Create a dict that warns when read or modified.
218
240
 
219
 
        :param deprecation_version: string for the warning format to raise,
220
 
            typically from deprecated_in()
 
241
        :param deprecation_version: something like zero_nine
221
242
        :param initial_value: The contents of the dict
222
243
        :param variable_name: This allows better warnings to be printed
223
 
        :param advice: String of advice on what callers should do instead
 
244
        :param advice: String of advice on what callers should do instead 
224
245
            of using this variable.
225
246
        """
226
247
        self._deprecation_version = deprecation_version
242
263
                    initial_value, extra=None):
243
264
    """Create a list that warns when modified
244
265
 
245
 
    :param deprecation_version: string for the warning format to raise,
246
 
        typically from deprecated_in()
 
266
    :param deprecation_version: something like zero_nine
247
267
    :param initial_value: The contents of the list
248
268
    :param variable_name: This allows better warnings to be printed
249
269
    :param extra: Extra info to print when printing a warning
262
282
        def _warn_deprecated(self, func, *args, **kwargs):
263
283
            warn(msg, DeprecationWarning, stacklevel=3)
264
284
            return func(self, *args, **kwargs)
265
 
 
 
285
            
266
286
        def append(self, obj):
267
287
            """appending to %s is deprecated""" % (variable_name,)
268
288
            return self._warn_deprecated(list.append, obj)
280
300
            return self._warn_deprecated(list.remove, value)
281
301
 
282
302
        def pop(self, index=None):
283
 
            """pop'ing from %s is deprecated""" % (variable_name,)
 
303
            """pop'ing from from %s is deprecated""" % (variable_name,)
284
304
            if index:
285
305
                return self._warn_deprecated(list.pop, index)
286
306
            else:
288
308
                return self._warn_deprecated(list.pop)
289
309
 
290
310
    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)