← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/symbol_versioning.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2006-08-17 07:52:09 UTC
  • mfrom: (1910.3.4 trivial)
  • Revision ID: pqm@pqm.ubuntu.com-20060817075209-e85a1f9e05ff8b87
(andrew) Trivial fixes to NotImplemented errors.

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
 
           'zero_seventeen',
39
 
           'zero_eighteen',
40
 
           'zero_ninety',
41
 
           'zero_ninetyone',
42
 
           'zero_ninetytwo',
43
32
           ]
44
33
 
45
34
from warnings import warn
50
39
zero_eight = "%s was deprecated in version 0.8."
51
40
zero_nine = "%s was deprecated in version 0.9."
52
41
zero_ten = "%s was deprecated in version 0.10."
53
 
zero_eleven = "%s was deprecated in version 0.11."
54
 
zero_twelve = "%s was deprecated in version 0.12."
55
 
zero_thirteen = "%s was deprecated in version 0.13."
56
 
zero_fourteen = "%s was deprecated in version 0.14."
57
 
zero_fifteen = "%s was deprecated in version 0.15."
58
 
zero_sixteen = "%s was deprecated in version 0.16."
59
 
zero_seventeen = "%s was deprecated in version 0.17."
60
 
zero_eighteen = "%s was deprecated in version 0.18."
61
 
zero_ninety = "%s was deprecated in version 0.90."
62
 
zero_ninetyone = "%s was deprecated in version 0.91."
63
 
zero_ninetytwo = "%s was deprecated in version 0.92."
64
42
 
65
43
 
66
44
def set_warning_method(method):
77
55
# add that on top of the primitives, once we have all three written
78
56
# - RBC 20050105
79
57
 
80
 
 
81
 
def deprecation_string(a_callable, deprecation_version):
82
 
    """Generate an automatic deprecation string for a_callable.
83
 
 
84
 
    :param a_callable: The callable to substitute into deprecation_version.
85
 
    :param deprecation_version: A deprecation format warning string. This should
86
 
        have a single %s operator in it. a_callable will be turned into a nice
87
 
        python symbol and then substituted into deprecation_version.
88
 
    """
89
 
    # We also want to handle old-style classes, in particular exception, and
90
 
    # they don't have an im_class attribute.
91
 
    if getattr(a_callable, 'im_class', None) is None:
92
 
        symbol = "%s.%s" % (a_callable.__module__,
93
 
                            a_callable.__name__)
94
 
    else:
95
 
        symbol = "%s.%s.%s" % (a_callable.im_class.__module__,
96
 
                               a_callable.im_class.__name__,
97
 
                               a_callable.__name__
98
 
                               )
99
 
    return deprecation_version % symbol
100
 
 
101
 
 
102
58
def deprecated_function(deprecation_version):
103
59
    """Decorate a function so that use of it will trigger a warning."""
104
60
 
107
63
        
108
64
        def decorated_function(*args, **kwargs):
109
65
            """This is the decorated function."""
110
 
            warn(deprecation_string(callable, deprecation_version),
111
 
                DeprecationWarning, stacklevel=2)
 
66
            symbol = "%s.%s" % (callable.__module__, 
 
67
                                callable.__name__
 
68
                                )
 
69
            warn(deprecation_version % symbol, DeprecationWarning, stacklevel=2)
112
70
            return callable(*args, **kwargs)
113
71
        _populate_decorated(callable, deprecation_version, "function",
114
72
                            decorated_function)
118
76
 
119
77
def deprecated_method(deprecation_version):
120
78
    """Decorate a method so that use of it will trigger a warning.
121
 
 
122
 
    To deprecate a static or class method, use 
123
 
 
124
 
        @staticmethod
125
 
        @deprecated_function
126
 
        def ...
127
79
    
128
80
    To deprecate an entire class, decorate __init__.
129
81
    """
133
85
        
134
86
        def decorated_method(self, *args, **kwargs):
135
87
            """This is the decorated method."""
136
 
            if callable.__name__ == '__init__':
137
 
                symbol = "%s.%s" % (self.__class__.__module__,
138
 
                                    self.__class__.__name__,
139
 
                                    )
140
 
            else:
141
 
                symbol = "%s.%s.%s" % (self.__class__.__module__,
142
 
                                       self.__class__.__name__,
143
 
                                       callable.__name__
144
 
                                       )
 
88
            symbol = "%s.%s.%s" % (self.__class__.__module__, 
 
89
                                   self.__class__.__name__,
 
90
                                   callable.__name__
 
91
                                   )
145
92
            warn(deprecation_version % symbol, DeprecationWarning, stacklevel=2)
146
93
            return callable(self, *args, **kwargs)
147
94
        _populate_decorated(callable, deprecation_version, "method",
203
150
    decorated_callable.is_deprecated = True
204
151
 
205
152
 
206
 
def _dict_deprecation_wrapper(wrapped_method):
207
 
    """Returns a closure that emits a warning and calls the superclass"""
208
 
    def cb(dep_dict, *args, **kwargs):
209
 
        msg = 'access to %s' % (dep_dict._variable_name, )
210
 
        msg = dep_dict._deprecation_version % (msg,)
211
 
        if dep_dict._advice:
212
 
            msg += ' ' + dep_dict._advice
213
 
        warn(msg, DeprecationWarning, stacklevel=2)
214
 
        return wrapped_method(dep_dict, *args, **kwargs)
215
 
    return cb
216
 
 
217
 
 
218
 
class DeprecatedDict(dict):
219
 
    """A dictionary that complains when read or written."""
220
 
 
221
 
    is_deprecated = True
222
 
 
223
 
    def __init__(self,
224
 
        deprecation_version,
225
 
        variable_name,
226
 
        initial_value,
227
 
        advice,
228
 
        ):
229
 
        """Create a dict that warns when read or modified.
230
 
 
231
 
        :param deprecation_version: something like zero_nine
232
 
        :param initial_value: The contents of the dict
233
 
        :param variable_name: This allows better warnings to be printed
234
 
        :param advice: String of advice on what callers should do instead 
235
 
            of using this variable.
236
 
        """
237
 
        self._deprecation_version = deprecation_version
238
 
        self._variable_name = variable_name
239
 
        self._advice = advice
240
 
        dict.__init__(self, initial_value)
241
 
 
242
 
    # This isn't every possible method but it should trap anyone using the
243
 
    # dict -- add more if desired
244
 
    __len__ = _dict_deprecation_wrapper(dict.__len__)
245
 
    __getitem__ = _dict_deprecation_wrapper(dict.__getitem__)
246
 
    __setitem__ = _dict_deprecation_wrapper(dict.__setitem__)
247
 
    __delitem__ = _dict_deprecation_wrapper(dict.__delitem__)
248
 
    keys = _dict_deprecation_wrapper(dict.keys)
249
 
    __contains__ = _dict_deprecation_wrapper(dict.__contains__)
250
 
 
251
 
 
252
153
def deprecated_list(deprecation_version, variable_name,
253
154
                    initial_value, extra=None):
254
155
    """Create a list that warns when modified