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',
26
'DEPRECATED_PARAMETER',
28
'warn', 'set_warning_method', 'zero_seven',
52
from warnings import warn
55
DEPRECATED_PARAMETER = "A deprecated parameter marker."
56
zero_seven = "%s was deprecated in version 0.7."
57
zero_eight = "%s was deprecated in version 0.8."
58
zero_nine = "%s was deprecated in version 0.9."
59
zero_ten = "%s was deprecated in version 0.10."
60
zero_eleven = "%s was deprecated in version 0.11."
61
zero_twelve = "%s was deprecated in version 0.12."
62
zero_thirteen = "%s was deprecated in version 0.13."
63
zero_fourteen = "%s was deprecated in version 0.14."
64
zero_fifteen = "%s was deprecated in version 0.15."
65
zero_sixteen = "%s was deprecated in version 0.16."
66
zero_seventeen = "%s was deprecated in version 0.17."
67
zero_eighteen = "%s was deprecated in version 0.18."
68
zero_ninety = "%s was deprecated in version 0.90."
69
zero_ninetyone = "%s was deprecated in version 0.91."
70
zero_ninetytwo = "%s was deprecated in version 0.92."
71
one_zero = "%s was deprecated in version 1.0."
72
zero_ninetythree = one_zero # Maintained for backwards compatibility
73
one_one = "%s was deprecated in version 1.1."
74
one_two = "%s was deprecated in version 1.2."
75
one_three = "%s was deprecated in version 1.3."
76
one_four = "%s was deprecated in version 1.4."
77
one_five = "%s was deprecated in version 1.5."
79
def set_warning_method(method):
80
"""Set the warning method to be used by this module.
82
It should take a message and a warning category as warnings.warn does.
88
# TODO - maybe this would be easier to use as one 'smart' method that
89
# guess if it is a method or a class or an attribute ? If so, we can
90
# add that on top of the primitives, once we have all three written
94
def deprecation_string(a_callable, deprecation_version):
95
"""Generate an automatic deprecation string for a_callable.
97
:param a_callable: The callable to substitute into deprecation_version.
98
:param deprecation_version: A deprecation format warning string. This should
99
have a single %s operator in it. a_callable will be turned into a nice
100
python symbol and then substituted into deprecation_version.
102
# We also want to handle old-style classes, in particular exception, and
103
# they don't have an im_class attribute.
104
if getattr(a_callable, 'im_class', None) is None:
105
symbol = "%s.%s" % (a_callable.__module__,
108
symbol = "%s.%s.%s" % (a_callable.im_class.__module__,
109
a_callable.im_class.__name__,
112
return deprecation_version % symbol
115
def deprecated_function(deprecation_version):
116
"""Decorate a function so that use of it will trigger a warning."""
118
def function_decorator(callable):
119
"""This is the function python calls to perform the decoration."""
121
def decorated_function(*args, **kwargs):
122
"""This is the decorated function."""
123
warn(deprecation_string(callable, deprecation_version),
124
DeprecationWarning, stacklevel=2)
125
return callable(*args, **kwargs)
126
_populate_decorated(callable, deprecation_version, "function",
128
return decorated_function
129
return function_decorator
132
def deprecated_method(deprecation_version):
133
"""Decorate a method so that use of it will trigger a warning.
135
To deprecate a static or class method, use
141
To deprecate an entire class, decorate __init__.
144
def method_decorator(callable):
145
"""This is the function python calls to perform the decoration."""
147
def decorated_method(self, *args, **kwargs):
148
"""This is the decorated method."""
149
if callable.__name__ == '__init__':
150
symbol = "%s.%s" % (self.__class__.__module__,
151
self.__class__.__name__,
154
symbol = "%s.%s.%s" % (self.__class__.__module__,
155
self.__class__.__name__,
158
warn(deprecation_version % symbol, DeprecationWarning, stacklevel=2)
159
return callable(self, *args, **kwargs)
160
_populate_decorated(callable, deprecation_version, "method",
162
return decorated_method
163
return method_decorator
166
def deprecated_passed(parameter_value):
167
"""Return True if parameter_value was used."""
168
# FIXME: it might be nice to have a parameter deprecation decorator.
169
# it would need to handle positional and *args and **kwargs parameters,
170
# which means some mechanism to describe how the parameter was being
171
# passed before deprecation, and some way to deprecate parameters that
172
# were not at the end of the arg list. Thats needed for __init__ where
173
# we cannot just forward to a new method name.I.e. in the following
174
# examples we would want to have callers that pass any value to 'bad' be
175
# given a warning - because we have applied:
176
# @deprecated_parameter('bad', zero_seven)
178
# def __init__(self, bad=None)
179
# def __init__(self, bad, other)
180
# def __init__(self, **kwargs)
182
return not parameter_value is DEPRECATED_PARAMETER
185
def _decorate_docstring(callable, deprecation_version, label,
188
docstring_lines = callable.__doc__.split('\n')
191
if len(docstring_lines) == 0:
192
decorated_callable.__doc__ = deprecation_version % ("This " + label)
193
elif len(docstring_lines) == 1:
194
decorated_callable.__doc__ = (callable.__doc__
197
+ deprecation_version % ("This " + label)
200
spaces = len(docstring_lines[-1])
201
new_doc = callable.__doc__
202
new_doc += "\n" + " " * spaces
203
new_doc += deprecation_version % ("This " + label)
204
new_doc += "\n" + " " * spaces
205
decorated_callable.__doc__ = new_doc
208
def _populate_decorated(callable, deprecation_version, label,
210
"""Populate attributes like __name__ and __doc__ on the decorated callable.
212
_decorate_docstring(callable, deprecation_version, label,
214
decorated_callable.__module__ = callable.__module__
215
decorated_callable.__name__ = callable.__name__
216
decorated_callable.is_deprecated = True
219
def _dict_deprecation_wrapper(wrapped_method):
220
"""Returns a closure that emits a warning and calls the superclass"""
221
def cb(dep_dict, *args, **kwargs):
222
msg = 'access to %s' % (dep_dict._variable_name, )
223
msg = dep_dict._deprecation_version % (msg,)
225
msg += ' ' + dep_dict._advice
226
warn(msg, DeprecationWarning, stacklevel=2)
227
return wrapped_method(dep_dict, *args, **kwargs)
231
class DeprecatedDict(dict):
232
"""A dictionary that complains when read or written."""
242
"""Create a dict that warns when read or modified.
244
:param deprecation_version: something like zero_nine
245
:param initial_value: The contents of the dict
246
:param variable_name: This allows better warnings to be printed
247
:param advice: String of advice on what callers should do instead
248
of using this variable.
250
self._deprecation_version = deprecation_version
251
self._variable_name = variable_name
252
self._advice = advice
253
dict.__init__(self, initial_value)
255
# This isn't every possible method but it should trap anyone using the
256
# dict -- add more if desired
257
__len__ = _dict_deprecation_wrapper(dict.__len__)
258
__getitem__ = _dict_deprecation_wrapper(dict.__getitem__)
259
__setitem__ = _dict_deprecation_wrapper(dict.__setitem__)
260
__delitem__ = _dict_deprecation_wrapper(dict.__delitem__)
261
keys = _dict_deprecation_wrapper(dict.keys)
262
__contains__ = _dict_deprecation_wrapper(dict.__contains__)
265
def deprecated_list(deprecation_version, variable_name,
266
initial_value, extra=None):
267
"""Create a list that warns when modified
269
:param deprecation_version: something like zero_nine
270
:param initial_value: The contents of the list
271
:param variable_name: This allows better warnings to be printed
272
:param extra: Extra info to print when printing a warning
275
subst_text = 'Modifying %s' % (variable_name,)
276
msg = deprecation_version % (subst_text,)
280
class _DeprecatedList(list):
281
__doc__ = list.__doc__ + msg
285
def _warn_deprecated(self, func, *args, **kwargs):
286
warn(msg, DeprecationWarning, stacklevel=3)
287
return func(self, *args, **kwargs)
289
def append(self, obj):
290
"""appending to %s is deprecated""" % (variable_name,)
291
return self._warn_deprecated(list.append, obj)
293
def insert(self, index, obj):
294
"""inserting to %s is deprecated""" % (variable_name,)
295
return self._warn_deprecated(list.insert, index, obj)
297
def extend(self, iterable):
298
"""extending %s is deprecated""" % (variable_name,)
299
return self._warn_deprecated(list.extend, iterable)
301
def remove(self, value):
302
"""removing from %s is deprecated""" % (variable_name,)
303
return self._warn_deprecated(list.remove, value)
305
def pop(self, index=None):
306
"""pop'ing from from %s is deprecated""" % (variable_name,)
308
return self._warn_deprecated(list.pop, index)
311
return self._warn_deprecated(list.pop)
313
return _DeprecatedList(initial_value)
added
removed
bzrlib/symbol_versioning.py
