← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/symbol_versioning.py

- rules for using destructors

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
2
 
#
3
 
# This program is free software; you can redistribute it and/or modify
4
 
# it under the terms of the GNU General Public License as published by
5
 
# the Free Software Foundation; either version 2 of the License, or
6
 
# (at your option) any later version.
7
 
#
8
 
# This program is distributed in the hope that it will be useful,
9
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
 
# GNU General Public License for more details.
12
 
#
13
 
# You should have received a copy of the GNU General Public License
14
 
# 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
 
 
17
 
"""Symbol versioning
18
 
 
19
 
The methods here allow for api symbol versioning.
20
 
"""
21
 
 
22
 
__all__ = ['deprecated_function',
23
 
           'deprecated_in',
24
 
           'deprecated_list',
25
 
           'deprecated_method',
26
 
           'DEPRECATED_PARAMETER',
27
 
           'deprecated_passed',
28
 
           'set_warning_method',
29
 
           'warn',
30
 
           ]
31
 
 
32
 
from warnings import warn
33
 
 
34
 
import bzrlib
35
 
 
36
 
 
37
 
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
 
 
49
 
 
50
 
def set_warning_method(method):
51
 
    """Set the warning method to be used by this module.
52
 
 
53
 
    It should take a message and a warning category as warnings.warn does.
54
 
    """
55
 
    global warn
56
 
    warn = method
57
 
 
58
 
 
59
 
# TODO - maybe this would be easier to use as one 'smart' method that
60
 
# guess if it is a method or a class or an attribute ? If so, we can
61
 
# add that on top of the primitives, once we have all three written
62
 
# - RBC 20050105
63
 
 
64
 
 
65
 
def deprecation_string(a_callable, deprecation_version):
66
 
    """Generate an automatic deprecation string for a_callable.
67
 
 
68
 
    :param a_callable: The callable to substitute into deprecation_version.
69
 
    :param deprecation_version: A deprecation format warning string. This should
70
 
        have a single %s operator in it. a_callable will be turned into a nice
71
 
        python symbol and then substituted into deprecation_version.
72
 
    """
73
 
    # We also want to handle old-style classes, in particular exception, and
74
 
    # they don't have an im_class attribute.
75
 
    if getattr(a_callable, 'im_class', None) is None:
76
 
        symbol = "%s.%s" % (a_callable.__module__,
77
 
                            a_callable.__name__)
78
 
    else:
79
 
        symbol = "%s.%s.%s" % (a_callable.im_class.__module__,
80
 
                               a_callable.im_class.__name__,
81
 
                               a_callable.__name__
82
 
                               )
83
 
    return deprecation_version % symbol
84
 
 
85
 
 
86
 
def deprecated_function(deprecation_version):
87
 
    """Decorate a function so that use of it will trigger a warning."""
88
 
 
89
 
    def function_decorator(callable):
90
 
        """This is the function python calls to perform the decoration."""
91
 
 
92
 
        def decorated_function(*args, **kwargs):
93
 
            """This is the decorated function."""
94
 
            from bzrlib import trace
95
 
            trace.mutter_callsite(4, "Deprecated function called")
96
 
            warn(deprecation_string(callable, deprecation_version),
97
 
                DeprecationWarning, stacklevel=2)
98
 
            return callable(*args, **kwargs)
99
 
        _populate_decorated(callable, deprecation_version, "function",
100
 
                            decorated_function)
101
 
        return decorated_function
102
 
    return function_decorator
103
 
 
104
 
 
105
 
def deprecated_method(deprecation_version):
106
 
    """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
 
 
114
 
    To deprecate an entire class, decorate __init__.
115
 
    """
116
 
 
117
 
    def method_decorator(callable):
118
 
        """This is the function python calls to perform the decoration."""
119
 
 
120
 
        def decorated_method(self, *args, **kwargs):
121
 
            """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")
133
 
            warn(deprecation_version % symbol, DeprecationWarning, stacklevel=2)
134
 
            return callable(self, *args, **kwargs)
135
 
        _populate_decorated(callable, deprecation_version, "method",
136
 
                            decorated_method)
137
 
        return decorated_method
138
 
    return method_decorator
139
 
 
140
 
 
141
 
def deprecated_passed(parameter_value):
142
 
    """Return True if parameter_value was used."""
143
 
    # FIXME: it might be nice to have a parameter deprecation decorator.
144
 
    # it would need to handle positional and *args and **kwargs parameters,
145
 
    # which means some mechanism to describe how the parameter was being
146
 
    # passed before deprecation, and some way to deprecate parameters that
147
 
    # were not at the end of the arg list. Thats needed for __init__ where
148
 
    # we cannot just forward to a new method name.I.e. in the following
149
 
    # examples we would want to have callers that pass any value to 'bad' be
150
 
    # given a warning - because we have applied:
151
 
    # @deprecated_parameter('bad', deprecated_in((1, 5, 0))
152
 
    #
153
 
    # def __init__(self, bad=None)
154
 
    # def __init__(self, bad, other)
155
 
    # def __init__(self, **kwargs)
156
 
    # RBC 20060116
157
 
    return not parameter_value is DEPRECATED_PARAMETER
158
 
 
159
 
 
160
 
def _decorate_docstring(callable, deprecation_version, label,
161
 
                        decorated_callable):
162
 
    if callable.__doc__:
163
 
        docstring_lines = callable.__doc__.split('\n')
164
 
    else:
165
 
        docstring_lines = []
166
 
    if len(docstring_lines) == 0:
167
 
        decorated_callable.__doc__ = deprecation_version % ("This " + label)
168
 
    elif len(docstring_lines) == 1:
169
 
        decorated_callable.__doc__ = (callable.__doc__
170
 
                                    + "\n"
171
 
                                    + "\n"
172
 
                                    + deprecation_version % ("This " + label)
173
 
                                    + "\n")
174
 
    else:
175
 
        spaces = len(docstring_lines[-1])
176
 
        new_doc = callable.__doc__
177
 
        new_doc += "\n" + " " * spaces
178
 
        new_doc += deprecation_version % ("This " + label)
179
 
        new_doc += "\n" + " " * spaces
180
 
        decorated_callable.__doc__ = new_doc
181
 
 
182
 
 
183
 
def _populate_decorated(callable, deprecation_version, label,
184
 
                        decorated_callable):
185
 
    """Populate attributes like __name__ and __doc__ on the decorated callable.
186
 
    """
187
 
    _decorate_docstring(callable, deprecation_version, label,
188
 
                        decorated_callable)
189
 
    decorated_callable.__module__ = callable.__module__
190
 
    decorated_callable.__name__ = callable.__name__
191
 
    decorated_callable.is_deprecated = True
192
 
 
193
 
 
194
 
def _dict_deprecation_wrapper(wrapped_method):
195
 
    """Returns a closure that emits a warning and calls the superclass"""
196
 
    def cb(dep_dict, *args, **kwargs):
197
 
        msg = 'access to %s' % (dep_dict._variable_name, )
198
 
        msg = dep_dict._deprecation_version % (msg,)
199
 
        if dep_dict._advice:
200
 
            msg += ' ' + dep_dict._advice
201
 
        warn(msg, DeprecationWarning, stacklevel=2)
202
 
        return wrapped_method(dep_dict, *args, **kwargs)
203
 
    return cb
204
 
 
205
 
 
206
 
class DeprecatedDict(dict):
207
 
    """A dictionary that complains when read or written."""
208
 
 
209
 
    is_deprecated = True
210
 
 
211
 
    def __init__(self,
212
 
        deprecation_version,
213
 
        variable_name,
214
 
        initial_value,
215
 
        advice,
216
 
        ):
217
 
        """Create a dict that warns when read or modified.
218
 
 
219
 
        :param deprecation_version: string for the warning format to raise,
220
 
            typically from deprecated_in()
221
 
        :param initial_value: The contents of the dict
222
 
        :param variable_name: This allows better warnings to be printed
223
 
        :param advice: String of advice on what callers should do instead
224
 
            of using this variable.
225
 
        """
226
 
        self._deprecation_version = deprecation_version
227
 
        self._variable_name = variable_name
228
 
        self._advice = advice
229
 
        dict.__init__(self, initial_value)
230
 
 
231
 
    # This isn't every possible method but it should trap anyone using the
232
 
    # dict -- add more if desired
233
 
    __len__ = _dict_deprecation_wrapper(dict.__len__)
234
 
    __getitem__ = _dict_deprecation_wrapper(dict.__getitem__)
235
 
    __setitem__ = _dict_deprecation_wrapper(dict.__setitem__)
236
 
    __delitem__ = _dict_deprecation_wrapper(dict.__delitem__)
237
 
    keys = _dict_deprecation_wrapper(dict.keys)
238
 
    __contains__ = _dict_deprecation_wrapper(dict.__contains__)
239
 
 
240
 
 
241
 
def deprecated_list(deprecation_version, variable_name,
242
 
                    initial_value, extra=None):
243
 
    """Create a list that warns when modified
244
 
 
245
 
    :param deprecation_version: string for the warning format to raise,
246
 
        typically from deprecated_in()
247
 
    :param initial_value: The contents of the list
248
 
    :param variable_name: This allows better warnings to be printed
249
 
    :param extra: Extra info to print when printing a warning
250
 
    """
251
 
 
252
 
    subst_text = 'Modifying %s' % (variable_name,)
253
 
    msg = deprecation_version % (subst_text,)
254
 
    if extra:
255
 
        msg += ' ' + extra
256
 
 
257
 
    class _DeprecatedList(list):
258
 
        __doc__ = list.__doc__ + msg
259
 
 
260
 
        is_deprecated = True
261
 
 
262
 
        def _warn_deprecated(self, func, *args, **kwargs):
263
 
            warn(msg, DeprecationWarning, stacklevel=3)
264
 
            return func(self, *args, **kwargs)
265
 
 
266
 
        def append(self, obj):
267
 
            """appending to %s is deprecated""" % (variable_name,)
268
 
            return self._warn_deprecated(list.append, obj)
269
 
 
270
 
        def insert(self, index, obj):
271
 
            """inserting to %s is deprecated""" % (variable_name,)
272
 
            return self._warn_deprecated(list.insert, index, obj)
273
 
 
274
 
        def extend(self, iterable):
275
 
            """extending %s is deprecated""" % (variable_name,)
276
 
            return self._warn_deprecated(list.extend, iterable)
277
 
 
278
 
        def remove(self, value):
279
 
            """removing from %s is deprecated""" % (variable_name,)
280
 
            return self._warn_deprecated(list.remove, value)
281
 
 
282
 
        def pop(self, index=None):
283
 
            """pop'ing from %s is deprecated""" % (variable_name,)
284
 
            if index:
285
 
                return self._warn_deprecated(list.pop, index)
286
 
            else:
287
 
                # Can't pass None
288
 
                return self._warn_deprecated(list.pop)
289
 
 
290
 
    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)