← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/symbol_versioning.py

  • Committer: Aaron Bentley
  • Date: 2007-06-11 14:59:52 UTC
  • mto: (2520.5.2 bzr.mpbundle)
  • mto: This revision was merged to the branch mainline in revision 2631.
  • Revision ID: abentley@panoramicfeedback.com-20070611145952-cwt4480gphdhen6l
Get installation started

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/symbol_versioning.py
1
 
# Copyright (C) 2006, 2007, 2008, 2009 Canonical Ltd
 
1
# Copyright (C) 2006, 2007 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',
30
39
           ]
31
40
 
32
41
from warnings import warn
33
42
 
34
 
import bzrlib
35
 
 
36
43
 
37
44
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))
 
45
zero_seven = "%s was deprecated in version 0.7."
 
46
zero_eight = "%s was deprecated in version 0.8."
 
47
zero_nine = "%s was deprecated in version 0.9."
 
48
zero_ten = "%s was deprecated in version 0.10."
 
49
zero_eleven = "%s was deprecated in version 0.11."
 
50
zero_twelve = "%s was deprecated in version 0.12."
 
51
zero_thirteen = "%s was deprecated in version 0.13."
 
52
zero_fourteen = "%s was deprecated in version 0.14."
 
53
zero_fifteen = "%s was deprecated in version 0.15."
 
54
zero_sixteen = "%s was deprecated in version 0.16."
 
55
zero_seventeen = "%s was deprecated in version 0.17."
48
56
 
49
57
 
50
58
def set_warning_method(method):
70
78
        have a single %s operator in it. a_callable will be turned into a nice
71
79
        python symbol and then substituted into deprecation_version.
72
80
    """
73
 
    # We also want to handle old-style classes, in particular exception, and
74
 
    # they don't have an im_class attribute.
75
81
    if getattr(a_callable, 'im_class', None) is None:
76
82
        symbol = "%s.%s" % (a_callable.__module__,
77
83
                            a_callable.__name__)
88
94
 
89
95
    def function_decorator(callable):
90
96
        """This is the function python calls to perform the decoration."""
91
 
 
 
97
        
92
98
        def decorated_function(*args, **kwargs):
93
99
            """This is the decorated function."""
94
 
            from bzrlib import trace
95
 
            trace.mutter_callsite(4, "Deprecated function called")
96
100
            warn(deprecation_string(callable, deprecation_version),
97
101
                DeprecationWarning, stacklevel=2)
98
102
            return callable(*args, **kwargs)
104
108
 
105
109
def deprecated_method(deprecation_version):
106
110
    """Decorate a method so that use of it will trigger a warning.
107
 
 
108
 
    To deprecate a static or class method, use
109
 
 
110
 
        @staticmethod
111
 
        @deprecated_function
112
 
        def ...
113
 
 
 
111
    
114
112
    To deprecate an entire class, decorate __init__.
115
113
    """
116
114
 
117
115
    def method_decorator(callable):
118
116
        """This is the function python calls to perform the decoration."""
119
 
 
 
117
        
120
118
        def decorated_method(self, *args, **kwargs):
121
119
            """This is the decorated method."""
122
 
            from bzrlib import trace
123
 
            if callable.__name__ == '__init__':
124
 
                symbol = "%s.%s" % (self.__class__.__module__,
125
 
                                    self.__class__.__name__,
126
 
                                    )
127
 
            else:
128
 
                symbol = "%s.%s.%s" % (self.__class__.__module__,
129
 
                                       self.__class__.__name__,
130
 
                                       callable.__name__
131
 
                                       )
132
 
            trace.mutter_callsite(4, "Deprecated method called")
 
120
            symbol = "%s.%s.%s" % (self.__class__.__module__,
 
121
                                   self.__class__.__name__,
 
122
                                   callable.__name__
 
123
                                   )
133
124
            warn(deprecation_version % symbol, DeprecationWarning, stacklevel=2)
134
125
            return callable(self, *args, **kwargs)
135
126
        _populate_decorated(callable, deprecation_version, "method",
140
131
 
141
132
def deprecated_passed(parameter_value):
142
133
    """Return True if parameter_value was used."""
143
 
    # FIXME: it might be nice to have a parameter deprecation decorator.
 
134
    # FIXME: it might be nice to have a parameter deprecation decorator. 
144
135
    # it would need to handle positional and *args and **kwargs parameters,
145
136
    # which means some mechanism to describe how the parameter was being
146
137
    # passed before deprecation, and some way to deprecate parameters that
148
139
    # we cannot just forward to a new method name.I.e. in the following
149
140
    # examples we would want to have callers that pass any value to 'bad' be
150
141
    # given a warning - because we have applied:
151
 
    # @deprecated_parameter('bad', deprecated_in((1, 5, 0))
 
142
    # @deprecated_parameter('bad', zero_seven)
152
143
    #
153
144
    # def __init__(self, bad=None)
154
145
    # def __init__(self, bad, other)
166
157
    if len(docstring_lines) == 0:
167
158
        decorated_callable.__doc__ = deprecation_version % ("This " + label)
168
159
    elif len(docstring_lines) == 1:
169
 
        decorated_callable.__doc__ = (callable.__doc__
 
160
        decorated_callable.__doc__ = (callable.__doc__ 
170
161
                                    + "\n"
171
162
                                    + "\n"
172
163
                                    + deprecation_version % ("This " + label)
216
207
        ):
217
208
        """Create a dict that warns when read or modified.
218
209
 
219
 
        :param deprecation_version: string for the warning format to raise,
220
 
            typically from deprecated_in()
 
210
        :param deprecation_version: something like zero_nine
221
211
        :param initial_value: The contents of the dict
222
212
        :param variable_name: This allows better warnings to be printed
223
 
        :param advice: String of advice on what callers should do instead
 
213
        :param advice: String of advice on what callers should do instead 
224
214
            of using this variable.
225
215
        """
226
216
        self._deprecation_version = deprecation_version
242
232
                    initial_value, extra=None):
243
233
    """Create a list that warns when modified
244
234
 
245
 
    :param deprecation_version: string for the warning format to raise,
246
 
        typically from deprecated_in()
 
235
    :param deprecation_version: something like zero_nine
247
236
    :param initial_value: The contents of the list
248
237
    :param variable_name: This allows better warnings to be printed
249
238
    :param extra: Extra info to print when printing a warning
262
251
        def _warn_deprecated(self, func, *args, **kwargs):
263
252
            warn(msg, DeprecationWarning, stacklevel=3)
264
253
            return func(self, *args, **kwargs)
265
 
 
 
254
            
266
255
        def append(self, obj):
267
256
            """appending to %s is deprecated""" % (variable_name,)
268
257
            return self._warn_deprecated(list.append, obj)
280
269
            return self._warn_deprecated(list.remove, value)
281
270
 
282
271
        def pop(self, index=None):
283
 
            """pop'ing from %s is deprecated""" % (variable_name,)
 
272
            """pop'ing from from %s is deprecated""" % (variable_name,)
284
273
            if index:
285
274
                return self._warn_deprecated(list.pop, index)
286
275
            else:
288
277
                return self._warn_deprecated(list.pop)
289
278
 
290
279
    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)