/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

Fix some bit of fetching.

Show diffs side-by-side

added added

removed removed

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