← 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-08-10 01:16:16 UTC
  • mto: (1904.1.2 0.9)
  • mto: This revision was merged to the branch mainline in revision 1913.
  • Revision ID: mbp@sourcefrog.net-20060810011616-d74881eba696e746
compare_trees is deprecated in 0.9 not 0.10

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
29
29
           'zero_eight',
30
30
           'zero_nine',
31
31
           'zero_ten',
32
 
           'zero_eleven',
33
 
           'zero_twelve',
34
 
           'zero_thirteen',
35
 
           'zero_fourteen',
36
 
           'zero_fifteen',
37
32
           ]
38
33
 
39
34
from warnings import warn
44
39
zero_eight = "%s was deprecated in version 0.8."
45
40
zero_nine = "%s was deprecated in version 0.9."
46
41
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."
52
42
 
53
43
 
54
44
def set_warning_method(method):
65
55
# add that on top of the primitives, once we have all three written
66
56
# - RBC 20050105
67
57
 
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
 
 
88
58
def deprecated_function(deprecation_version):
89
59
    """Decorate a function so that use of it will trigger a warning."""
90
60
 
93
63
        
94
64
        def decorated_function(*args, **kwargs):
95
65
            """This is the decorated function."""
96
 
            warn(deprecation_string(callable, deprecation_version),
97
 
                DeprecationWarning, stacklevel=2)
 
66
            symbol = "%s.%s" % (callable.__module__, 
 
67
                                callable.__name__
 
68
                                )
 
69
            warn(deprecation_version % symbol, DeprecationWarning, stacklevel=2)
98
70
            return callable(*args, **kwargs)
99
71
        _populate_decorated(callable, deprecation_version, "function",
100
72
                            decorated_function)
113
85
        
114
86
        def decorated_method(self, *args, **kwargs):
115
87
            """This is the decorated method."""
116
 
            symbol = "%s.%s.%s" % (self.__class__.__module__,
 
88
            symbol = "%s.%s.%s" % (self.__class__.__module__, 
117
89
                                   self.__class__.__name__,
118
90
                                   callable.__name__
119
91
                                   )
178
150
    decorated_callable.is_deprecated = True
179
151
 
180
152
 
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
153
def deprecated_list(deprecation_version, variable_name,
228
154
                    initial_value, extra=None):
229
155
    """Create a list that warns when modified