1
# Copyright (C) 2006, 2007, 2008, 2009 Canonical Ltd
1
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
2
# Authors: Robert Collins <robert.collins@canonical.com> and others
3
4
# This program is free software; you can redistribute it and/or modify
4
5
# it under the terms of the GNU General Public License as published by
13
14
# You should have received a copy of the GNU General Public License
14
15
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
18
"""Symbol versioning
22
23
__all__ = ['deprecated_function',
25
25
'deprecated_method',
26
26
'DEPRECATED_PARAMETER',
27
27
'deprecated_passed',
28
'warn', 'set_warning_method', 'zero_seven',
32
51
from warnings import warn
37
54
DEPRECATED_PARAMETER = "A deprecated parameter marker."
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))
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."
50
77
def set_warning_method(method):
51
78
"""Set the warning method to be used by this module.
89
116
def function_decorator(callable):
90
117
"""This is the function python calls to perform the decoration."""
92
119
def decorated_function(*args, **kwargs):
93
120
"""This is the decorated function."""
94
from bzrlib import trace
95
trace.mutter_callsite(4, "Deprecated function called")
96
121
warn(deprecation_string(callable, deprecation_version),
97
122
DeprecationWarning, stacklevel=2)
98
123
return callable(*args, **kwargs)
105
130
def deprecated_method(deprecation_version):
106
131
"""Decorate a method so that use of it will trigger a warning.
108
To deprecate a static or class method, use
133
To deprecate a static or class method, use
111
136
@deprecated_function
114
139
To deprecate an entire class, decorate __init__.
117
142
def method_decorator(callable):
118
143
"""This is the function python calls to perform the decoration."""
120
145
def decorated_method(self, *args, **kwargs):
121
146
"""This is the decorated method."""
122
from bzrlib import trace
123
147
if callable.__name__ == '__init__':
124
148
symbol = "%s.%s" % (self.__class__.__module__,
125
149
self.__class__.__name__,
129
153
self.__class__.__name__,
130
154
callable.__name__
132
trace.mutter_callsite(4, "Deprecated method called")
133
156
warn(deprecation_version % symbol, DeprecationWarning, stacklevel=2)
134
157
return callable(self, *args, **kwargs)
135
158
_populate_decorated(callable, deprecation_version, "method",
141
164
def deprecated_passed(parameter_value):
142
165
"""Return True if parameter_value was used."""
143
# FIXME: it might be nice to have a parameter deprecation decorator.
166
# FIXME: it might be nice to have a parameter deprecation decorator.
144
167
# it would need to handle positional and *args and **kwargs parameters,
145
168
# which means some mechanism to describe how the parameter was being
146
169
# passed before deprecation, and some way to deprecate parameters that
148
171
# we cannot just forward to a new method name.I.e. in the following
149
172
# examples we would want to have callers that pass any value to 'bad' be
150
173
# given a warning - because we have applied:
151
# @deprecated_parameter('bad', deprecated_in((1, 5, 0))
174
# @deprecated_parameter('bad', zero_seven)
153
176
# def __init__(self, bad=None)
154
177
# def __init__(self, bad, other)
166
189
if len(docstring_lines) == 0:
167
190
decorated_callable.__doc__ = deprecation_version % ("This " + label)
168
191
elif len(docstring_lines) == 1:
169
decorated_callable.__doc__ = (callable.__doc__
192
decorated_callable.__doc__ = (callable.__doc__
172
195
+ deprecation_version % ("This " + label)
217
240
"""Create a dict that warns when read or modified.
219
:param deprecation_version: string for the warning format to raise,
220
typically from deprecated_in()
242
:param deprecation_version: something like zero_nine
221
243
:param initial_value: The contents of the dict
222
244
:param variable_name: This allows better warnings to be printed
223
:param advice: String of advice on what callers should do instead
245
:param advice: String of advice on what callers should do instead
224
246
of using this variable.
226
248
self._deprecation_version = deprecation_version
242
264
initial_value, extra=None):
243
265
"""Create a list that warns when modified
245
:param deprecation_version: string for the warning format to raise,
246
typically from deprecated_in()
267
:param deprecation_version: something like zero_nine
247
268
:param initial_value: The contents of the list
248
269
:param variable_name: This allows better warnings to be printed
249
270
:param extra: Extra info to print when printing a warning
262
283
def _warn_deprecated(self, func, *args, **kwargs):
263
284
warn(msg, DeprecationWarning, stacklevel=3)
264
285
return func(self, *args, **kwargs)
266
287
def append(self, obj):
267
288
"""appending to %s is deprecated""" % (variable_name,)
268
289
return self._warn_deprecated(list.append, obj)
280
301
return self._warn_deprecated(list.remove, value)
282
303
def pop(self, index=None):
283
"""pop'ing from %s is deprecated""" % (variable_name,)
304
"""pop'ing from from %s is deprecated""" % (variable_name,)
285
306
return self._warn_deprecated(list.pop, index)
288
309
return self._warn_deprecated(list.pop)
290
311
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
