← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/symbol_versioning.py

  • Committer: Martin Pool
  • Date: 2006-03-23 19:00:53 UTC
  • mto: This revision was merged to the branch mainline in revision 1626.
  • Revision ID: mbp@sourcefrog.net-20060323190053-ac6b735ff74f56d7
Handle 'bzr ?', etc.

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