← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/symbol_versioning.py

  • Committer: Robert Collins
  • Date: 2007-07-04 08:08:13 UTC
  • mfrom: (2572 +trunk)
  • mto: This revision was merged to the branch mainline in revision 2587.
  • Revision ID: robertc@robertcollins.net-20070704080813-wzebx0r88fvwj5rq
Merge bzr.dev.

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
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
           'zero_eighteen',
34
40
           ]
35
41
 
36
42
from warnings import warn
43
49
zero_ten = "%s was deprecated in version 0.10."
44
50
zero_eleven = "%s was deprecated in version 0.11."
45
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."
46
58
 
47
59
 
48
60
def set_warning_method(method):
172
184
    decorated_callable.is_deprecated = True
173
185
 
174
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
 
175
233
def deprecated_list(deprecation_version, variable_name,
176
234
                    initial_value, extra=None):
177
235
    """Create a list that warns when modified