~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/symbol_versioning.py

  • Committer: Martin Pool
  • Date: 2005-06-27 08:18:07 UTC
  • mto: This revision was merged to the branch mainline in revision 852.
  • Revision ID: mbp@sourcefrog.net-20050627081807-dc3ff5726c88b247
More tests for insertion of lines in new versions.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006 Canonical Ltd
2
 
#   Authors: Robert Collins <robert.collins@canonical.com>
3
 
#
4
 
# This program is free software; you can redistribute it and/or modify
5
 
# it under the terms of the GNU General Public License as published by
6
 
# the Free Software Foundation; either version 2 of the License, or
7
 
# (at your option) any later version.
8
 
#
9
 
# This program is distributed in the hope that it will be useful,
10
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12
 
# GNU General Public License for more details.
13
 
#
14
 
# You should have received a copy of the GNU General Public License
15
 
# along with this program; if not, write to the Free Software
16
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17
 
 
18
 
"""Symbol versioning
19
 
 
20
 
The methods here allow for api symbol versioning.
21
 
"""
22
 
 
23
 
__all__ = ['deprecated_function',
24
 
           'deprecated_list',
25
 
           'deprecated_method',
26
 
           'DEPRECATED_PARAMETER',
27
 
           'deprecated_passed',
28
 
           'warn', 'set_warning_method', 'zero_seven',
29
 
           'zero_eight',
30
 
           'zero_nine',
31
 
           'zero_ten',
32
 
           'zero_eleven',
33
 
           'zero_twelve',
34
 
           'zero_thirteen',
35
 
           'zero_fourteen',
36
 
           ]
37
 
 
38
 
from warnings import warn
39
 
 
40
 
 
41
 
DEPRECATED_PARAMETER = "A deprecated parameter marker."
42
 
zero_seven = "%s was deprecated in version 0.7."
43
 
zero_eight = "%s was deprecated in version 0.8."
44
 
zero_nine = "%s was deprecated in version 0.9."
45
 
zero_ten = "%s was deprecated in version 0.10."
46
 
zero_eleven = "%s was deprecated in version 0.11."
47
 
zero_twelve = "%s was deprecated in version 0.12."
48
 
zero_thirteen = "%s was deprecated in version 0.13."
49
 
zero_fourteen = "%s was deprecated in version 0.14."
50
 
 
51
 
 
52
 
def set_warning_method(method):
53
 
    """Set the warning method to be used by this module.
54
 
 
55
 
    It should take a message and a warning category as warnings.warn does.
56
 
    """
57
 
    global warn
58
 
    warn = method
59
 
 
60
 
 
61
 
# TODO - maybe this would be easier to use as one 'smart' method that
62
 
# guess if it is a method or a class or an attribute ? If so, we can
63
 
# add that on top of the primitives, once we have all three written
64
 
# - RBC 20050105
65
 
 
66
 
 
67
 
def deprecation_string(a_callable, deprecation_version):
68
 
    """Generate an automatic deprecation string for a_callable.
69
 
 
70
 
    :param a_callable: The callable to substitute into deprecation_version.
71
 
    :param deprecation_version: A deprecation format warning string. This should
72
 
        have a single %s operator in it. a_callable will be turned into a nice
73
 
        python symbol and then substituted into deprecation_version.
74
 
    """
75
 
    if getattr(a_callable, 'im_class', None) is None:
76
 
        symbol = "%s.%s" % (a_callable.__module__,
77
 
                            a_callable.__name__)
78
 
    else:
79
 
        symbol = "%s.%s.%s" % (a_callable.im_class.__module__,
80
 
                               a_callable.im_class.__name__,
81
 
                               a_callable.__name__
82
 
                               )
83
 
    return deprecation_version % symbol
84
 
 
85
 
 
86
 
def deprecated_function(deprecation_version):
87
 
    """Decorate a function so that use of it will trigger a warning."""
88
 
 
89
 
    def function_decorator(callable):
90
 
        """This is the function python calls to perform the decoration."""
91
 
        
92
 
        def decorated_function(*args, **kwargs):
93
 
            """This is the decorated function."""
94
 
            warn(deprecation_string(callable, deprecation_version),
95
 
                DeprecationWarning, stacklevel=2)
96
 
            return callable(*args, **kwargs)
97
 
        _populate_decorated(callable, deprecation_version, "function",
98
 
                            decorated_function)
99
 
        return decorated_function
100
 
    return function_decorator
101
 
 
102
 
 
103
 
def deprecated_method(deprecation_version):
104
 
    """Decorate a method so that use of it will trigger a warning.
105
 
    
106
 
    To deprecate an entire class, decorate __init__.
107
 
    """
108
 
 
109
 
    def method_decorator(callable):
110
 
        """This is the function python calls to perform the decoration."""
111
 
        
112
 
        def decorated_method(self, *args, **kwargs):
113
 
            """This is the decorated method."""
114
 
            symbol = "%s.%s.%s" % (self.__class__.__module__,
115
 
                                   self.__class__.__name__,
116
 
                                   callable.__name__
117
 
                                   )
118
 
            warn(deprecation_version % symbol, DeprecationWarning, stacklevel=2)
119
 
            return callable(self, *args, **kwargs)
120
 
        _populate_decorated(callable, deprecation_version, "method",
121
 
                            decorated_method)
122
 
        return decorated_method
123
 
    return method_decorator
124
 
 
125
 
 
126
 
def deprecated_passed(parameter_value):
127
 
    """Return True if parameter_value was used."""
128
 
    # FIXME: it might be nice to have a parameter deprecation decorator. 
129
 
    # it would need to handle positional and *args and **kwargs parameters,
130
 
    # which means some mechanism to describe how the parameter was being
131
 
    # passed before deprecation, and some way to deprecate parameters that
132
 
    # were not at the end of the arg list. Thats needed for __init__ where
133
 
    # we cannot just forward to a new method name.I.e. in the following
134
 
    # examples we would want to have callers that pass any value to 'bad' be
135
 
    # given a warning - because we have applied:
136
 
    # @deprecated_parameter('bad', zero_seven)
137
 
    #
138
 
    # def __init__(self, bad=None)
139
 
    # def __init__(self, bad, other)
140
 
    # def __init__(self, **kwargs)
141
 
    # RBC 20060116
142
 
    return not parameter_value is DEPRECATED_PARAMETER
143
 
 
144
 
 
145
 
def _decorate_docstring(callable, deprecation_version, label,
146
 
                        decorated_callable):
147
 
    if callable.__doc__:
148
 
        docstring_lines = callable.__doc__.split('\n')
149
 
    else:
150
 
        docstring_lines = []
151
 
    if len(docstring_lines) == 0:
152
 
        decorated_callable.__doc__ = deprecation_version % ("This " + label)
153
 
    elif len(docstring_lines) == 1:
154
 
        decorated_callable.__doc__ = (callable.__doc__ 
155
 
                                    + "\n"
156
 
                                    + "\n"
157
 
                                    + deprecation_version % ("This " + label)
158
 
                                    + "\n")
159
 
    else:
160
 
        spaces = len(docstring_lines[-1])
161
 
        new_doc = callable.__doc__
162
 
        new_doc += "\n" + " " * spaces
163
 
        new_doc += deprecation_version % ("This " + label)
164
 
        new_doc += "\n" + " " * spaces
165
 
        decorated_callable.__doc__ = new_doc
166
 
 
167
 
 
168
 
def _populate_decorated(callable, deprecation_version, label,
169
 
                        decorated_callable):
170
 
    """Populate attributes like __name__ and __doc__ on the decorated callable.
171
 
    """
172
 
    _decorate_docstring(callable, deprecation_version, label,
173
 
                        decorated_callable)
174
 
    decorated_callable.__module__ = callable.__module__
175
 
    decorated_callable.__name__ = callable.__name__
176
 
    decorated_callable.is_deprecated = True
177
 
 
178
 
 
179
 
def deprecated_list(deprecation_version, variable_name,
180
 
                    initial_value, extra=None):
181
 
    """Create a list that warns when modified
182
 
 
183
 
    :param deprecation_version: something like zero_nine
184
 
    :param initial_value: The contents of the list
185
 
    :param variable_name: This allows better warnings to be printed
186
 
    :param extra: Extra info to print when printing a warning
187
 
    """
188
 
 
189
 
    subst_text = 'Modifying %s' % (variable_name,)
190
 
    msg = deprecation_version % (subst_text,)
191
 
    if extra:
192
 
        msg += ' ' + extra
193
 
 
194
 
    class _DeprecatedList(list):
195
 
        __doc__ = list.__doc__ + msg
196
 
 
197
 
        is_deprecated = True
198
 
 
199
 
        def _warn_deprecated(self, func, *args, **kwargs):
200
 
            warn(msg, DeprecationWarning, stacklevel=3)
201
 
            return func(self, *args, **kwargs)
202
 
            
203
 
        def append(self, obj):
204
 
            """appending to %s is deprecated""" % (variable_name,)
205
 
            return self._warn_deprecated(list.append, obj)
206
 
 
207
 
        def insert(self, index, obj):
208
 
            """inserting to %s is deprecated""" % (variable_name,)
209
 
            return self._warn_deprecated(list.insert, index, obj)
210
 
 
211
 
        def extend(self, iterable):
212
 
            """extending %s is deprecated""" % (variable_name,)
213
 
            return self._warn_deprecated(list.extend, iterable)
214
 
 
215
 
        def remove(self, value):
216
 
            """removing from %s is deprecated""" % (variable_name,)
217
 
            return self._warn_deprecated(list.remove, value)
218
 
 
219
 
        def pop(self, index=None):
220
 
            """pop'ing from from %s is deprecated""" % (variable_name,)
221
 
            if index:
222
 
                return self._warn_deprecated(list.pop, index)
223
 
            else:
224
 
                # Can't pass None
225
 
                return self._warn_deprecated(list.pop)
226
 
 
227
 
    return _DeprecatedList(initial_value)