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',
45
from warnings import warn
48
DEPRECATED_PARAMETER = "A deprecated parameter marker."
49
zero_seven = "%s was deprecated in version 0.7."
50
zero_eight = "%s was deprecated in version 0.8."
51
zero_nine = "%s was deprecated in version 0.9."
52
zero_ten = "%s was deprecated in version 0.10."
53
zero_eleven = "%s was deprecated in version 0.11."
54
zero_twelve = "%s was deprecated in version 0.12."
55
zero_thirteen = "%s was deprecated in version 0.13."
56
zero_fourteen = "%s was deprecated in version 0.14."
57
zero_fifteen = "%s was deprecated in version 0.15."
58
zero_sixteen = "%s was deprecated in version 0.16."
59
zero_seventeen = "%s was deprecated in version 0.17."
60
zero_eighteen = "%s was deprecated in version 0.18."
61
zero_ninety = "%s was deprecated in version 0.90."
62
zero_ninetyone = "%s was deprecated in version 0.91."
63
zero_ninetytwo = "%s was deprecated in version 0.92."
66
def set_warning_method(method):
67
"""Set the warning method to be used by this module.
69
It should take a message and a warning category as warnings.warn does.
75
# TODO - maybe this would be easier to use as one 'smart' method that
76
# guess if it is a method or a class or an attribute ? If so, we can
77
# add that on top of the primitives, once we have all three written
81
def deprecation_string(a_callable, deprecation_version):
82
"""Generate an automatic deprecation string for a_callable.
84
:param a_callable: The callable to substitute into deprecation_version.
85
:param deprecation_version: A deprecation format warning string. This should
86
have a single %s operator in it. a_callable will be turned into a nice
87
python symbol and then substituted into deprecation_version.
89
if getattr(a_callable, 'im_class', None) is None:
90
symbol = "%s.%s" % (a_callable.__module__,
93
symbol = "%s.%s.%s" % (a_callable.im_class.__module__,
94
a_callable.im_class.__name__,
97
return deprecation_version % symbol
100
def deprecated_function(deprecation_version):
101
"""Decorate a function so that use of it will trigger a warning."""
103
def function_decorator(callable):
104
"""This is the function python calls to perform the decoration."""
106
def decorated_function(*args, **kwargs):
107
"""This is the decorated function."""
108
warn(deprecation_string(callable, deprecation_version),
109
DeprecationWarning, stacklevel=2)
110
return callable(*args, **kwargs)
111
_populate_decorated(callable, deprecation_version, "function",
113
return decorated_function
114
return function_decorator
117
def deprecated_method(deprecation_version):
118
"""Decorate a method so that use of it will trigger a warning.
120
To deprecate an entire class, decorate __init__.
123
def method_decorator(callable):
124
"""This is the function python calls to perform the decoration."""
126
def decorated_method(self, *args, **kwargs):
127
"""This is the decorated method."""
128
symbol = "%s.%s.%s" % (self.__class__.__module__,
129
self.__class__.__name__,
132
warn(deprecation_version % symbol, DeprecationWarning, stacklevel=2)
133
return callable(self, *args, **kwargs)
134
_populate_decorated(callable, deprecation_version, "method",
136
return decorated_method
137
return method_decorator
140
def deprecated_passed(parameter_value):
141
"""Return True if parameter_value was used."""
142
# FIXME: it might be nice to have a parameter deprecation decorator.
143
# it would need to handle positional and *args and **kwargs parameters,
144
# which means some mechanism to describe how the parameter was being
145
# passed before deprecation, and some way to deprecate parameters that
146
# were not at the end of the arg list. Thats needed for __init__ where
147
# we cannot just forward to a new method name.I.e. in the following
148
# examples we would want to have callers that pass any value to 'bad' be
149
# given a warning - because we have applied:
150
# @deprecated_parameter('bad', zero_seven)
152
# def __init__(self, bad=None)
153
# def __init__(self, bad, other)
154
# def __init__(self, **kwargs)
156
return not parameter_value is DEPRECATED_PARAMETER
159
def _decorate_docstring(callable, deprecation_version, label,
162
docstring_lines = callable.__doc__.split('\n')
165
if len(docstring_lines) == 0:
166
decorated_callable.__doc__ = deprecation_version % ("This " + label)
167
elif len(docstring_lines) == 1:
168
decorated_callable.__doc__ = (callable.__doc__
171
+ deprecation_version % ("This " + label)
174
spaces = len(docstring_lines[-1])
175
new_doc = callable.__doc__
176
new_doc += "\n" + " " * spaces
177
new_doc += deprecation_version % ("This " + label)
178
new_doc += "\n" + " " * spaces
179
decorated_callable.__doc__ = new_doc
182
def _populate_decorated(callable, deprecation_version, label,
184
"""Populate attributes like __name__ and __doc__ on the decorated callable.
186
_decorate_docstring(callable, deprecation_version, label,
188
decorated_callable.__module__ = callable.__module__
189
decorated_callable.__name__ = callable.__name__
190
decorated_callable.is_deprecated = True
193
def _dict_deprecation_wrapper(wrapped_method):
194
"""Returns a closure that emits a warning and calls the superclass"""
195
def cb(dep_dict, *args, **kwargs):
196
msg = 'access to %s' % (dep_dict._variable_name, )
197
msg = dep_dict._deprecation_version % (msg,)
199
msg += ' ' + dep_dict._advice
200
warn(msg, DeprecationWarning, stacklevel=2)
201
return wrapped_method(dep_dict, *args, **kwargs)
205
class DeprecatedDict(dict):
206
"""A dictionary that complains when read or written."""
216
"""Create a dict that warns when read or modified.
218
:param deprecation_version: something like zero_nine
219
:param initial_value: The contents of the dict
220
:param variable_name: This allows better warnings to be printed
221
:param advice: String of advice on what callers should do instead
222
of using this variable.
224
self._deprecation_version = deprecation_version
225
self._variable_name = variable_name
226
self._advice = advice
227
dict.__init__(self, initial_value)
229
# This isn't every possible method but it should trap anyone using the
230
# dict -- add more if desired
231
__len__ = _dict_deprecation_wrapper(dict.__len__)
232
__getitem__ = _dict_deprecation_wrapper(dict.__getitem__)
233
__setitem__ = _dict_deprecation_wrapper(dict.__setitem__)
234
__delitem__ = _dict_deprecation_wrapper(dict.__delitem__)
235
keys = _dict_deprecation_wrapper(dict.keys)
236
__contains__ = _dict_deprecation_wrapper(dict.__contains__)
239
def deprecated_list(deprecation_version, variable_name,
240
initial_value, extra=None):
241
"""Create a list that warns when modified
243
:param deprecation_version: something like zero_nine
244
:param initial_value: The contents of the list
245
:param variable_name: This allows better warnings to be printed
246
:param extra: Extra info to print when printing a warning
249
subst_text = 'Modifying %s' % (variable_name,)
250
msg = deprecation_version % (subst_text,)
254
class _DeprecatedList(list):
255
__doc__ = list.__doc__ + msg
259
def _warn_deprecated(self, func, *args, **kwargs):
260
warn(msg, DeprecationWarning, stacklevel=3)
261
return func(self, *args, **kwargs)
263
def append(self, obj):
264
"""appending to %s is deprecated""" % (variable_name,)
265
return self._warn_deprecated(list.append, obj)
267
def insert(self, index, obj):
268
"""inserting to %s is deprecated""" % (variable_name,)
269
return self._warn_deprecated(list.insert, index, obj)
271
def extend(self, iterable):
272
"""extending %s is deprecated""" % (variable_name,)
273
return self._warn_deprecated(list.extend, iterable)
275
def remove(self, value):
276
"""removing from %s is deprecated""" % (variable_name,)
277
return self._warn_deprecated(list.remove, value)
279
def pop(self, index=None):
280
"""pop'ing from from %s is deprecated""" % (variable_name,)
282
return self._warn_deprecated(list.pop, index)
285
return self._warn_deprecated(list.pop)
287
return _DeprecatedList(initial_value)
added
removed
bzrlib/symbol_versioning.py
