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',
51
from warnings import warn
54
DEPRECATED_PARAMETER = "A deprecated parameter marker."
55
zero_seven = "%s was deprecated in version 0.7."
56
zero_eight = "%s was deprecated in version 0.8."
57
zero_nine = "%s was deprecated in version 0.9."
58
zero_ten = "%s was deprecated in version 0.10."
59
zero_eleven = "%s was deprecated in version 0.11."
60
zero_twelve = "%s was deprecated in version 0.12."
61
zero_thirteen = "%s was deprecated in version 0.13."
62
zero_fourteen = "%s was deprecated in version 0.14."
63
zero_fifteen = "%s was deprecated in version 0.15."
64
zero_sixteen = "%s was deprecated in version 0.16."
65
zero_seventeen = "%s was deprecated in version 0.17."
66
zero_eighteen = "%s was deprecated in version 0.18."
67
zero_ninety = "%s was deprecated in version 0.90."
68
zero_ninetyone = "%s was deprecated in version 0.91."
69
zero_ninetytwo = "%s was deprecated in version 0.92."
70
one_zero = "%s was deprecated in version 1.0."
71
zero_ninetythree = one_zero # Maintained for backwards compatibility
72
one_one = "%s was deprecated in version 1.1."
73
one_two = "%s was deprecated in version 1.2."
74
one_three = "%s was deprecated in version 1.3."
75
one_four = "%s was deprecated in version 1.4."
77
def set_warning_method(method):
78
"""Set the warning method to be used by this module.
80
It should take a message and a warning category as warnings.warn does.
86
# TODO - maybe this would be easier to use as one 'smart' method that
87
# guess if it is a method or a class or an attribute ? If so, we can
88
# add that on top of the primitives, once we have all three written
92
def deprecation_string(a_callable, deprecation_version):
93
"""Generate an automatic deprecation string for a_callable.
95
:param a_callable: The callable to substitute into deprecation_version.
96
:param deprecation_version: A deprecation format warning string. This should
97
have a single %s operator in it. a_callable will be turned into a nice
98
python symbol and then substituted into deprecation_version.
100
# We also want to handle old-style classes, in particular exception, and
101
# they don't have an im_class attribute.
102
if getattr(a_callable, 'im_class', None) is None:
103
symbol = "%s.%s" % (a_callable.__module__,
106
symbol = "%s.%s.%s" % (a_callable.im_class.__module__,
107
a_callable.im_class.__name__,
110
return deprecation_version % symbol
113
def deprecated_function(deprecation_version):
114
"""Decorate a function so that use of it will trigger a warning."""
116
def function_decorator(callable):
117
"""This is the function python calls to perform the decoration."""
119
def decorated_function(*args, **kwargs):
120
"""This is the decorated function."""
121
warn(deprecation_string(callable, deprecation_version),
122
DeprecationWarning, stacklevel=2)
123
return callable(*args, **kwargs)
124
_populate_decorated(callable, deprecation_version, "function",
126
return decorated_function
127
return function_decorator
130
def deprecated_method(deprecation_version):
131
"""Decorate a method so that use of it will trigger a warning.
133
To deprecate a static or class method, use
139
To deprecate an entire class, decorate __init__.
142
def method_decorator(callable):
143
"""This is the function python calls to perform the decoration."""
145
def decorated_method(self, *args, **kwargs):
146
"""This is the decorated method."""
147
if callable.__name__ == '__init__':
148
symbol = "%s.%s" % (self.__class__.__module__,
149
self.__class__.__name__,
152
symbol = "%s.%s.%s" % (self.__class__.__module__,
153
self.__class__.__name__,
156
warn(deprecation_version % symbol, DeprecationWarning, stacklevel=2)
157
return callable(self, *args, **kwargs)
158
_populate_decorated(callable, deprecation_version, "method",
160
return decorated_method
161
return method_decorator
164
def deprecated_passed(parameter_value):
165
"""Return True if parameter_value was used."""
166
# FIXME: it might be nice to have a parameter deprecation decorator.
167
# it would need to handle positional and *args and **kwargs parameters,
168
# which means some mechanism to describe how the parameter was being
169
# passed before deprecation, and some way to deprecate parameters that
170
# were not at the end of the arg list. Thats needed for __init__ where
171
# we cannot just forward to a new method name.I.e. in the following
172
# examples we would want to have callers that pass any value to 'bad' be
173
# given a warning - because we have applied:
174
# @deprecated_parameter('bad', zero_seven)
176
# def __init__(self, bad=None)
177
# def __init__(self, bad, other)
178
# def __init__(self, **kwargs)
180
return not parameter_value is DEPRECATED_PARAMETER
183
def _decorate_docstring(callable, deprecation_version, label,
186
docstring_lines = callable.__doc__.split('\n')
189
if len(docstring_lines) == 0:
190
decorated_callable.__doc__ = deprecation_version % ("This " + label)
191
elif len(docstring_lines) == 1:
192
decorated_callable.__doc__ = (callable.__doc__
195
+ deprecation_version % ("This " + label)
198
spaces = len(docstring_lines[-1])
199
new_doc = callable.__doc__
200
new_doc += "\n" + " " * spaces
201
new_doc += deprecation_version % ("This " + label)
202
new_doc += "\n" + " " * spaces
203
decorated_callable.__doc__ = new_doc
206
def _populate_decorated(callable, deprecation_version, label,
208
"""Populate attributes like __name__ and __doc__ on the decorated callable.
210
_decorate_docstring(callable, deprecation_version, label,
212
decorated_callable.__module__ = callable.__module__
213
decorated_callable.__name__ = callable.__name__
214
decorated_callable.is_deprecated = True
217
def _dict_deprecation_wrapper(wrapped_method):
218
"""Returns a closure that emits a warning and calls the superclass"""
219
def cb(dep_dict, *args, **kwargs):
220
msg = 'access to %s' % (dep_dict._variable_name, )
221
msg = dep_dict._deprecation_version % (msg,)
223
msg += ' ' + dep_dict._advice
224
warn(msg, DeprecationWarning, stacklevel=2)
225
return wrapped_method(dep_dict, *args, **kwargs)
229
class DeprecatedDict(dict):
230
"""A dictionary that complains when read or written."""
240
"""Create a dict that warns when read or modified.
242
:param deprecation_version: something like zero_nine
243
:param initial_value: The contents of the dict
244
:param variable_name: This allows better warnings to be printed
245
:param advice: String of advice on what callers should do instead
246
of using this variable.
248
self._deprecation_version = deprecation_version
249
self._variable_name = variable_name
250
self._advice = advice
251
dict.__init__(self, initial_value)
253
# This isn't every possible method but it should trap anyone using the
254
# dict -- add more if desired
255
__len__ = _dict_deprecation_wrapper(dict.__len__)
256
__getitem__ = _dict_deprecation_wrapper(dict.__getitem__)
257
__setitem__ = _dict_deprecation_wrapper(dict.__setitem__)
258
__delitem__ = _dict_deprecation_wrapper(dict.__delitem__)
259
keys = _dict_deprecation_wrapper(dict.keys)
260
__contains__ = _dict_deprecation_wrapper(dict.__contains__)
263
def deprecated_list(deprecation_version, variable_name,
264
initial_value, extra=None):
265
"""Create a list that warns when modified
267
:param deprecation_version: something like zero_nine
268
:param initial_value: The contents of the list
269
:param variable_name: This allows better warnings to be printed
270
:param extra: Extra info to print when printing a warning
273
subst_text = 'Modifying %s' % (variable_name,)
274
msg = deprecation_version % (subst_text,)
278
class _DeprecatedList(list):
279
__doc__ = list.__doc__ + msg
283
def _warn_deprecated(self, func, *args, **kwargs):
284
warn(msg, DeprecationWarning, stacklevel=3)
285
return func(self, *args, **kwargs)
287
def append(self, obj):
288
"""appending to %s is deprecated""" % (variable_name,)
289
return self._warn_deprecated(list.append, obj)
291
def insert(self, index, obj):
292
"""inserting to %s is deprecated""" % (variable_name,)
293
return self._warn_deprecated(list.insert, index, obj)
295
def extend(self, iterable):
296
"""extending %s is deprecated""" % (variable_name,)
297
return self._warn_deprecated(list.extend, iterable)
299
def remove(self, value):
300
"""removing from %s is deprecated""" % (variable_name,)
301
return self._warn_deprecated(list.remove, value)
303
def pop(self, index=None):
304
"""pop'ing from from %s is deprecated""" % (variable_name,)
306
return self._warn_deprecated(list.pop, index)
309
return self._warn_deprecated(list.pop)
311
return _DeprecatedList(initial_value)
added
removed
bzrlib/symbol_versioning.py
