1
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
2
# Authors: Robert Collins <robert.collins@canonical.com> and others
1
# Copyright (C) 2006, 2007, 2008, 2009 Canonical Ltd
4
3
# This program is free software; you can redistribute it and/or modify
5
4
# it under the terms of the GNU General Public License as published by
14
13
# You should have received a copy of the GNU General Public License
15
14
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
17
"""Symbol versioning
23
22
__all__ = ['deprecated_function',
25
25
'deprecated_method',
26
26
'DEPRECATED_PARAMETER',
27
27
'deprecated_passed',
28
'warn', 'set_warning_method', 'zero_seven',
51
32
from warnings import warn
54
37
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."
40
def deprecated_in(version_tuple):
41
"""Generate a message that something was deprecated in a release.
43
>>> deprecated_in((1, 4, 0))
44
'%s was deprecated in version 1.4.0.'
46
return ("%%s was deprecated in version %s."
47
% bzrlib._format_version_tuple(version_tuple))
77
50
def set_warning_method(method):
78
51
"""Set the warning method to be used by this module.
116
89
def function_decorator(callable):
117
90
"""This is the function python calls to perform the decoration."""
119
92
def decorated_function(*args, **kwargs):
120
93
"""This is the decorated function."""
94
from bzrlib import trace
95
trace.mutter_callsite(4, "Deprecated function called")
121
96
warn(deprecation_string(callable, deprecation_version),
122
97
DeprecationWarning, stacklevel=2)
123
98
return callable(*args, **kwargs)
130
105
def deprecated_method(deprecation_version):
131
106
"""Decorate a method so that use of it will trigger a warning.
133
To deprecate a static or class method, use
108
To deprecate a static or class method, use
136
111
@deprecated_function
139
114
To deprecate an entire class, decorate __init__.
142
117
def method_decorator(callable):
143
118
"""This is the function python calls to perform the decoration."""
145
120
def decorated_method(self, *args, **kwargs):
146
121
"""This is the decorated method."""
122
from bzrlib import trace
147
123
if callable.__name__ == '__init__':
148
124
symbol = "%s.%s" % (self.__class__.__module__,
149
125
self.__class__.__name__,
153
129
self.__class__.__name__,
154
130
callable.__name__
132
trace.mutter_callsite(4, "Deprecated method called")
156
133
warn(deprecation_version % symbol, DeprecationWarning, stacklevel=2)
157
134
return callable(self, *args, **kwargs)
158
135
_populate_decorated(callable, deprecation_version, "method",
164
141
def deprecated_passed(parameter_value):
165
142
"""Return True if parameter_value was used."""
166
# FIXME: it might be nice to have a parameter deprecation decorator.
143
# FIXME: it might be nice to have a parameter deprecation decorator.
167
144
# it would need to handle positional and *args and **kwargs parameters,
168
145
# which means some mechanism to describe how the parameter was being
169
146
# passed before deprecation, and some way to deprecate parameters that
171
148
# we cannot just forward to a new method name.I.e. in the following
172
149
# examples we would want to have callers that pass any value to 'bad' be
173
150
# given a warning - because we have applied:
174
# @deprecated_parameter('bad', zero_seven)
151
# @deprecated_parameter('bad', deprecated_in((1, 5, 0))
176
153
# def __init__(self, bad=None)
177
154
# def __init__(self, bad, other)
189
166
if len(docstring_lines) == 0:
190
167
decorated_callable.__doc__ = deprecation_version % ("This " + label)
191
168
elif len(docstring_lines) == 1:
192
decorated_callable.__doc__ = (callable.__doc__
169
decorated_callable.__doc__ = (callable.__doc__
195
172
+ deprecation_version % ("This " + label)
240
217
"""Create a dict that warns when read or modified.
242
:param deprecation_version: something like zero_nine
219
:param deprecation_version: string for the warning format to raise,
220
typically from deprecated_in()
243
221
:param initial_value: The contents of the dict
244
222
:param variable_name: This allows better warnings to be printed
245
:param advice: String of advice on what callers should do instead
223
:param advice: String of advice on what callers should do instead
246
224
of using this variable.
248
226
self._deprecation_version = deprecation_version
264
242
initial_value, extra=None):
265
243
"""Create a list that warns when modified
267
:param deprecation_version: something like zero_nine
245
:param deprecation_version: string for the warning format to raise,
246
typically from deprecated_in()
268
247
:param initial_value: The contents of the list
269
248
:param variable_name: This allows better warnings to be printed
270
249
:param extra: Extra info to print when printing a warning
283
262
def _warn_deprecated(self, func, *args, **kwargs):
284
263
warn(msg, DeprecationWarning, stacklevel=3)
285
264
return func(self, *args, **kwargs)
287
266
def append(self, obj):
288
267
"""appending to %s is deprecated""" % (variable_name,)
289
268
return self._warn_deprecated(list.append, obj)
301
280
return self._warn_deprecated(list.remove, value)
303
282
def pop(self, index=None):
304
"""pop'ing from from %s is deprecated""" % (variable_name,)
283
"""pop'ing from %s is deprecated""" % (variable_name,)
306
285
return self._warn_deprecated(list.pop, index)
309
288
return self._warn_deprecated(list.pop)
311
290
return _DeprecatedList(initial_value)
293
def _check_for_filter(error_only):
294
"""Check if there is already a filter for deprecation warnings.
296
:param error_only: Only match an 'error' filter
297
:return: True if a filter is found, False otherwise
300
for filter in warnings.filters:
301
if issubclass(DeprecationWarning, filter[2]):
302
# This filter will effect DeprecationWarning
303
if not error_only or filter[0] == 'error':
308
def suppress_deprecation_warnings(override=True):
309
"""Call this function to suppress all deprecation warnings.
311
When this is a final release version, we don't want to annoy users with
312
lots of deprecation warnings. We only want the deprecation warnings when
313
running a dev or release candidate.
315
:param override: If True, always set the ignore, if False, only set the
316
ignore if there isn't already a filter.
319
if not override and _check_for_filter(error_only=False):
320
# If there is already a filter effecting suppress_deprecation_warnings,
323
warnings.filterwarnings('ignore', category=DeprecationWarning)
326
def activate_deprecation_warnings(override=True):
327
"""Call this function to activate deprecation warnings.
329
When running in a 'final' release we suppress deprecation warnings.
330
However, the test suite wants to see them. So when running selftest, we
331
re-enable the deprecation warnings.
333
Note: warnings that have already been issued under 'ignore' will not be
334
reported after this point. The 'warnings' module has already marked them as
335
handled, so they don't get issued again.
337
:param override: If False, only add a filter if there isn't an error filter
338
already. (This slightly differs from suppress_deprecation_warnings, in
339
because it always overrides everything but -Werror).
342
if not override and _check_for_filter(error_only=True):
343
# DeprecationWarnings are already turned into errors, don't downgrade
346
warnings.filterwarnings('default', category=DeprecationWarning)
added
removed
bzrlib/symbol_versioning.py
