1
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
2
# Authors: Robert Collins <robert.collins@canonical.com> and others
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.
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.
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
20
The methods here allow for api symbol versioning.
23
__all__ = ['deprecated_function',
27
'DEPRECATED_PARAMETER',
29
'warn', 'set_warning_method', 'zero_seven',
53
from warnings import warn
58
DEPRECATED_PARAMETER = "A deprecated parameter marker."
59
zero_seven = "%s was deprecated in version 0.7."
60
zero_eight = "%s was deprecated in version 0.8."
61
zero_nine = "%s was deprecated in version 0.9."
62
zero_ten = "%s was deprecated in version 0.10."
63
zero_eleven = "%s was deprecated in version 0.11."
64
zero_twelve = "%s was deprecated in version 0.12."
65
zero_thirteen = "%s was deprecated in version 0.13."
66
zero_fourteen = "%s was deprecated in version 0.14."
67
zero_fifteen = "%s was deprecated in version 0.15."
68
zero_sixteen = "%s was deprecated in version 0.16."
69
zero_seventeen = "%s was deprecated in version 0.17."
70
zero_eighteen = "%s was deprecated in version 0.18."
71
zero_ninety = "%s was deprecated in version 0.90."
72
zero_ninetyone = "%s was deprecated in version 0.91."
73
zero_ninetytwo = "%s was deprecated in version 0.92."
74
one_zero = "%s was deprecated in version 1.0."
75
zero_ninetythree = one_zero # Maintained for backwards compatibility
76
one_one = "%s was deprecated in version 1.1."
77
one_two = "%s was deprecated in version 1.2."
78
one_three = "%s was deprecated in version 1.3."
79
one_four = "%s was deprecated in version 1.4."
80
one_five = "%s was deprecated in version 1.5."
83
def deprecated_in(version_tuple):
84
"""Generate a message that something was deprecated in a release.
86
>>> deprecated_in((1, 4, 0))
87
'%s was deprecated in version 1.4'
89
return ("%s was deprecated in version "
90
+ bzrlib._format_version_tuple(version_tuple))
92
def set_warning_method(method):
93
"""Set the warning method to be used by this module.
95
It should take a message and a warning category as warnings.warn does.
101
# TODO - maybe this would be easier to use as one 'smart' method that
102
# guess if it is a method or a class or an attribute ? If so, we can
103
# add that on top of the primitives, once we have all three written
107
def deprecation_string(a_callable, deprecation_version):
108
"""Generate an automatic deprecation string for a_callable.
110
:param a_callable: The callable to substitute into deprecation_version.
111
:param deprecation_version: A deprecation format warning string. This should
112
have a single %s operator in it. a_callable will be turned into a nice
113
python symbol and then substituted into deprecation_version.
115
# We also want to handle old-style classes, in particular exception, and
116
# they don't have an im_class attribute.
117
if getattr(a_callable, 'im_class', None) is None:
118
symbol = "%s.%s" % (a_callable.__module__,
121
symbol = "%s.%s.%s" % (a_callable.im_class.__module__,
122
a_callable.im_class.__name__,
125
return deprecation_version % symbol
128
def deprecated_function(deprecation_version):
129
"""Decorate a function so that use of it will trigger a warning."""
131
def function_decorator(callable):
132
"""This is the function python calls to perform the decoration."""
134
def decorated_function(*args, **kwargs):
135
"""This is the decorated function."""
136
warn(deprecation_string(callable, deprecation_version),
137
DeprecationWarning, stacklevel=2)
138
return callable(*args, **kwargs)
139
_populate_decorated(callable, deprecation_version, "function",
141
return decorated_function
142
return function_decorator
145
def deprecated_method(deprecation_version):
146
"""Decorate a method so that use of it will trigger a warning.
148
To deprecate a static or class method, use
154
To deprecate an entire class, decorate __init__.
157
def method_decorator(callable):
158
"""This is the function python calls to perform the decoration."""
160
def decorated_method(self, *args, **kwargs):
161
"""This is the decorated method."""
162
if callable.__name__ == '__init__':
163
symbol = "%s.%s" % (self.__class__.__module__,
164
self.__class__.__name__,
167
symbol = "%s.%s.%s" % (self.__class__.__module__,
168
self.__class__.__name__,
171
warn(deprecation_version % symbol, DeprecationWarning, stacklevel=2)
172
return callable(self, *args, **kwargs)
173
_populate_decorated(callable, deprecation_version, "method",
175
return decorated_method
176
return method_decorator
179
def deprecated_passed(parameter_value):
180
"""Return True if parameter_value was used."""
181
# FIXME: it might be nice to have a parameter deprecation decorator.
182
# it would need to handle positional and *args and **kwargs parameters,
183
# which means some mechanism to describe how the parameter was being
184
# passed before deprecation, and some way to deprecate parameters that
185
# were not at the end of the arg list. Thats needed for __init__ where
186
# we cannot just forward to a new method name.I.e. in the following
187
# examples we would want to have callers that pass any value to 'bad' be
188
# given a warning - because we have applied:
189
# @deprecated_parameter('bad', zero_seven)
191
# def __init__(self, bad=None)
192
# def __init__(self, bad, other)
193
# def __init__(self, **kwargs)
195
return not parameter_value is DEPRECATED_PARAMETER
198
def _decorate_docstring(callable, deprecation_version, label,
201
docstring_lines = callable.__doc__.split('\n')
204
if len(docstring_lines) == 0:
205
decorated_callable.__doc__ = deprecation_version % ("This " + label)
206
elif len(docstring_lines) == 1:
207
decorated_callable.__doc__ = (callable.__doc__
210
+ deprecation_version % ("This " + label)
213
spaces = len(docstring_lines[-1])
214
new_doc = callable.__doc__
215
new_doc += "\n" + " " * spaces
216
new_doc += deprecation_version % ("This " + label)
217
new_doc += "\n" + " " * spaces
218
decorated_callable.__doc__ = new_doc
221
def _populate_decorated(callable, deprecation_version, label,
223
"""Populate attributes like __name__ and __doc__ on the decorated callable.
225
_decorate_docstring(callable, deprecation_version, label,
227
decorated_callable.__module__ = callable.__module__
228
decorated_callable.__name__ = callable.__name__
229
decorated_callable.is_deprecated = True
232
def _dict_deprecation_wrapper(wrapped_method):
233
"""Returns a closure that emits a warning and calls the superclass"""
234
def cb(dep_dict, *args, **kwargs):
235
msg = 'access to %s' % (dep_dict._variable_name, )
236
msg = dep_dict._deprecation_version % (msg,)
238
msg += ' ' + dep_dict._advice
239
warn(msg, DeprecationWarning, stacklevel=2)
240
return wrapped_method(dep_dict, *args, **kwargs)
244
class DeprecatedDict(dict):
245
"""A dictionary that complains when read or written."""
255
"""Create a dict that warns when read or modified.
257
:param deprecation_version: something like zero_nine
258
:param initial_value: The contents of the dict
259
:param variable_name: This allows better warnings to be printed
260
:param advice: String of advice on what callers should do instead
261
of using this variable.
263
self._deprecation_version = deprecation_version
264
self._variable_name = variable_name
265
self._advice = advice
266
dict.__init__(self, initial_value)
268
# This isn't every possible method but it should trap anyone using the
269
# dict -- add more if desired
270
__len__ = _dict_deprecation_wrapper(dict.__len__)
271
__getitem__ = _dict_deprecation_wrapper(dict.__getitem__)
272
__setitem__ = _dict_deprecation_wrapper(dict.__setitem__)
273
__delitem__ = _dict_deprecation_wrapper(dict.__delitem__)
274
keys = _dict_deprecation_wrapper(dict.keys)
275
__contains__ = _dict_deprecation_wrapper(dict.__contains__)
278
def deprecated_list(deprecation_version, variable_name,
279
initial_value, extra=None):
280
"""Create a list that warns when modified
282
:param deprecation_version: something like zero_nine
283
:param initial_value: The contents of the list
284
:param variable_name: This allows better warnings to be printed
285
:param extra: Extra info to print when printing a warning
288
subst_text = 'Modifying %s' % (variable_name,)
289
msg = deprecation_version % (subst_text,)
293
class _DeprecatedList(list):
294
__doc__ = list.__doc__ + msg
298
def _warn_deprecated(self, func, *args, **kwargs):
299
warn(msg, DeprecationWarning, stacklevel=3)
300
return func(self, *args, **kwargs)
302
def append(self, obj):
303
"""appending to %s is deprecated""" % (variable_name,)
304
return self._warn_deprecated(list.append, obj)
306
def insert(self, index, obj):
307
"""inserting to %s is deprecated""" % (variable_name,)
308
return self._warn_deprecated(list.insert, index, obj)
310
def extend(self, iterable):
311
"""extending %s is deprecated""" % (variable_name,)
312
return self._warn_deprecated(list.extend, iterable)
314
def remove(self, value):
315
"""removing from %s is deprecated""" % (variable_name,)
316
return self._warn_deprecated(list.remove, value)
318
def pop(self, index=None):
319
"""pop'ing from from %s is deprecated""" % (variable_name,)
321
return self._warn_deprecated(list.pop, index)
324
return self._warn_deprecated(list.pop)
326
return _DeprecatedList(initial_value)
added
removed
bzrlib/symbol_versioning.py
