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
warn(deprecation_string(callable, deprecation_version),
142
DeprecationWarning, stacklevel=2)
143
return callable(*args, **kwargs)
144
_populate_decorated(callable, deprecation_version, "function",
146
return decorated_function
147
return function_decorator
150
def deprecated_method(deprecation_version):
151
"""Decorate a method so that use of it will trigger a warning.
153
To deprecate a static or class method, use
159
To deprecate an entire class, decorate __init__.
162
def method_decorator(callable):
163
"""This is the function python calls to perform the decoration."""
165
def decorated_method(self, *args, **kwargs):
166
"""This is the decorated method."""
167
if callable.__name__ == '__init__':
168
symbol = "%s.%s" % (self.__class__.__module__,
169
self.__class__.__name__,
172
symbol = "%s.%s.%s" % (self.__class__.__module__,
173
self.__class__.__name__,
176
warn(deprecation_version % symbol, DeprecationWarning, stacklevel=2)
177
return callable(self, *args, **kwargs)
178
_populate_decorated(callable, deprecation_version, "method",
180
return decorated_method
181
return method_decorator
184
def deprecated_passed(parameter_value):
185
"""Return True if parameter_value was used."""
186
# FIXME: it might be nice to have a parameter deprecation decorator.
187
# it would need to handle positional and *args and **kwargs parameters,
188
# which means some mechanism to describe how the parameter was being
189
# passed before deprecation, and some way to deprecate parameters that
190
# were not at the end of the arg list. Thats needed for __init__ where
191
# we cannot just forward to a new method name.I.e. in the following
192
# examples we would want to have callers that pass any value to 'bad' be
193
# given a warning - because we have applied:
194
# @deprecated_parameter('bad', deprecated_in((1, 5, 0))
196
# def __init__(self, bad=None)
197
# def __init__(self, bad, other)
198
# def __init__(self, **kwargs)
200
return not parameter_value is DEPRECATED_PARAMETER
203
def _decorate_docstring(callable, deprecation_version, label,
206
docstring_lines = callable.__doc__.split('\n')
209
if len(docstring_lines) == 0:
210
decorated_callable.__doc__ = deprecation_version % ("This " + label)
211
elif len(docstring_lines) == 1:
212
decorated_callable.__doc__ = (callable.__doc__
215
+ deprecation_version % ("This " + label)
218
spaces = len(docstring_lines[-1])
219
new_doc = callable.__doc__
220
new_doc += "\n" + " " * spaces
221
new_doc += deprecation_version % ("This " + label)
222
new_doc += "\n" + " " * spaces
223
decorated_callable.__doc__ = new_doc
226
def _populate_decorated(callable, deprecation_version, label,
228
"""Populate attributes like __name__ and __doc__ on the decorated callable.
230
_decorate_docstring(callable, deprecation_version, label,
232
decorated_callable.__module__ = callable.__module__
233
decorated_callable.__name__ = callable.__name__
234
decorated_callable.is_deprecated = True
237
def _dict_deprecation_wrapper(wrapped_method):
238
"""Returns a closure that emits a warning and calls the superclass"""
239
def cb(dep_dict, *args, **kwargs):
240
msg = 'access to %s' % (dep_dict._variable_name, )
241
msg = dep_dict._deprecation_version % (msg,)
243
msg += ' ' + dep_dict._advice
244
warn(msg, DeprecationWarning, stacklevel=2)
245
return wrapped_method(dep_dict, *args, **kwargs)
249
class DeprecatedDict(dict):
250
"""A dictionary that complains when read or written."""
260
"""Create a dict that warns when read or modified.
262
:param deprecation_version: string for the warning format to raise,
263
typically from deprecated_in()
264
:param initial_value: The contents of the dict
265
:param variable_name: This allows better warnings to be printed
266
:param advice: String of advice on what callers should do instead
267
of using this variable.
269
self._deprecation_version = deprecation_version
270
self._variable_name = variable_name
271
self._advice = advice
272
dict.__init__(self, initial_value)
274
# This isn't every possible method but it should trap anyone using the
275
# dict -- add more if desired
276
__len__ = _dict_deprecation_wrapper(dict.__len__)
277
__getitem__ = _dict_deprecation_wrapper(dict.__getitem__)
278
__setitem__ = _dict_deprecation_wrapper(dict.__setitem__)
279
__delitem__ = _dict_deprecation_wrapper(dict.__delitem__)
280
keys = _dict_deprecation_wrapper(dict.keys)
281
__contains__ = _dict_deprecation_wrapper(dict.__contains__)
284
def deprecated_list(deprecation_version, variable_name,
285
initial_value, extra=None):
286
"""Create a list that warns when modified
288
:param deprecation_version: string for the warning format to raise,
289
typically from deprecated_in()
290
:param initial_value: The contents of the list
291
:param variable_name: This allows better warnings to be printed
292
:param extra: Extra info to print when printing a warning
295
subst_text = 'Modifying %s' % (variable_name,)
296
msg = deprecation_version % (subst_text,)
300
class _DeprecatedList(list):
301
__doc__ = list.__doc__ + msg
305
def _warn_deprecated(self, func, *args, **kwargs):
306
warn(msg, DeprecationWarning, stacklevel=3)
307
return func(self, *args, **kwargs)
309
def append(self, obj):
310
"""appending to %s is deprecated""" % (variable_name,)
311
return self._warn_deprecated(list.append, obj)
313
def insert(self, index, obj):
314
"""inserting to %s is deprecated""" % (variable_name,)
315
return self._warn_deprecated(list.insert, index, obj)
317
def extend(self, iterable):
318
"""extending %s is deprecated""" % (variable_name,)
319
return self._warn_deprecated(list.extend, iterable)
321
def remove(self, value):
322
"""removing from %s is deprecated""" % (variable_name,)
323
return self._warn_deprecated(list.remove, value)
325
def pop(self, index=None):
326
"""pop'ing from from %s is deprecated""" % (variable_name,)
328
return self._warn_deprecated(list.pop, index)
331
return self._warn_deprecated(list.pop)
333
return _DeprecatedList(initial_value)
336
def _check_for_filter(error_only):
337
"""Check if there is already a filter for deprecation warnings.
339
:param error_only: Only match an 'error' filter
340
:return: True if a filter is found, False otherwise
343
for filter in warnings.filters:
344
if issubclass(DeprecationWarning, filter[2]):
345
# This filter will effect DeprecationWarning
346
if not error_only or filter[0] == 'error':
351
def suppress_deprecation_warnings(override=True):
352
"""Call this function to suppress all deprecation warnings.
354
When this is a final release version, we don't want to annoy users with
355
lots of deprecation warnings. We only want the deprecation warnings when
356
running a dev or release candidate.
358
:param override: If True, always set the ignore, if False, only set the
359
ignore if there isn't already a filter.
362
if not override and _check_for_filter(error_only=False):
363
# If there is already a filter effecting suppress_deprecation_warnings,
366
warnings.filterwarnings('ignore', category=DeprecationWarning)
369
def activate_deprecation_warnings(override=True):
370
"""Call this function to activate deprecation warnings.
372
When running in a 'final' release we suppress deprecation warnings.
373
However, the test suite wants to see them. So when running selftest, we
374
re-enable the deprecation warnings.
376
Note: warnings that have already been issued under 'ignore' will not be
377
reported after this point. The 'warnings' module has already marked them as
378
handled, so they don't get issued again.
380
:param override: If False, only add a filter if there isn't an error filter
381
already. (This slightly differs from suppress_deprecation_warnings, in
382
because it always overrides everything but -Werror).
385
if not override and _check_for_filter(error_only=True):
386
# DeprecationWarnings are already turned into errors, don't downgrade
389
warnings.filterwarnings('default', category=DeprecationWarning)
added
removed
bzrlib/symbol_versioning.py
