← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/symbol_versioning.py

  • Committer: Alexander Belchenko
  • Date: 2006-07-30 16:43:12 UTC
  • mto: (1711.2.111 jam-integration)
  • mto: This revision was merged to the branch mainline in revision 1906.
  • Revision ID: bialix@ukr.net-20060730164312-b025fd3ff0cee59e
rename  gpl.txt => COPYING.txt

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
 
           'zero_sixteen',
38
32
           ]
39
33
 
40
34
from warnings import warn
45
39
zero_eight = "%s was deprecated in version 0.8."
46
40
zero_nine = "%s was deprecated in version 0.9."
47
41
zero_ten = "%s was deprecated in version 0.10."
48
 
zero_eleven = "%s was deprecated in version 0.11."
49
 
zero_twelve = "%s was deprecated in version 0.12."
50
 
zero_thirteen = "%s was deprecated in version 0.13."
51
 
zero_fourteen = "%s was deprecated in version 0.14."
52
 
zero_fifteen = "%s was deprecated in version 0.15."
53
 
zero_sixteen = "%s was deprecated in version 0.16."
54
42
 
55
43
 
56
44
def set_warning_method(method):
67
55
# add that on top of the primitives, once we have all three written
68
56
# - RBC 20050105
69
57
 
70
 
 
71
 
def deprecation_string(a_callable, deprecation_version):
72
 
    """Generate an automatic deprecation string for a_callable.
73
 
 
74
 
    :param a_callable: The callable to substitute into deprecation_version.
75
 
    :param deprecation_version: A deprecation format warning string. This should
76
 
        have a single %s operator in it. a_callable will be turned into a nice
77
 
        python symbol and then substituted into deprecation_version.
78
 
    """
79
 
    if getattr(a_callable, 'im_class', None) is None:
80
 
        symbol = "%s.%s" % (a_callable.__module__,
81
 
                            a_callable.__name__)
82
 
    else:
83
 
        symbol = "%s.%s.%s" % (a_callable.im_class.__module__,
84
 
                               a_callable.im_class.__name__,
85
 
                               a_callable.__name__
86
 
                               )
87
 
    return deprecation_version % symbol
88
 
 
89
 
 
90
58
def deprecated_function(deprecation_version):
91
59
    """Decorate a function so that use of it will trigger a warning."""
92
60
 
95
63
        
96
64
        def decorated_function(*args, **kwargs):
97
65
            """This is the decorated function."""
98
 
            warn(deprecation_string(callable, deprecation_version),
99
 
                DeprecationWarning, stacklevel=2)
 
66
            symbol = "%s.%s" % (callable.__module__, 
 
67
                                callable.__name__
 
68
                                )
 
69
            warn(deprecation_version % symbol, DeprecationWarning, stacklevel=2)
100
70
            return callable(*args, **kwargs)
101
71
        _populate_decorated(callable, deprecation_version, "function",
102
72
                            decorated_function)
115
85
        
116
86
        def decorated_method(self, *args, **kwargs):
117
87
            """This is the decorated method."""
118
 
            symbol = "%s.%s.%s" % (self.__class__.__module__,
 
88
            symbol = "%s.%s.%s" % (self.__class__.__module__, 
119
89
                                   self.__class__.__name__,
120
90
                                   callable.__name__
121
91
                                   )
180
150
    decorated_callable.is_deprecated = True
181
151
 
182
152
 
183
 
def _dict_deprecation_wrapper(wrapped_method):
184
 
    """Returns a closure that emits a warning and calls the superclass"""
185
 
    def cb(dep_dict, *args, **kwargs):
186
 
        msg = 'access to %s' % (dep_dict._variable_name, )
187
 
        msg = dep_dict._deprecation_version % (msg,)
188
 
        if dep_dict._advice:
189
 
            msg += ' ' + dep_dict._advice
190
 
        warn(msg, DeprecationWarning, stacklevel=2)
191
 
        return wrapped_method(dep_dict, *args, **kwargs)
192
 
    return cb
193
 
 
194
 
 
195
 
class DeprecatedDict(dict):
196
 
    """A dictionary that complains when read or written."""
197
 
 
198
 
    is_deprecated = True
199
 
 
200
 
    def __init__(self,
201
 
        deprecation_version,
202
 
        variable_name,
203
 
        initial_value,
204
 
        advice,
205
 
        ):
206
 
        """Create a dict that warns when read or modified.
207
 
 
208
 
        :param deprecation_version: something like zero_nine
209
 
        :param initial_value: The contents of the dict
210
 
        :param variable_name: This allows better warnings to be printed
211
 
        :param advice: String of advice on what callers should do instead 
212
 
            of using this variable.
213
 
        """
214
 
        self._deprecation_version = deprecation_version
215
 
        self._variable_name = variable_name
216
 
        self._advice = advice
217
 
        dict.__init__(self, initial_value)
218
 
 
219
 
    # This isn't every possible method but it should trap anyone using the
220
 
    # dict -- add more if desired
221
 
    __len__ = _dict_deprecation_wrapper(dict.__len__)
222
 
    __getitem__ = _dict_deprecation_wrapper(dict.__getitem__)
223
 
    __setitem__ = _dict_deprecation_wrapper(dict.__setitem__)
224
 
    __delitem__ = _dict_deprecation_wrapper(dict.__delitem__)
225
 
    keys = _dict_deprecation_wrapper(dict.keys)
226
 
    __contains__ = _dict_deprecation_wrapper(dict.__contains__)
227
 
 
228
 
 
229
153
def deprecated_list(deprecation_version, variable_name,
230
154
                    initial_value, extra=None):
231
155
    """Create a list that warns when modified