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