1
# Copyright (C) 2006-2010 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19
The methods here allow for api symbol versioning.
22
from __future__ import absolute_import
24
__all__ = ['deprecated_function',
28
'DEPRECATED_PARAMETER',
36
# Import the 'warn' symbol so bzrlib can call it even if we redefine it
37
from warnings import warn
42
DEPRECATED_PARAMETER = "A deprecated parameter marker."
45
def deprecated_in(version_tuple):
46
"""Generate a message that something was deprecated in a release.
48
>>> deprecated_in((1, 4, 0))
49
'%s was deprecated in version 1.4.0.'
51
return ("%%s was deprecated in version %s."
52
% bzrlib._format_version_tuple(version_tuple))
55
def set_warning_method(method):
56
"""Set the warning method to be used by this module.
58
It should take a message and a warning category as warnings.warn does.
64
# TODO - maybe this would be easier to use as one 'smart' method that
65
# guess if it is a method or a class or an attribute ? If so, we can
66
# add that on top of the primitives, once we have all three written
70
def deprecation_string(a_callable, deprecation_version):
71
"""Generate an automatic deprecation string for a_callable.
73
:param a_callable: The callable to substitute into deprecation_version.
74
:param deprecation_version: A deprecation format warning string. This should
75
have a single %s operator in it. a_callable will be turned into a nice
76
python symbol and then substituted into deprecation_version.
78
# We also want to handle old-style classes, in particular exception, and
79
# they don't have an im_class attribute.
80
if getattr(a_callable, 'im_class', None) is None:
81
symbol = "%s.%s" % (a_callable.__module__,
84
symbol = "%s.%s.%s" % (a_callable.im_class.__module__,
85
a_callable.im_class.__name__,
88
return deprecation_version % symbol
91
def deprecated_function(deprecation_version):
92
"""Decorate a function so that use of it will trigger a warning."""
94
def function_decorator(callable):
95
"""This is the function python calls to perform the decoration."""
97
def decorated_function(*args, **kwargs):
98
"""This is the decorated function."""
99
from bzrlib import trace
100
trace.mutter_callsite(4, "Deprecated function called")
101
warn(deprecation_string(callable, deprecation_version),
102
DeprecationWarning, stacklevel=2)
103
return callable(*args, **kwargs)
104
_populate_decorated(callable, deprecation_version, "function",
106
return decorated_function
107
return function_decorator
110
def deprecated_method(deprecation_version):
111
"""Decorate a method so that use of it will trigger a warning.
113
To deprecate a static or class method, use
119
To deprecate an entire class, decorate __init__.
122
def method_decorator(callable):
123
"""This is the function python calls to perform the decoration."""
125
def decorated_method(self, *args, **kwargs):
126
"""This is the decorated method."""
127
from bzrlib import trace
128
if callable.__name__ == '__init__':
129
symbol = "%s.%s" % (self.__class__.__module__,
130
self.__class__.__name__,
133
symbol = "%s.%s.%s" % (self.__class__.__module__,
134
self.__class__.__name__,
137
trace.mutter_callsite(4, "Deprecated method called")
138
warn(deprecation_version % symbol, DeprecationWarning, stacklevel=2)
139
return callable(self, *args, **kwargs)
140
_populate_decorated(callable, deprecation_version, "method",
142
return decorated_method
143
return method_decorator
146
def deprecated_passed(parameter_value):
147
"""Return True if parameter_value was used."""
148
# FIXME: it might be nice to have a parameter deprecation decorator.
149
# it would need to handle positional and *args and **kwargs parameters,
150
# which means some mechanism to describe how the parameter was being
151
# passed before deprecation, and some way to deprecate parameters that
152
# were not at the end of the arg list. Thats needed for __init__ where
153
# we cannot just forward to a new method name.I.e. in the following
154
# examples we would want to have callers that pass any value to 'bad' be
155
# given a warning - because we have applied:
156
# @deprecated_parameter('bad', deprecated_in((1, 5, 0))
158
# def __init__(self, bad=None)
159
# def __init__(self, bad, other)
160
# def __init__(self, **kwargs)
162
return not parameter_value is DEPRECATED_PARAMETER
165
def _decorate_docstring(callable, deprecation_version, label,
168
docstring_lines = callable.__doc__.split('\n')
171
if len(docstring_lines) == 0:
172
decorated_callable.__doc__ = deprecation_version % ("This " + label)
173
elif len(docstring_lines) == 1:
174
decorated_callable.__doc__ = (callable.__doc__
177
+ deprecation_version % ("This " + label)
180
spaces = len(docstring_lines[-1])
181
new_doc = callable.__doc__
182
new_doc += "\n" + " " * spaces
183
new_doc += deprecation_version % ("This " + label)
184
new_doc += "\n" + " " * spaces
185
decorated_callable.__doc__ = new_doc
188
def _populate_decorated(callable, deprecation_version, label,
190
"""Populate attributes like __name__ and __doc__ on the decorated callable.
192
_decorate_docstring(callable, deprecation_version, label,
194
decorated_callable.__module__ = callable.__module__
195
decorated_callable.__name__ = callable.__name__
196
decorated_callable.is_deprecated = True
199
def _dict_deprecation_wrapper(wrapped_method):
200
"""Returns a closure that emits a warning and calls the superclass"""
201
def cb(dep_dict, *args, **kwargs):
202
msg = 'access to %s' % (dep_dict._variable_name, )
203
msg = dep_dict._deprecation_version % (msg,)
205
msg += ' ' + dep_dict._advice
206
warn(msg, DeprecationWarning, stacklevel=2)
207
return wrapped_method(dep_dict, *args, **kwargs)
211
class DeprecatedDict(dict):
212
"""A dictionary that complains when read or written."""
222
"""Create a dict that warns when read or modified.
224
:param deprecation_version: string for the warning format to raise,
225
typically from deprecated_in()
226
:param initial_value: The contents of the dict
227
:param variable_name: This allows better warnings to be printed
228
:param advice: String of advice on what callers should do instead
229
of using this variable.
231
self._deprecation_version = deprecation_version
232
self._variable_name = variable_name
233
self._advice = advice
234
dict.__init__(self, initial_value)
236
# This isn't every possible method but it should trap anyone using the
237
# dict -- add more if desired
238
__len__ = _dict_deprecation_wrapper(dict.__len__)
239
__getitem__ = _dict_deprecation_wrapper(dict.__getitem__)
240
__setitem__ = _dict_deprecation_wrapper(dict.__setitem__)
241
__delitem__ = _dict_deprecation_wrapper(dict.__delitem__)
242
keys = _dict_deprecation_wrapper(dict.keys)
243
__contains__ = _dict_deprecation_wrapper(dict.__contains__)
246
def deprecated_list(deprecation_version, variable_name,
247
initial_value, extra=None):
248
"""Create a list that warns when modified
250
:param deprecation_version: string for the warning format to raise,
251
typically from deprecated_in()
252
:param initial_value: The contents of the list
253
:param variable_name: This allows better warnings to be printed
254
:param extra: Extra info to print when printing a warning
257
subst_text = 'Modifying %s' % (variable_name,)
258
msg = deprecation_version % (subst_text,)
262
class _DeprecatedList(list):
263
__doc__ = list.__doc__ + msg
267
def _warn_deprecated(self, func, *args, **kwargs):
268
warn(msg, DeprecationWarning, stacklevel=3)
269
return func(self, *args, **kwargs)
271
def append(self, obj):
272
"""appending to %s is deprecated""" % (variable_name,)
273
return self._warn_deprecated(list.append, obj)
275
def insert(self, index, obj):
276
"""inserting to %s is deprecated""" % (variable_name,)
277
return self._warn_deprecated(list.insert, index, obj)
279
def extend(self, iterable):
280
"""extending %s is deprecated""" % (variable_name,)
281
return self._warn_deprecated(list.extend, iterable)
283
def remove(self, value):
284
"""removing from %s is deprecated""" % (variable_name,)
285
return self._warn_deprecated(list.remove, value)
287
def pop(self, index=None):
288
"""pop'ing from %s is deprecated""" % (variable_name,)
290
return self._warn_deprecated(list.pop, index)
293
return self._warn_deprecated(list.pop)
295
return _DeprecatedList(initial_value)
298
def _check_for_filter(error_only):
299
"""Check if there is already a filter for deprecation warnings.
301
:param error_only: Only match an 'error' filter
302
:return: True if a filter is found, False otherwise
304
for filter in warnings.filters:
305
if issubclass(DeprecationWarning, filter[2]):
306
# This filter will effect DeprecationWarning
307
if not error_only or filter[0] == 'error':
312
def _remove_filter_callable(filter):
313
"""Build and returns a callable removing filter from the warnings.
315
:param filter: The filter to remove (can be None).
317
:return: A callable that will remove filter from warnings.filters.
321
warnings.filters.remove(filter)
325
def suppress_deprecation_warnings(override=True):
326
"""Call this function to suppress all deprecation warnings.
328
When this is a final release version, we don't want to annoy users with
329
lots of deprecation warnings. We only want the deprecation warnings when
330
running a dev or release candidate.
332
:param override: If True, always set the ignore, if False, only set the
333
ignore if there isn't already a filter.
335
:return: A callable to remove the new warnings this added.
337
if not override and _check_for_filter(error_only=False):
338
# If there is already a filter effecting suppress_deprecation_warnings,
342
warnings.filterwarnings('ignore', category=DeprecationWarning)
343
filter = warnings.filters[0]
344
return _remove_filter_callable(filter)
347
def activate_deprecation_warnings(override=True):
348
"""Call this function to activate deprecation warnings.
350
When running in a 'final' release we suppress deprecation warnings.
351
However, the test suite wants to see them. So when running selftest, we
352
re-enable the deprecation warnings.
354
Note: warnings that have already been issued under 'ignore' will not be
355
reported after this point. The 'warnings' module has already marked them as
356
handled, so they don't get issued again.
358
:param override: If False, only add a filter if there isn't an error filter
359
already. (This slightly differs from suppress_deprecation_warnings, in
360
because it always overrides everything but -Werror).
362
:return: A callable to remove the new warnings this added.
364
if not override and _check_for_filter(error_only=True):
365
# DeprecationWarnings are already turned into errors, don't downgrade
369
warnings.filterwarnings('default', category=DeprecationWarning)
370
filter = warnings.filters[0]
371
return _remove_filter_callable(filter)
added
removed
bzrlib/symbol_versioning.py
