/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 typos

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/symbol_versioning.py
 
1
# Copyright (C) 2006, 2007, 2008 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
           'one_zero',
 
45
           'one_one',
 
46
           'one_two',
 
47
           'one_three',
 
48
           ]
 
49
 
 
50
from warnings import warn
 
51
 
 
52
 
 
53
DEPRECATED_PARAMETER = "A deprecated parameter marker."
 
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."
 
75
 
 
76
def set_warning_method(method):
 
77
    """Set the warning method to be used by this module.
 
78
 
 
79
    It should take a message and a warning category as warnings.warn does.
 
80
    """
 
81
    global warn
 
82
    warn = method
 
83
 
 
84
 
 
85
# TODO - maybe this would be easier to use as one 'smart' method that
 
86
# guess if it is a method or a class or an attribute ? If so, we can
 
87
# add that on top of the primitives, once we have all three written
 
88
# - RBC 20050105
 
89
 
 
90
 
 
91
def deprecation_string(a_callable, deprecation_version):
 
92
    """Generate an automatic deprecation string for a_callable.
 
93
 
 
94
    :param a_callable: The callable to substitute into deprecation_version.
 
95
    :param deprecation_version: A deprecation format warning string. This should
 
96
        have a single %s operator in it. a_callable will be turned into a nice
 
97
        python symbol and then substituted into deprecation_version.
 
98
    """
 
99
    # We also want to handle old-style classes, in particular exception, and
 
100
    # they don't have an im_class attribute.
 
101
    if getattr(a_callable, 'im_class', None) is None:
 
102
        symbol = "%s.%s" % (a_callable.__module__,
 
103
                            a_callable.__name__)
 
104
    else:
 
105
        symbol = "%s.%s.%s" % (a_callable.im_class.__module__,
 
106
                               a_callable.im_class.__name__,
 
107
                               a_callable.__name__
 
108
                               )
 
109
    return deprecation_version % symbol
 
110
 
 
111
 
 
112
def deprecated_function(deprecation_version):
 
113
    """Decorate a function so that use of it will trigger a warning."""
 
114
 
 
115
    def function_decorator(callable):
 
116
        """This is the function python calls to perform the decoration."""
 
117
        
 
118
        def decorated_function(*args, **kwargs):
 
119
            """This is the decorated function."""
 
120
            warn(deprecation_string(callable, deprecation_version),
 
121
                DeprecationWarning, stacklevel=2)
 
122
            return callable(*args, **kwargs)
 
123
        _populate_decorated(callable, deprecation_version, "function",
 
124
                            decorated_function)
 
125
        return decorated_function
 
126
    return function_decorator
 
127
 
 
128
 
 
129
def deprecated_method(deprecation_version):
 
130
    """Decorate a method so that use of it will trigger a warning.
 
131
 
 
132
    To deprecate a static or class method, use 
 
133
 
 
134
        @staticmethod
 
135
        @deprecated_function
 
136
        def ...
 
137
    
 
138
    To deprecate an entire class, decorate __init__.
 
139
    """
 
140
 
 
141
    def method_decorator(callable):
 
142
        """This is the function python calls to perform the decoration."""
 
143
        
 
144
        def decorated_method(self, *args, **kwargs):
 
145
            """This is the decorated method."""
 
146
            if callable.__name__ == '__init__':
 
147
                symbol = "%s.%s" % (self.__class__.__module__,
 
148
                                    self.__class__.__name__,
 
149
                                    )
 
150
            else:
 
151
                symbol = "%s.%s.%s" % (self.__class__.__module__,
 
152
                                       self.__class__.__name__,
 
153
                                       callable.__name__
 
154
                                       )
 
155
            warn(deprecation_version % symbol, DeprecationWarning, stacklevel=2)
 
156
            return callable(self, *args, **kwargs)
 
157
        _populate_decorated(callable, deprecation_version, "method",
 
158
                            decorated_method)
 
159
        return decorated_method
 
160
    return method_decorator
 
161
 
 
162
 
 
163
def deprecated_passed(parameter_value):
 
164
    """Return True if parameter_value was used."""
 
165
    # FIXME: it might be nice to have a parameter deprecation decorator. 
 
166
    # it would need to handle positional and *args and **kwargs parameters,
 
167
    # which means some mechanism to describe how the parameter was being
 
168
    # passed before deprecation, and some way to deprecate parameters that
 
169
    # were not at the end of the arg list. Thats needed for __init__ where
 
170
    # we cannot just forward to a new method name.I.e. in the following
 
171
    # examples we would want to have callers that pass any value to 'bad' be
 
172
    # given a warning - because we have applied:
 
173
    # @deprecated_parameter('bad', zero_seven)
 
174
    #
 
175
    # def __init__(self, bad=None)
 
176
    # def __init__(self, bad, other)
 
177
    # def __init__(self, **kwargs)
 
178
    # RBC 20060116
 
179
    return not parameter_value is DEPRECATED_PARAMETER
 
180
 
 
181
 
 
182
def _decorate_docstring(callable, deprecation_version, label,
 
183
                        decorated_callable):
 
184
    if callable.__doc__:
 
185
        docstring_lines = callable.__doc__.split('\n')
 
186
    else:
 
187
        docstring_lines = []
 
188
    if len(docstring_lines) == 0:
 
189
        decorated_callable.__doc__ = deprecation_version % ("This " + label)
 
190
    elif len(docstring_lines) == 1:
 
191
        decorated_callable.__doc__ = (callable.__doc__ 
 
192
                                    + "\n"
 
193
                                    + "\n"
 
194
                                    + deprecation_version % ("This " + label)
 
195
                                    + "\n")
 
196
    else:
 
197
        spaces = len(docstring_lines[-1])
 
198
        new_doc = callable.__doc__
 
199
        new_doc += "\n" + " " * spaces
 
200
        new_doc += deprecation_version % ("This " + label)
 
201
        new_doc += "\n" + " " * spaces
 
202
        decorated_callable.__doc__ = new_doc
 
203
 
 
204
 
 
205
def _populate_decorated(callable, deprecation_version, label,
 
206
                        decorated_callable):
 
207
    """Populate attributes like __name__ and __doc__ on the decorated callable.
 
208
    """
 
209
    _decorate_docstring(callable, deprecation_version, label,
 
210
                        decorated_callable)
 
211
    decorated_callable.__module__ = callable.__module__
 
212
    decorated_callable.__name__ = callable.__name__
 
213
    decorated_callable.is_deprecated = True
 
214
 
 
215
 
 
216
def _dict_deprecation_wrapper(wrapped_method):
 
217
    """Returns a closure that emits a warning and calls the superclass"""
 
218
    def cb(dep_dict, *args, **kwargs):
 
219
        msg = 'access to %s' % (dep_dict._variable_name, )
 
220
        msg = dep_dict._deprecation_version % (msg,)
 
221
        if dep_dict._advice:
 
222
            msg += ' ' + dep_dict._advice
 
223
        warn(msg, DeprecationWarning, stacklevel=2)
 
224
        return wrapped_method(dep_dict, *args, **kwargs)
 
225
    return cb
 
226
 
 
227
 
 
228
class DeprecatedDict(dict):
 
229
    """A dictionary that complains when read or written."""
 
230
 
 
231
    is_deprecated = True
 
232
 
 
233
    def __init__(self,
 
234
        deprecation_version,
 
235
        variable_name,
 
236
        initial_value,
 
237
        advice,
 
238
        ):
 
239
        """Create a dict that warns when read or modified.
 
240
 
 
241
        :param deprecation_version: something like zero_nine
 
242
        :param initial_value: The contents of the dict
 
243
        :param variable_name: This allows better warnings to be printed
 
244
        :param advice: String of advice on what callers should do instead 
 
245
            of using this variable.
 
246
        """
 
247
        self._deprecation_version = deprecation_version
 
248
        self._variable_name = variable_name
 
249
        self._advice = advice
 
250
        dict.__init__(self, initial_value)
 
251
 
 
252
    # This isn't every possible method but it should trap anyone using the
 
253
    # dict -- add more if desired
 
254
    __len__ = _dict_deprecation_wrapper(dict.__len__)
 
255
    __getitem__ = _dict_deprecation_wrapper(dict.__getitem__)
 
256
    __setitem__ = _dict_deprecation_wrapper(dict.__setitem__)
 
257
    __delitem__ = _dict_deprecation_wrapper(dict.__delitem__)
 
258
    keys = _dict_deprecation_wrapper(dict.keys)
 
259
    __contains__ = _dict_deprecation_wrapper(dict.__contains__)
 
260
 
 
261
 
 
262
def deprecated_list(deprecation_version, variable_name,
 
263
                    initial_value, extra=None):
 
264
    """Create a list that warns when modified
 
265
 
 
266
    :param deprecation_version: something like zero_nine
 
267
    :param initial_value: The contents of the list
 
268
    :param variable_name: This allows better warnings to be printed
 
269
    :param extra: Extra info to print when printing a warning
 
270
    """
 
271
 
 
272
    subst_text = 'Modifying %s' % (variable_name,)
 
273
    msg = deprecation_version % (subst_text,)
 
274
    if extra:
 
275
        msg += ' ' + extra
 
276
 
 
277
    class _DeprecatedList(list):
 
278
        __doc__ = list.__doc__ + msg
 
279
 
 
280
        is_deprecated = True
 
281
 
 
282
        def _warn_deprecated(self, func, *args, **kwargs):
 
283
            warn(msg, DeprecationWarning, stacklevel=3)
 
284
            return func(self, *args, **kwargs)
 
285
            
 
286
        def append(self, obj):
 
287
            """appending to %s is deprecated""" % (variable_name,)
 
288
            return self._warn_deprecated(list.append, obj)
 
289
 
 
290
        def insert(self, index, obj):
 
291
            """inserting to %s is deprecated""" % (variable_name,)
 
292
            return self._warn_deprecated(list.insert, index, obj)
 
293
 
 
294
        def extend(self, iterable):
 
295
            """extending %s is deprecated""" % (variable_name,)
 
296
            return self._warn_deprecated(list.extend, iterable)
 
297
 
 
298
        def remove(self, value):
 
299
            """removing from %s is deprecated""" % (variable_name,)
 
300
            return self._warn_deprecated(list.remove, value)
 
301
 
 
302
        def pop(self, index=None):
 
303
            """pop'ing from from %s is deprecated""" % (variable_name,)
 
304
            if index:
 
305
                return self._warn_deprecated(list.pop, index)
 
306
            else:
 
307
                # Can't pass None
 
308
                return self._warn_deprecated(list.pop)
 
309
 
 
310
    return _DeprecatedList(initial_value)