← 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-21 12:26:54 UTC
  • mto: This revision was merged to the branch mainline in revision 1621.
  • Revision ID: mbp@sourcefrog.net-20060321122654-514047ed65795a17
New developer commands 'weave-list' and 'weave-join'.

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