1
# Copyright (C) 2006 by Canonical Ltd
2
# Authors: Robert Collins <robert.collins@canonical.com>
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',
26
'DEPRECATED_PARAMETER',
28
'warn', 'set_warning_method', 'zero_seven',
35
from warnings import warn
38
DEPRECATED_PARAMETER = "A deprecated parameter marker."
39
zero_seven = "%s was deprecated in version 0.7."
40
zero_eight = "%s was deprecated in version 0.8."
41
zero_nine = "%s was deprecated in version 0.9."
42
zero_ten = "%s was deprecated in version 0.10."
43
zero_eleven = "%s was deprecated in version 0.11."
46
def set_warning_method(method):
47
"""Set the warning method to be used by this module.
49
It should take a message and a warning category as warnings.warn does.
55
# TODO - maybe this would be easier to use as one 'smart' method that
56
# guess if it is a method or a class or an attribute ? If so, we can
57
# add that on top of the primitives, once we have all three written
61
def deprecation_string(a_callable, deprecation_version):
62
"""Generate an automatic deprecation string for a_callable.
64
:param a_callable: The callable to substitute into deprecation_version.
65
:param deprecation_version: A deprecation format warning string. This should
66
have a single %s operator in it. a_callable will be turned into a nice
67
python symbol and then substituted into deprecation_version.
69
if getattr(a_callable, 'im_class', None) is None:
70
symbol = "%s.%s" % (a_callable.__module__,
73
symbol = "%s.%s.%s" % (a_callable.im_class.__module__,
74
a_callable.im_class.__name__,
77
return deprecation_version % symbol
80
def deprecated_function(deprecation_version):
81
"""Decorate a function so that use of it will trigger a warning."""
83
def function_decorator(callable):
84
"""This is the function python calls to perform the decoration."""
86
def decorated_function(*args, **kwargs):
87
"""This is the decorated function."""
88
warn(deprecation_string(callable, deprecation_version),
89
DeprecationWarning, stacklevel=2)
90
return callable(*args, **kwargs)
91
_populate_decorated(callable, deprecation_version, "function",
93
return decorated_function
94
return function_decorator
97
def deprecated_method(deprecation_version):
98
"""Decorate a method so that use of it will trigger a warning.
100
To deprecate an entire class, decorate __init__.
103
def method_decorator(callable):
104
"""This is the function python calls to perform the decoration."""
106
def decorated_method(self, *args, **kwargs):
107
"""This is the decorated method."""
108
symbol = "%s.%s.%s" % (self.__class__.__module__,
109
self.__class__.__name__,
112
warn(deprecation_version % symbol, DeprecationWarning, stacklevel=2)
113
return callable(self, *args, **kwargs)
114
_populate_decorated(callable, deprecation_version, "method",
116
return decorated_method
117
return method_decorator
120
def deprecated_passed(parameter_value):
121
"""Return True if parameter_value was used."""
122
# FIXME: it might be nice to have a parameter deprecation decorator.
123
# it would need to handle positional and *args and **kwargs parameters,
124
# which means some mechanism to describe how the parameter was being
125
# passed before deprecation, and some way to deprecate parameters that
126
# were not at the end of the arg list. Thats needed for __init__ where
127
# we cannot just forward to a new method name.I.e. in the following
128
# examples we would want to have callers that pass any value to 'bad' be
129
# given a warning - because we have applied:
130
# @deprecated_parameter('bad', zero_seven)
132
# def __init__(self, bad=None)
133
# def __init__(self, bad, other)
134
# def __init__(self, **kwargs)
136
return not parameter_value is DEPRECATED_PARAMETER
139
def _decorate_docstring(callable, deprecation_version, label,
142
docstring_lines = callable.__doc__.split('\n')
145
if len(docstring_lines) == 0:
146
decorated_callable.__doc__ = deprecation_version % ("This " + label)
147
elif len(docstring_lines) == 1:
148
decorated_callable.__doc__ = (callable.__doc__
151
+ deprecation_version % ("This " + label)
154
spaces = len(docstring_lines[-1])
155
new_doc = callable.__doc__
156
new_doc += "\n" + " " * spaces
157
new_doc += deprecation_version % ("This " + label)
158
new_doc += "\n" + " " * spaces
159
decorated_callable.__doc__ = new_doc
162
def _populate_decorated(callable, deprecation_version, label,
164
"""Populate attributes like __name__ and __doc__ on the decorated callable.
166
_decorate_docstring(callable, deprecation_version, label,
168
decorated_callable.__module__ = callable.__module__
169
decorated_callable.__name__ = callable.__name__
170
decorated_callable.is_deprecated = True
173
def deprecated_list(deprecation_version, variable_name,
174
initial_value, extra=None):
175
"""Create a list that warns when modified
177
:param deprecation_version: something like zero_nine
178
:param initial_value: The contents of the list
179
:param variable_name: This allows better warnings to be printed
180
:param extra: Extra info to print when printing a warning
183
subst_text = 'Modifying %s' % (variable_name,)
184
msg = deprecation_version % (subst_text,)
188
class _DeprecatedList(list):
189
__doc__ = list.__doc__ + msg
193
def _warn_deprecated(self, func, *args, **kwargs):
194
warn(msg, DeprecationWarning, stacklevel=3)
195
return func(self, *args, **kwargs)
197
def append(self, obj):
198
"""appending to %s is deprecated""" % (variable_name,)
199
return self._warn_deprecated(list.append, obj)
201
def insert(self, index, obj):
202
"""inserting to %s is deprecated""" % (variable_name,)
203
return self._warn_deprecated(list.insert, index, obj)
205
def extend(self, iterable):
206
"""extending %s is deprecated""" % (variable_name,)
207
return self._warn_deprecated(list.extend, iterable)
209
def remove(self, value):
210
"""removing from %s is deprecated""" % (variable_name,)
211
return self._warn_deprecated(list.remove, value)
213
def pop(self, index=None):
214
"""pop'ing from from %s is deprecated""" % (variable_name,)
216
return self._warn_deprecated(list.pop, index)
219
return self._warn_deprecated(list.pop)
221
return _DeprecatedList(initial_value)
added
removed
bzrlib/symbol_versioning.py
