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',
56
from warnings import warn
61
DEPRECATED_PARAMETER = "A deprecated parameter marker."
62
zero_seven = "%s was deprecated in version 0.7."
63
zero_eight = "%s was deprecated in version 0.8."
64
zero_nine = "%s was deprecated in version 0.9."
65
zero_ten = "%s was deprecated in version 0.10."
66
zero_eleven = "%s was deprecated in version 0.11."
67
zero_twelve = "%s was deprecated in version 0.12."
68
zero_thirteen = "%s was deprecated in version 0.13."
69
zero_fourteen = "%s was deprecated in version 0.14."
70
zero_fifteen = "%s was deprecated in version 0.15."
71
zero_sixteen = "%s was deprecated in version 0.16."
72
zero_seventeen = "%s was deprecated in version 0.17."
73
zero_eighteen = "%s was deprecated in version 0.18."
74
zero_ninety = "%s was deprecated in version 0.90."
75
zero_ninetyone = "%s was deprecated in version 0.91."
76
zero_ninetytwo = "%s was deprecated in version 0.92."
77
one_zero = "%s was deprecated in version 1.0."
78
zero_ninetythree = one_zero # Maintained for backwards compatibility
79
one_one = "%s was deprecated in version 1.1."
80
one_two = "%s was deprecated in version 1.2."
81
one_three = "%s was deprecated in version 1.3."
82
one_four = "%s was deprecated in version 1.4."
83
one_five = "%s was deprecated in version 1.5."
84
one_six = "%s was deprecated in version 1.6."
87
def deprecated_in(version_tuple):
88
"""Generate a message that something was deprecated in a release.
90
>>> deprecated_in((1, 4, 0))
91
'%s was deprecated in version 1.4.'
93
return ("%%s was deprecated in version %s."
94
% bzrlib._format_version_tuple(version_tuple))
97
def set_warning_method(method):
98
"""Set the warning method to be used by this module.
100
It should take a message and a warning category as warnings.warn does.
106
# TODO - maybe this would be easier to use as one 'smart' method that
107
# guess if it is a method or a class or an attribute ? If so, we can
108
# add that on top of the primitives, once we have all three written
112
def deprecation_string(a_callable, deprecation_version):
113
"""Generate an automatic deprecation string for a_callable.
115
:param a_callable: The callable to substitute into deprecation_version.
116
:param deprecation_version: A deprecation format warning string. This should
117
have a single %s operator in it. a_callable will be turned into a nice
118
python symbol and then substituted into deprecation_version.
120
# We also want to handle old-style classes, in particular exception, and
121
# they don't have an im_class attribute.
122
if getattr(a_callable, 'im_class', None) is None:
123
symbol = "%s.%s" % (a_callable.__module__,
126
symbol = "%s.%s.%s" % (a_callable.im_class.__module__,
127
a_callable.im_class.__name__,
130
return deprecation_version % symbol
133
def deprecated_function(deprecation_version):
134
"""Decorate a function so that use of it will trigger a warning."""
136
def function_decorator(callable):
137
"""This is the function python calls to perform the decoration."""
139
def decorated_function(*args, **kwargs):
140
"""This is the decorated function."""
141
from bzrlib import trace
142
trace.mutter_callsite(4, "Deprecated function called")
143
warn(deprecation_string(callable, deprecation_version),
144
DeprecationWarning, stacklevel=2)
145
return callable(*args, **kwargs)
146
_populate_decorated(callable, deprecation_version, "function",
148
return decorated_function
149
return function_decorator
152
def deprecated_method(deprecation_version):
153
"""Decorate a method so that use of it will trigger a warning.
155
To deprecate a static or class method, use
161
To deprecate an entire class, decorate __init__.
164
def method_decorator(callable):
165
"""This is the function python calls to perform the decoration."""
167
def decorated_method(self, *args, **kwargs):
168
"""This is the decorated method."""
169
from bzrlib import trace
170
if callable.__name__ == '__init__':
171
symbol = "%s.%s" % (self.__class__.__module__,
172
self.__class__.__name__,
175
symbol = "%s.%s.%s" % (self.__class__.__module__,
176
self.__class__.__name__,
179
trace.mutter_callsite(4, "Deprecated method called")
180
warn(deprecation_version % symbol, DeprecationWarning, stacklevel=2)
181
return callable(self, *args, **kwargs)
182
_populate_decorated(callable, deprecation_version, "method",
184
return decorated_method
185
return method_decorator
188
def deprecated_passed(parameter_value):
189
"""Return True if parameter_value was used."""
190
# FIXME: it might be nice to have a parameter deprecation decorator.
191
# it would need to handle positional and *args and **kwargs parameters,
192
# which means some mechanism to describe how the parameter was being
193
# passed before deprecation, and some way to deprecate parameters that
194
# were not at the end of the arg list. Thats needed for __init__ where
195
# we cannot just forward to a new method name.I.e. in the following
196
# examples we would want to have callers that pass any value to 'bad' be
197
# given a warning - because we have applied:
198
# @deprecated_parameter('bad', deprecated_in((1, 5, 0))
200
# def __init__(self, bad=None)
201
# def __init__(self, bad, other)
202
# def __init__(self, **kwargs)
204
return not parameter_value is DEPRECATED_PARAMETER
207
def _decorate_docstring(callable, deprecation_version, label,
210
docstring_lines = callable.__doc__.split('\n')
213
if len(docstring_lines) == 0:
214
decorated_callable.__doc__ = deprecation_version % ("This " + label)
215
elif len(docstring_lines) == 1:
216
decorated_callable.__doc__ = (callable.__doc__
219
+ deprecation_version % ("This " + label)
222
spaces = len(docstring_lines[-1])
223
new_doc = callable.__doc__
224
new_doc += "\n" + " " * spaces
225
new_doc += deprecation_version % ("This " + label)
226
new_doc += "\n" + " " * spaces
227
decorated_callable.__doc__ = new_doc
230
def _populate_decorated(callable, deprecation_version, label,
232
"""Populate attributes like __name__ and __doc__ on the decorated callable.
234
_decorate_docstring(callable, deprecation_version, label,
236
decorated_callable.__module__ = callable.__module__
237
decorated_callable.__name__ = callable.__name__
238
decorated_callable.is_deprecated = True
241
def _dict_deprecation_wrapper(wrapped_method):
242
"""Returns a closure that emits a warning and calls the superclass"""
243
def cb(dep_dict, *args, **kwargs):
244
msg = 'access to %s' % (dep_dict._variable_name, )
245
msg = dep_dict._deprecation_version % (msg,)
247
msg += ' ' + dep_dict._advice
248
warn(msg, DeprecationWarning, stacklevel=2)
249
return wrapped_method(dep_dict, *args, **kwargs)
253
class DeprecatedDict(dict):
254
"""A dictionary that complains when read or written."""
264
"""Create a dict that warns when read or modified.
266
:param deprecation_version: string for the warning format to raise,
267
typically from deprecated_in()
268
:param initial_value: The contents of the dict
269
:param variable_name: This allows better warnings to be printed
270
:param advice: String of advice on what callers should do instead
271
of using this variable.
273
self._deprecation_version = deprecation_version
274
self._variable_name = variable_name
275
self._advice = advice
276
dict.__init__(self, initial_value)
278
# This isn't every possible method but it should trap anyone using the
279
# dict -- add more if desired
280
__len__ = _dict_deprecation_wrapper(dict.__len__)
281
__getitem__ = _dict_deprecation_wrapper(dict.__getitem__)
282
__setitem__ = _dict_deprecation_wrapper(dict.__setitem__)
283
__delitem__ = _dict_deprecation_wrapper(dict.__delitem__)
284
keys = _dict_deprecation_wrapper(dict.keys)
285
__contains__ = _dict_deprecation_wrapper(dict.__contains__)
288
def deprecated_list(deprecation_version, variable_name,
289
initial_value, extra=None):
290
"""Create a list that warns when modified
292
:param deprecation_version: string for the warning format to raise,
293
typically from deprecated_in()
294
:param initial_value: The contents of the list
295
:param variable_name: This allows better warnings to be printed
296
:param extra: Extra info to print when printing a warning
299
subst_text = 'Modifying %s' % (variable_name,)
300
msg = deprecation_version % (subst_text,)
304
class _DeprecatedList(list):
305
__doc__ = list.__doc__ + msg
309
def _warn_deprecated(self, func, *args, **kwargs):
310
warn(msg, DeprecationWarning, stacklevel=3)
311
return func(self, *args, **kwargs)
313
def append(self, obj):
314
"""appending to %s is deprecated""" % (variable_name,)
315
return self._warn_deprecated(list.append, obj)
317
def insert(self, index, obj):
318
"""inserting to %s is deprecated""" % (variable_name,)
319
return self._warn_deprecated(list.insert, index, obj)
321
def extend(self, iterable):
322
"""extending %s is deprecated""" % (variable_name,)
323
return self._warn_deprecated(list.extend, iterable)
325
def remove(self, value):
326
"""removing from %s is deprecated""" % (variable_name,)
327
return self._warn_deprecated(list.remove, value)
329
def pop(self, index=None):
330
"""pop'ing from from %s is deprecated""" % (variable_name,)
332
return self._warn_deprecated(list.pop, index)
335
return self._warn_deprecated(list.pop)
337
return _DeprecatedList(initial_value)
340
def _check_for_filter(error_only):
341
"""Check if there is already a filter for deprecation warnings.
343
:param error_only: Only match an 'error' filter
344
:return: True if a filter is found, False otherwise
347
for filter in warnings.filters:
348
if issubclass(DeprecationWarning, filter[2]):
349
# This filter will effect DeprecationWarning
350
if not error_only or filter[0] == 'error':
355
def suppress_deprecation_warnings(override=True):
356
"""Call this function to suppress all deprecation warnings.
358
When this is a final release version, we don't want to annoy users with
359
lots of deprecation warnings. We only want the deprecation warnings when
360
running a dev or release candidate.
362
:param override: If True, always set the ignore, if False, only set the
363
ignore if there isn't already a filter.
366
if not override and _check_for_filter(error_only=False):
367
# If there is already a filter effecting suppress_deprecation_warnings,
370
warnings.filterwarnings('ignore', category=DeprecationWarning)
373
def activate_deprecation_warnings(override=True):
374
"""Call this function to activate deprecation warnings.
376
When running in a 'final' release we suppress deprecation warnings.
377
However, the test suite wants to see them. So when running selftest, we
378
re-enable the deprecation warnings.
380
Note: warnings that have already been issued under 'ignore' will not be
381
reported after this point. The 'warnings' module has already marked them as
382
handled, so they don't get issued again.
384
:param override: If False, only add a filter if there isn't an error filter
385
already. (This slightly differs from suppress_deprecation_warnings, in
386
because it always overrides everything but -Werror).
389
if not override and _check_for_filter(error_only=True):
390
# DeprecationWarnings are already turned into errors, don't downgrade
393
warnings.filterwarnings('default', category=DeprecationWarning)
added
removed
bzrlib/symbol_versioning.py
