← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/symbol_versioning.py

merge bzr.dev

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
31
31
           'zero_ten',
32
32
           'zero_eleven',
33
33
           'zero_twelve',
34
 
           'zero_thirteen',
35
 
           'zero_fourteen',
36
 
           'zero_fifteen',
37
 
           'zero_sixteen',
38
 
           'zero_seventeen',
39
34
           ]
40
35
 
41
36
from warnings import warn
48
43
zero_ten = "%s was deprecated in version 0.10."
49
44
zero_eleven = "%s was deprecated in version 0.11."
50
45
zero_twelve = "%s was deprecated in version 0.12."
51
 
zero_thirteen = "%s was deprecated in version 0.13."
52
 
zero_fourteen = "%s was deprecated in version 0.14."
53
 
zero_fifteen = "%s was deprecated in version 0.15."
54
 
zero_sixteen = "%s was deprecated in version 0.16."
55
 
zero_seventeen = "%s was deprecated in version 0.17."
56
46
 
57
47
 
58
48
def set_warning_method(method):
182
172
    decorated_callable.is_deprecated = True
183
173
 
184
174
 
185
 
def _dict_deprecation_wrapper(wrapped_method):
186
 
    """Returns a closure that emits a warning and calls the superclass"""
187
 
    def cb(dep_dict, *args, **kwargs):
188
 
        msg = 'access to %s' % (dep_dict._variable_name, )
189
 
        msg = dep_dict._deprecation_version % (msg,)
190
 
        if dep_dict._advice:
191
 
            msg += ' ' + dep_dict._advice
192
 
        warn(msg, DeprecationWarning, stacklevel=2)
193
 
        return wrapped_method(dep_dict, *args, **kwargs)
194
 
    return cb
195
 
 
196
 
 
197
 
class DeprecatedDict(dict):
198
 
    """A dictionary that complains when read or written."""
199
 
 
200
 
    is_deprecated = True
201
 
 
202
 
    def __init__(self,
203
 
        deprecation_version,
204
 
        variable_name,
205
 
        initial_value,
206
 
        advice,
207
 
        ):
208
 
        """Create a dict that warns when read or modified.
209
 
 
210
 
        :param deprecation_version: something like zero_nine
211
 
        :param initial_value: The contents of the dict
212
 
        :param variable_name: This allows better warnings to be printed
213
 
        :param advice: String of advice on what callers should do instead 
214
 
            of using this variable.
215
 
        """
216
 
        self._deprecation_version = deprecation_version
217
 
        self._variable_name = variable_name
218
 
        self._advice = advice
219
 
        dict.__init__(self, initial_value)
220
 
 
221
 
    # This isn't every possible method but it should trap anyone using the
222
 
    # dict -- add more if desired
223
 
    __len__ = _dict_deprecation_wrapper(dict.__len__)
224
 
    __getitem__ = _dict_deprecation_wrapper(dict.__getitem__)
225
 
    __setitem__ = _dict_deprecation_wrapper(dict.__setitem__)
226
 
    __delitem__ = _dict_deprecation_wrapper(dict.__delitem__)
227
 
    keys = _dict_deprecation_wrapper(dict.keys)
228
 
    __contains__ = _dict_deprecation_wrapper(dict.__contains__)
229
 
 
230
 
 
231
175
def deprecated_list(deprecation_version, variable_name,
232
176
                    initial_value, extra=None):
233
177
    """Create a list that warns when modified