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 breezy can call it even if we redefine it
37
from warnings import warn
41
from .sixish import PY3
43
DEPRECATED_PARAMETER = "A deprecated parameter marker."
46
def deprecated_in(version_tuple):
47
"""Generate a message that something was deprecated in a release.
49
>>> deprecated_in((1, 4, 0))
50
'%s was deprecated in version 1.4.0.'
52
return ("%%s was deprecated in version %s."
53
% breezy._format_version_tuple(version_tuple))
56
def set_warning_method(method):
57
"""Set the warning method to be used by this module.
59
It should take a message and a warning category as warnings.warn does.
65
# TODO - maybe this would be easier to use as one 'smart' method that
66
# guess if it is a method or a class or an attribute ? If so, we can
67
# add that on top of the primitives, once we have all three written
71
def deprecation_string(a_callable, deprecation_version):
72
"""Generate an automatic deprecation string for a_callable.
74
:param a_callable: The callable to substitute into deprecation_version.
75
:param deprecation_version: A deprecation format warning string. This should
76
have a single %s operator in it. a_callable will be turned into a nice
77
python symbol and then substituted into deprecation_version.
79
if getattr(a_callable, '__self__', None) is not None:
80
symbol = "%s.%s.%s" % (a_callable.__self__.__class__.__module__,
81
a_callable.__self__.__class__.__name__,
83
elif getattr(a_callable, '__qualname__', None) is not None and not '<' in a_callable.__qualname__:
84
symbol = "%s.%s" % (a_callable.__module__,
85
a_callable.__qualname__)
87
symbol = "%s.%s" % (a_callable.__module__,
89
return deprecation_version % symbol
92
def deprecated_function(deprecation_version):
93
"""Decorate a function so that use of it will trigger a warning."""
95
def function_decorator(callable):
96
"""This is the function python calls to perform the decoration."""
98
def decorated_function(*args, **kwargs):
99
"""This is the decorated function."""
101
trace.mutter_callsite(4, "Deprecated function called")
102
warn(deprecation_string(callable, deprecation_version),
103
DeprecationWarning, stacklevel=2)
104
return callable(*args, **kwargs)
105
_populate_decorated(callable, deprecation_version, "function",
107
return decorated_function
108
return function_decorator
111
def deprecated_method(deprecation_version):
112
"""Decorate a method so that use of it will trigger a warning.
114
To deprecate a static or class method, use
120
To deprecate an entire class, decorate __init__.
123
def method_decorator(callable):
124
"""This is the function python calls to perform the decoration."""
126
def decorated_method(self, *args, **kwargs):
127
"""This is the decorated method."""
129
if callable.__name__ == '__init__':
130
symbol = "%s.%s" % (self.__class__.__module__,
131
self.__class__.__name__,
134
symbol = "%s.%s.%s" % (self.__class__.__module__,
135
self.__class__.__name__,
138
trace.mutter_callsite(4, "Deprecated method called")
139
warn(deprecation_version % symbol, DeprecationWarning, stacklevel=2)
140
return callable(self, *args, **kwargs)
141
_populate_decorated(callable, deprecation_version, "method",
143
return decorated_method
144
return method_decorator
147
def deprecated_passed(parameter_value):
148
"""Return True if parameter_value was used."""
149
# FIXME: it might be nice to have a parameter deprecation decorator.
150
# it would need to handle positional and *args and **kwargs parameters,
151
# which means some mechanism to describe how the parameter was being
152
# passed before deprecation, and some way to deprecate parameters that
153
# were not at the end of the arg list. Thats needed for __init__ where
154
# we cannot just forward to a new method name.I.e. in the following
155
# examples we would want to have callers that pass any value to 'bad' be
156
# given a warning - because we have applied:
157
# @deprecated_parameter('bad', deprecated_in((1, 5, 0))
159
# def __init__(self, bad=None)
160
# def __init__(self, bad, other)
161
# def __init__(self, **kwargs)
163
return not parameter_value is DEPRECATED_PARAMETER
166
def _decorate_docstring(callable, deprecation_version, label,
169
docstring_lines = callable.__doc__.split('\n')
172
if len(docstring_lines) == 0:
173
decorated_callable.__doc__ = deprecation_version % ("This " + label)
174
elif len(docstring_lines) == 1:
175
decorated_callable.__doc__ = (callable.__doc__
178
+ deprecation_version % ("This " + label)
181
spaces = len(docstring_lines[-1])
182
new_doc = callable.__doc__
183
new_doc += "\n" + " " * spaces
184
new_doc += deprecation_version % ("This " + label)
185
new_doc += "\n" + " " * spaces
186
decorated_callable.__doc__ = new_doc
189
def _populate_decorated(callable, deprecation_version, label,
191
"""Populate attributes like __name__ and __doc__ on the decorated callable.
193
_decorate_docstring(callable, deprecation_version, label,
195
decorated_callable.__module__ = callable.__module__
196
decorated_callable.__name__ = callable.__name__
197
decorated_callable.is_deprecated = True
200
def _dict_deprecation_wrapper(wrapped_method):
201
"""Returns a closure that emits a warning and calls the superclass"""
202
def cb(dep_dict, *args, **kwargs):
203
msg = 'access to %s' % (dep_dict._variable_name, )
204
msg = dep_dict._deprecation_version % (msg,)
206
msg += ' ' + dep_dict._advice
207
warn(msg, DeprecationWarning, stacklevel=2)
208
return wrapped_method(dep_dict, *args, **kwargs)
212
class DeprecatedDict(dict):
213
"""A dictionary that complains when read or written."""
223
"""Create a dict that warns when read or modified.
225
:param deprecation_version: string for the warning format to raise,
226
typically from deprecated_in()
227
:param initial_value: The contents of the dict
228
:param variable_name: This allows better warnings to be printed
229
:param advice: String of advice on what callers should do instead
230
of using this variable.
232
self._deprecation_version = deprecation_version
233
self._variable_name = variable_name
234
self._advice = advice
235
dict.__init__(self, initial_value)
237
# This isn't every possible method but it should trap anyone using the
238
# dict -- add more if desired
239
__len__ = _dict_deprecation_wrapper(dict.__len__)
240
__getitem__ = _dict_deprecation_wrapper(dict.__getitem__)
241
__setitem__ = _dict_deprecation_wrapper(dict.__setitem__)
242
__delitem__ = _dict_deprecation_wrapper(dict.__delitem__)
243
keys = _dict_deprecation_wrapper(dict.keys)
244
__contains__ = _dict_deprecation_wrapper(dict.__contains__)
247
def deprecated_list(deprecation_version, variable_name,
248
initial_value, extra=None):
249
"""Create a list that warns when modified
251
:param deprecation_version: string for the warning format to raise,
252
typically from deprecated_in()
253
:param initial_value: The contents of the list
254
:param variable_name: This allows better warnings to be printed
255
:param extra: Extra info to print when printing a warning
258
subst_text = 'Modifying %s' % (variable_name,)
259
msg = deprecation_version % (subst_text,)
263
class _DeprecatedList(list):
264
__doc__ = list.__doc__ + msg
268
def _warn_deprecated(self, func, *args, **kwargs):
269
warn(msg, DeprecationWarning, stacklevel=3)
270
return func(self, *args, **kwargs)
272
def append(self, obj):
273
"""appending to %s is deprecated""" % (variable_name,)
274
return self._warn_deprecated(list.append, obj)
276
def insert(self, index, obj):
277
"""inserting to %s is deprecated""" % (variable_name,)
278
return self._warn_deprecated(list.insert, index, obj)
280
def extend(self, iterable):
281
"""extending %s is deprecated""" % (variable_name,)
282
return self._warn_deprecated(list.extend, iterable)
284
def remove(self, value):
285
"""removing from %s is deprecated""" % (variable_name,)
286
return self._warn_deprecated(list.remove, value)
288
def pop(self, index=None):
289
"""pop'ing from %s is deprecated""" % (variable_name,)
291
return self._warn_deprecated(list.pop, index)
294
return self._warn_deprecated(list.pop)
296
return _DeprecatedList(initial_value)
299
def _check_for_filter(error_only):
300
"""Check if there is already a filter for deprecation warnings.
302
:param error_only: Only match an 'error' filter
303
:return: True if a filter is found, False otherwise
305
for filter in warnings.filters:
306
if issubclass(DeprecationWarning, filter[2]):
307
# This filter will effect DeprecationWarning
308
if not error_only or filter[0] == 'error':
313
def _remove_filter_callable(filter):
314
"""Build and returns a callable removing filter from the warnings.
316
:param filter: The filter to remove (can be None).
318
:return: A callable that will remove filter from warnings.filters.
322
warnings.filters.remove(filter)
326
def suppress_deprecation_warnings(override=True):
327
"""Call this function to suppress all deprecation warnings.
329
When this is a final release version, we don't want to annoy users with
330
lots of deprecation warnings. We only want the deprecation warnings when
331
running a dev or release candidate.
333
:param override: If True, always set the ignore, if False, only set the
334
ignore if there isn't already a filter.
336
:return: A callable to remove the new warnings this added.
338
if not override and _check_for_filter(error_only=False):
339
# If there is already a filter effecting suppress_deprecation_warnings,
343
warnings.filterwarnings('ignore', category=DeprecationWarning)
344
filter = warnings.filters[0]
345
return _remove_filter_callable(filter)
348
def activate_deprecation_warnings(override=True):
349
"""Call this function to activate deprecation warnings.
351
When running in a 'final' release we suppress deprecation warnings.
352
However, the test suite wants to see them. So when running selftest, we
353
re-enable the deprecation warnings.
355
Note: warnings that have already been issued under 'ignore' will not be
356
reported after this point. The 'warnings' module has already marked them as
357
handled, so they don't get issued again.
359
:param override: If False, only add a filter if there isn't an error filter
360
already. (This slightly differs from suppress_deprecation_warnings, in
361
because it always overrides everything but -Werror).
363
:return: A callable to remove the new warnings this added.
365
if not override and _check_for_filter(error_only=True):
366
# DeprecationWarnings are already turned into errors, don't downgrade
370
warnings.filterwarnings('default', category=DeprecationWarning)
371
filter = warnings.filters[0]
372
return _remove_filter_callable(filter)
added
removed
breezy/symbol_versioning.py
