← 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: 2007-06-18 06:54:24 UTC
  • mto: This revision was merged to the branch mainline in revision 2551.
  • Revision ID: mbp@sourcefrog.net-20070618065424-awsn4t4tv2bi4okt
Remove duplicated commit use case documentation

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 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
 
 
33
 
import warnings
34
 
# Import the 'warn' symbol so bzrlib can call it even if we redefine it
35
41
from warnings import warn
36
42
 
37
 
import bzrlib
38
 
 
39
43
 
40
44
DEPRECATED_PARAMETER = "A deprecated parameter marker."
41
 
 
42
 
 
43
 
def deprecated_in(version_tuple):
44
 
    """Generate a message that something was deprecated in a release.
45
 
 
46
 
    >>> deprecated_in((1, 4, 0))
47
 
    '%s was deprecated in version 1.4.0.'
48
 
    """
49
 
    return ("%%s was deprecated in version %s."
50
 
            % 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."
51
56
 
52
57
 
53
58
def set_warning_method(method):
73
78
        have a single %s operator in it. a_callable will be turned into a nice
74
79
        python symbol and then substituted into deprecation_version.
75
80
    """
76
 
    # We also want to handle old-style classes, in particular exception, and
77
 
    # they don't have an im_class attribute.
78
81
    if getattr(a_callable, 'im_class', None) is None:
79
82
        symbol = "%s.%s" % (a_callable.__module__,
80
83
                            a_callable.__name__)
91
94
 
92
95
    def function_decorator(callable):
93
96
        """This is the function python calls to perform the decoration."""
94
 
 
 
97
        
95
98
        def decorated_function(*args, **kwargs):
96
99
            """This is the decorated function."""
97
 
            from bzrlib import trace
98
 
            trace.mutter_callsite(4, "Deprecated function called")
99
100
            warn(deprecation_string(callable, deprecation_version),
100
101
                DeprecationWarning, stacklevel=2)
101
102
            return callable(*args, **kwargs)
107
108
 
108
109
def deprecated_method(deprecation_version):
109
110
    """Decorate a method so that use of it will trigger a warning.
110
 
 
111
 
    To deprecate a static or class method, use
112
 
 
113
 
        @staticmethod
114
 
        @deprecated_function
115
 
        def ...
116
 
 
 
111
    
117
112
    To deprecate an entire class, decorate __init__.
118
113
    """
119
114
 
120
115
    def method_decorator(callable):
121
116
        """This is the function python calls to perform the decoration."""
122
 
 
 
117
        
123
118
        def decorated_method(self, *args, **kwargs):
124
119
            """This is the decorated method."""
125
 
            from bzrlib import trace
126
 
            if callable.__name__ == '__init__':
127
 
                symbol = "%s.%s" % (self.__class__.__module__,
128
 
                                    self.__class__.__name__,
129
 
                                    )
130
 
            else:
131
 
                symbol = "%s.%s.%s" % (self.__class__.__module__,
132
 
                                       self.__class__.__name__,
133
 
                                       callable.__name__
134
 
                                       )
135
 
            trace.mutter_callsite(4, "Deprecated method called")
 
120
            symbol = "%s.%s.%s" % (self.__class__.__module__,
 
121
                                   self.__class__.__name__,
 
122
                                   callable.__name__
 
123
                                   )
136
124
            warn(deprecation_version % symbol, DeprecationWarning, stacklevel=2)
137
125
            return callable(self, *args, **kwargs)
138
126
        _populate_decorated(callable, deprecation_version, "method",
143
131
 
144
132
def deprecated_passed(parameter_value):
145
133
    """Return True if parameter_value was used."""
146
 
    # FIXME: it might be nice to have a parameter deprecation decorator.
 
134
    # FIXME: it might be nice to have a parameter deprecation decorator. 
147
135
    # it would need to handle positional and *args and **kwargs parameters,
148
136
    # which means some mechanism to describe how the parameter was being
149
137
    # passed before deprecation, and some way to deprecate parameters that
151
139
    # we cannot just forward to a new method name.I.e. in the following
152
140
    # examples we would want to have callers that pass any value to 'bad' be
153
141
    # given a warning - because we have applied:
154
 
    # @deprecated_parameter('bad', deprecated_in((1, 5, 0))
 
142
    # @deprecated_parameter('bad', zero_seven)
155
143
    #
156
144
    # def __init__(self, bad=None)
157
145
    # def __init__(self, bad, other)
169
157
    if len(docstring_lines) == 0:
170
158
        decorated_callable.__doc__ = deprecation_version % ("This " + label)
171
159
    elif len(docstring_lines) == 1:
172
 
        decorated_callable.__doc__ = (callable.__doc__
 
160
        decorated_callable.__doc__ = (callable.__doc__ 
173
161
                                    + "\n"
174
162
                                    + "\n"
175
163
                                    + deprecation_version % ("This " + label)
219
207
        ):
220
208
        """Create a dict that warns when read or modified.
221
209
 
222
 
        :param deprecation_version: string for the warning format to raise,
223
 
            typically from deprecated_in()
 
210
        :param deprecation_version: something like zero_nine
224
211
        :param initial_value: The contents of the dict
225
212
        :param variable_name: This allows better warnings to be printed
226
 
        :param advice: String of advice on what callers should do instead
 
213
        :param advice: String of advice on what callers should do instead 
227
214
            of using this variable.
228
215
        """
229
216
        self._deprecation_version = deprecation_version
245
232
                    initial_value, extra=None):
246
233
    """Create a list that warns when modified
247
234
 
248
 
    :param deprecation_version: string for the warning format to raise,
249
 
        typically from deprecated_in()
 
235
    :param deprecation_version: something like zero_nine
250
236
    :param initial_value: The contents of the list
251
237
    :param variable_name: This allows better warnings to be printed
252
238
    :param extra: Extra info to print when printing a warning
265
251
        def _warn_deprecated(self, func, *args, **kwargs):
266
252
            warn(msg, DeprecationWarning, stacklevel=3)
267
253
            return func(self, *args, **kwargs)
268
 
 
 
254
            
269
255
        def append(self, obj):
270
256
            """appending to %s is deprecated""" % (variable_name,)
271
257
            return self._warn_deprecated(list.append, obj)
283
269
            return self._warn_deprecated(list.remove, value)
284
270
 
285
271
        def pop(self, index=None):
286
 
            """pop'ing from %s is deprecated""" % (variable_name,)
 
272
            """pop'ing from from %s is deprecated""" % (variable_name,)
287
273
            if index:
288
274
                return self._warn_deprecated(list.pop, index)
289
275
            else:
291
277
                return self._warn_deprecated(list.pop)
292
278
 
293
279
    return _DeprecatedList(initial_value)
294
 
 
295
 
 
296
 
def _check_for_filter(error_only):
297
 
    """Check if there is already a filter for deprecation warnings.
298
 
 
299
 
    :param error_only: Only match an 'error' filter
300
 
    :return: True if a filter is found, False otherwise
301
 
    """
302
 
    for filter in warnings.filters:
303
 
        if issubclass(DeprecationWarning, filter[2]):
304
 
            # This filter will effect DeprecationWarning
305
 
            if not error_only or filter[0] == 'error':
306
 
                return True
307
 
    return False
308
 
 
309
 
 
310
 
def _remove_filter_callable(filter):
311
 
    """Build and returns a callable removing filter from the warnings.
312
 
 
313
 
    :param filter: The filter to remove (can be None).
314
 
 
315
 
    :return: A callable that will remove filter from warnings.filters.
316
 
    """
317
 
    def cleanup():
318
 
        if filter:
319
 
            warnings.filters.remove(filter)
320
 
    return cleanup
321
 
 
322
 
 
323
 
def suppress_deprecation_warnings(override=True):
324
 
    """Call this function to suppress all deprecation warnings.
325
 
 
326
 
    When this is a final release version, we don't want to annoy users with
327
 
    lots of deprecation warnings. We only want the deprecation warnings when
328
 
    running a dev or release candidate.
329
 
 
330
 
    :param override: If True, always set the ignore, if False, only set the
331
 
        ignore if there isn't already a filter.
332
 
 
333
 
    :return: A callable to remove the new warnings this added.
334
 
    """
335
 
    if not override and _check_for_filter(error_only=False):
336
 
        # If there is already a filter effecting suppress_deprecation_warnings,
337
 
        # then skip it.
338
 
        filter = None
339
 
    else:
340
 
        warnings.filterwarnings('ignore', category=DeprecationWarning)
341
 
        filter = warnings.filters[0]
342
 
    return _remove_filter_callable(filter)
343
 
 
344
 
 
345
 
def activate_deprecation_warnings(override=True):
346
 
    """Call this function to activate deprecation warnings.
347
 
 
348
 
    When running in a 'final' release we suppress deprecation warnings.
349
 
    However, the test suite wants to see them. So when running selftest, we
350
 
    re-enable the deprecation warnings.
351
 
 
352
 
    Note: warnings that have already been issued under 'ignore' will not be
353
 
    reported after this point. The 'warnings' module has already marked them as
354
 
    handled, so they don't get issued again.
355
 
 
356
 
    :param override: If False, only add a filter if there isn't an error filter
357
 
        already. (This slightly differs from suppress_deprecation_warnings, in
358
 
        because it always overrides everything but -Werror).
359
 
 
360
 
    :return: A callable to remove the new warnings this added.
361
 
    """
362
 
    if not override and _check_for_filter(error_only=True):
363
 
        # DeprecationWarnings are already turned into errors, don't downgrade
364
 
        # them to 'default'.
365
 
        filter = None
366
 
    else:
367
 
        warnings.filterwarnings('default', category=DeprecationWarning)
368
 
        filter = warnings.filters[0]
369
 
    return _remove_filter_callable(filter)