← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/symbol_versioning.py

  • Committer: John Arbash Meinel
  • Date: 2006-10-11 00:23:23 UTC
  • mfrom: (2070 +trunk)
  • mto: This revision was merged to the branch mainline in revision 2071.
  • Revision ID: john@arbash-meinel.com-20061011002323-82ba88c293d7caff
[merge] bzr.dev 2070

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/symbol_versioning.py
21
21
"""
22
22
 
23
23
__all__ = ['deprecated_function',
 
24
           'deprecated_list',
24
25
           'deprecated_method',
25
26
           'DEPRECATED_PARAMETER',
26
27
           'deprecated_passed',
27
28
           'warn', 'set_warning_method', 'zero_seven',
28
29
           'zero_eight',
29
30
           'zero_nine',
 
31
           'zero_ten',
 
32
           'zero_eleven',
 
33
           'zero_twelve',
30
34
           ]
31
35
 
32
36
from warnings import warn
36
40
zero_seven = "%s was deprecated in version 0.7."
37
41
zero_eight = "%s was deprecated in version 0.8."
38
42
zero_nine = "%s was deprecated in version 0.9."
 
43
zero_ten = "%s was deprecated in version 0.10."
 
44
zero_eleven = "%s was deprecated in version 0.11."
 
45
zero_twelve = "%s was deprecated in version 0.12."
39
46
 
40
47
 
41
48
def set_warning_method(method):
52
59
# add that on top of the primitives, once we have all three written
53
60
# - RBC 20050105
54
61
 
 
62
 
 
63
def deprecation_string(a_callable, deprecation_version):
 
64
    """Generate an automatic deprecation string for a_callable.
 
65
 
 
66
    :param a_callable: The callable to substitute into deprecation_version.
 
67
    :param deprecation_version: A deprecation format warning string. This should
 
68
        have a single %s operator in it. a_callable will be turned into a nice
 
69
        python symbol and then substituted into deprecation_version.
 
70
    """
 
71
    if getattr(a_callable, 'im_class', None) is None:
 
72
        symbol = "%s.%s" % (a_callable.__module__,
 
73
                            a_callable.__name__)
 
74
    else:
 
75
        symbol = "%s.%s.%s" % (a_callable.im_class.__module__,
 
76
                               a_callable.im_class.__name__,
 
77
                               a_callable.__name__
 
78
                               )
 
79
    return deprecation_version % symbol
 
80
 
 
81
 
55
82
def deprecated_function(deprecation_version):
56
83
    """Decorate a function so that use of it will trigger a warning."""
57
84
 
60
87
        
61
88
        def decorated_function(*args, **kwargs):
62
89
            """This is the decorated function."""
63
 
            symbol = "%s.%s" % (callable.__module__, 
64
 
                                callable.__name__
65
 
                                )
66
 
            warn(deprecation_version % symbol, DeprecationWarning, stacklevel=2)
 
90
            warn(deprecation_string(callable, deprecation_version),
 
91
                DeprecationWarning, stacklevel=2)
67
92
            return callable(*args, **kwargs)
68
93
        _populate_decorated(callable, deprecation_version, "function",
69
94
                            decorated_function)
82
107
        
83
108
        def decorated_method(self, *args, **kwargs):
84
109
            """This is the decorated method."""
85
 
            symbol = "%s.%s.%s" % (self.__class__.__module__, 
 
110
            symbol = "%s.%s.%s" % (self.__class__.__module__,
86
111
                                   self.__class__.__name__,
87
112
                                   callable.__name__
88
113
                                   )
145
170
    decorated_callable.__module__ = callable.__module__
146
171
    decorated_callable.__name__ = callable.__name__
147
172
    decorated_callable.is_deprecated = True
 
173
 
 
174
 
 
175
def deprecated_list(deprecation_version, variable_name,
 
176
                    initial_value, extra=None):
 
177
    """Create a list that warns when modified
 
178
 
 
179
    :param deprecation_version: something like zero_nine
 
180
    :param initial_value: The contents of the list
 
181
    :param variable_name: This allows better warnings to be printed
 
182
    :param extra: Extra info to print when printing a warning
 
183
    """
 
184
 
 
185
    subst_text = 'Modifying %s' % (variable_name,)
 
186
    msg = deprecation_version % (subst_text,)
 
187
    if extra:
 
188
        msg += ' ' + extra
 
189
 
 
190
    class _DeprecatedList(list):
 
191
        __doc__ = list.__doc__ + msg
 
192
 
 
193
        is_deprecated = True
 
194
 
 
195
        def _warn_deprecated(self, func, *args, **kwargs):
 
196
            warn(msg, DeprecationWarning, stacklevel=3)
 
197
            return func(self, *args, **kwargs)
 
198
            
 
199
        def append(self, obj):
 
200
            """appending to %s is deprecated""" % (variable_name,)
 
201
            return self._warn_deprecated(list.append, obj)
 
202
 
 
203
        def insert(self, index, obj):
 
204
            """inserting to %s is deprecated""" % (variable_name,)
 
205
            return self._warn_deprecated(list.insert, index, obj)
 
206
 
 
207
        def extend(self, iterable):
 
208
            """extending %s is deprecated""" % (variable_name,)
 
209
            return self._warn_deprecated(list.extend, iterable)
 
210
 
 
211
        def remove(self, value):
 
212
            """removing from %s is deprecated""" % (variable_name,)
 
213
            return self._warn_deprecated(list.remove, value)
 
214
 
 
215
        def pop(self, index=None):
 
216
            """pop'ing from from %s is deprecated""" % (variable_name,)
 
217
            if index:
 
218
                return self._warn_deprecated(list.pop, index)
 
219
            else:
 
220
                # Can't pass None
 
221
                return self._warn_deprecated(list.pop)
 
222
 
 
223
    return _DeprecatedList(initial_value)