/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

  • Committer: Lukáš Lalinský
  • Date: 2007-11-10 11:25:36 UTC
  • mto: This revision was merged to the branch mainline in revision 3123.
  • Revision ID: lalinsky@gmail.com-20071110112536-48wqnw88fdmiorww
Fix problems from Alexander's review.

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