← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/symbol_versioning.py

  • Committer: John Arbash Meinel
  • Date: 2007-01-31 17:48:55 UTC
  • mto: This revision was merged to the branch mainline in revision 2249.
  • Revision ID: john@arbash-meinel.com-20070131174855-gxkjd9rvy17uc6ko
Switch from for line in foo: f.write(line) to f.writelines(foo)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/symbol_versioning.py
1
 
# Copyright (C) 2006 by Canonical Ltd
2
 
#   Authors: Robert Collins <robert.collins@canonical.com>
 
1
# Copyright (C) 2006, 2007 Canonical Ltd
 
2
#   Authors: Robert Collins <robert.collins@canonical.com> and others
3
3
#
4
4
# This program is free software; you can redistribute it and/or modify
5
5
# it under the terms of the GNU General Public License as published by
21
21
"""
22
22
 
23
23
__all__ = ['deprecated_function',
 
24
           'deprecated_list',
24
25
           'deprecated_method',
25
26
           'DEPRECATED_PARAMETER',
26
27
           'deprecated_passed',
27
28
           'warn', 'set_warning_method', 'zero_seven',
28
29
           'zero_eight',
 
30
           'zero_nine',
 
31
           'zero_ten',
 
32
           'zero_eleven',
 
33
           'zero_twelve',
 
34
           'zero_thirteen',
 
35
           'zero_fourteen',
 
36
           'zero_fifteen',
29
37
           ]
30
38
 
31
39
from warnings import warn
34
42
DEPRECATED_PARAMETER = "A deprecated parameter marker."
35
43
zero_seven = "%s was deprecated in version 0.7."
36
44
zero_eight = "%s was deprecated in version 0.8."
 
45
zero_nine = "%s was deprecated in version 0.9."
 
46
zero_ten = "%s was deprecated in version 0.10."
 
47
zero_eleven = "%s was deprecated in version 0.11."
 
48
zero_twelve = "%s was deprecated in version 0.12."
 
49
zero_thirteen = "%s was deprecated in version 0.13."
 
50
zero_fourteen = "%s was deprecated in version 0.14."
 
51
zero_fifteen = "%s was deprecated in version 0.15."
37
52
 
38
53
 
39
54
def set_warning_method(method):
50
65
# add that on top of the primitives, once we have all three written
51
66
# - RBC 20050105
52
67
 
 
68
 
 
69
def deprecation_string(a_callable, deprecation_version):
 
70
    """Generate an automatic deprecation string for a_callable.
 
71
 
 
72
    :param a_callable: The callable to substitute into deprecation_version.
 
73
    :param deprecation_version: A deprecation format warning string. This should
 
74
        have a single %s operator in it. a_callable will be turned into a nice
 
75
        python symbol and then substituted into deprecation_version.
 
76
    """
 
77
    if getattr(a_callable, 'im_class', None) is None:
 
78
        symbol = "%s.%s" % (a_callable.__module__,
 
79
                            a_callable.__name__)
 
80
    else:
 
81
        symbol = "%s.%s.%s" % (a_callable.im_class.__module__,
 
82
                               a_callable.im_class.__name__,
 
83
                               a_callable.__name__
 
84
                               )
 
85
    return deprecation_version % symbol
 
86
 
 
87
 
53
88
def deprecated_function(deprecation_version):
54
89
    """Decorate a function so that use of it will trigger a warning."""
55
90
 
58
93
        
59
94
        def decorated_function(*args, **kwargs):
60
95
            """This is the decorated function."""
61
 
            symbol = "%s.%s" % (callable.__module__, 
62
 
                                callable.__name__
63
 
                                )
64
 
            warn(deprecation_version % symbol, DeprecationWarning, stacklevel=2)
 
96
            warn(deprecation_string(callable, deprecation_version),
 
97
                DeprecationWarning, stacklevel=2)
65
98
            return callable(*args, **kwargs)
66
99
        _populate_decorated(callable, deprecation_version, "function",
67
100
                            decorated_function)
80
113
        
81
114
        def decorated_method(self, *args, **kwargs):
82
115
            """This is the decorated method."""
83
 
            symbol = "%s.%s.%s" % (self.__class__.__module__, 
 
116
            symbol = "%s.%s.%s" % (self.__class__.__module__,
84
117
                                   self.__class__.__name__,
85
118
                                   callable.__name__
86
119
                                   )
113
146
 
114
147
def _decorate_docstring(callable, deprecation_version, label,
115
148
                        decorated_callable):
116
 
    docstring_lines = callable.__doc__.split('\n')
 
149
    if callable.__doc__:
 
150
        docstring_lines = callable.__doc__.split('\n')
 
151
    else:
 
152
        docstring_lines = []
117
153
    if len(docstring_lines) == 0:
118
154
        decorated_callable.__doc__ = deprecation_version % ("This " + label)
119
155
    elif len(docstring_lines) == 1:
140
176
    decorated_callable.__module__ = callable.__module__
141
177
    decorated_callable.__name__ = callable.__name__
142
178
    decorated_callable.is_deprecated = True
 
179
 
 
180
 
 
181
def _dict_deprecation_wrapper(wrapped_method):
 
182
    """Returns a closure that emits a warning and calls the superclass"""
 
183
    def cb(dep_dict, *args, **kwargs):
 
184
        msg = 'access to %s' % (dep_dict._variable_name, )
 
185
        msg = dep_dict._deprecation_version % (msg,)
 
186
        if dep_dict._advice:
 
187
            msg += ' ' + dep_dict._advice
 
188
        warn(msg, DeprecationWarning, stacklevel=2)
 
189
        return wrapped_method(dep_dict, *args, **kwargs)
 
190
    return cb
 
191
 
 
192
 
 
193
class DeprecatedDict(dict):
 
194
    """A dictionary that complains when read or written."""
 
195
 
 
196
    is_deprecated = True
 
197
 
 
198
    def __init__(self,
 
199
        deprecation_version,
 
200
        variable_name,
 
201
        initial_value,
 
202
        advice,
 
203
        ):
 
204
        """Create a dict that warns when read or modified.
 
205
 
 
206
        :param deprecation_version: something like zero_nine
 
207
        :param initial_value: The contents of the dict
 
208
        :param variable_name: This allows better warnings to be printed
 
209
        :param advice: String of advice on what callers should do instead 
 
210
            of using this variable.
 
211
        """
 
212
        self._deprecation_version = deprecation_version
 
213
        self._variable_name = variable_name
 
214
        self._advice = advice
 
215
        dict.__init__(self, initial_value)
 
216
 
 
217
    # This isn't every possible method but it should trap anyone using the
 
218
    # dict -- add more if desired
 
219
    __len__ = _dict_deprecation_wrapper(dict.__len__)
 
220
    __getitem__ = _dict_deprecation_wrapper(dict.__getitem__)
 
221
    __setitem__ = _dict_deprecation_wrapper(dict.__setitem__)
 
222
    __delitem__ = _dict_deprecation_wrapper(dict.__delitem__)
 
223
    keys = _dict_deprecation_wrapper(dict.keys)
 
224
    __contains__ = _dict_deprecation_wrapper(dict.__contains__)
 
225
 
 
226
 
 
227
def deprecated_list(deprecation_version, variable_name,
 
228
                    initial_value, extra=None):
 
229
    """Create a list that warns when modified
 
230
 
 
231
    :param deprecation_version: something like zero_nine
 
232
    :param initial_value: The contents of the list
 
233
    :param variable_name: This allows better warnings to be printed
 
234
    :param extra: Extra info to print when printing a warning
 
235
    """
 
236
 
 
237
    subst_text = 'Modifying %s' % (variable_name,)
 
238
    msg = deprecation_version % (subst_text,)
 
239
    if extra:
 
240
        msg += ' ' + extra
 
241
 
 
242
    class _DeprecatedList(list):
 
243
        __doc__ = list.__doc__ + msg
 
244
 
 
245
        is_deprecated = True
 
246
 
 
247
        def _warn_deprecated(self, func, *args, **kwargs):
 
248
            warn(msg, DeprecationWarning, stacklevel=3)
 
249
            return func(self, *args, **kwargs)
 
250
            
 
251
        def append(self, obj):
 
252
            """appending to %s is deprecated""" % (variable_name,)
 
253
            return self._warn_deprecated(list.append, obj)
 
254
 
 
255
        def insert(self, index, obj):
 
256
            """inserting to %s is deprecated""" % (variable_name,)
 
257
            return self._warn_deprecated(list.insert, index, obj)
 
258
 
 
259
        def extend(self, iterable):
 
260
            """extending %s is deprecated""" % (variable_name,)
 
261
            return self._warn_deprecated(list.extend, iterable)
 
262
 
 
263
        def remove(self, value):
 
264
            """removing from %s is deprecated""" % (variable_name,)
 
265
            return self._warn_deprecated(list.remove, value)
 
266
 
 
267
        def pop(self, index=None):
 
268
            """pop'ing from from %s is deprecated""" % (variable_name,)
 
269
            if index:
 
270
                return self._warn_deprecated(list.pop, index)
 
271
            else:
 
272
                # Can't pass None
 
273
                return self._warn_deprecated(list.pop)
 
274
 
 
275
    return _DeprecatedList(initial_value)