1
# Copyright (C) 2006 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',
37
from warnings import warn
40
DEPRECATED_PARAMETER = "A deprecated parameter marker."
41
zero_seven = "%s was deprecated in version 0.7."
42
zero_eight = "%s was deprecated in version 0.8."
43
zero_nine = "%s was deprecated in version 0.9."
44
zero_ten = "%s was deprecated in version 0.10."
45
zero_eleven = "%s was deprecated in version 0.11."
46
zero_twelve = "%s was deprecated in version 0.12."
47
zero_thirteen = "%s was deprecated in version 0.13."
50
def set_warning_method(method):
51
"""Set the warning method to be used by this module.
53
It should take a message and a warning category as warnings.warn does.
59
# TODO - maybe this would be easier to use as one 'smart' method that
60
# guess if it is a method or a class or an attribute ? If so, we can
61
# add that on top of the primitives, once we have all three written
65
def deprecation_string(a_callable, deprecation_version):
66
"""Generate an automatic deprecation string for a_callable.
68
:param a_callable: The callable to substitute into deprecation_version.
69
:param deprecation_version: A deprecation format warning string. This should
70
have a single %s operator in it. a_callable will be turned into a nice
71
python symbol and then substituted into deprecation_version.
73
if getattr(a_callable, 'im_class', None) is None:
74
symbol = "%s.%s" % (a_callable.__module__,
77
symbol = "%s.%s.%s" % (a_callable.im_class.__module__,
78
a_callable.im_class.__name__,
81
return deprecation_version % symbol
84
def deprecated_function(deprecation_version):
85
"""Decorate a function so that use of it will trigger a warning."""
87
def function_decorator(callable):
88
"""This is the function python calls to perform the decoration."""
90
def decorated_function(*args, **kwargs):
91
"""This is the decorated function."""
92
warn(deprecation_string(callable, deprecation_version),
93
DeprecationWarning, stacklevel=2)
94
return callable(*args, **kwargs)
95
_populate_decorated(callable, deprecation_version, "function",
97
return decorated_function
98
return function_decorator
101
def deprecated_method(deprecation_version):
102
"""Decorate a method so that use of it will trigger a warning.
104
To deprecate an entire class, decorate __init__.
107
def method_decorator(callable):
108
"""This is the function python calls to perform the decoration."""
110
def decorated_method(self, *args, **kwargs):
111
"""This is the decorated method."""
112
symbol = "%s.%s.%s" % (self.__class__.__module__,
113
self.__class__.__name__,
116
warn(deprecation_version % symbol, DeprecationWarning, stacklevel=2)
117
return callable(self, *args, **kwargs)
118
_populate_decorated(callable, deprecation_version, "method",
120
return decorated_method
121
return method_decorator
124
def deprecated_passed(parameter_value):
125
"""Return True if parameter_value was used."""
126
# FIXME: it might be nice to have a parameter deprecation decorator.
127
# it would need to handle positional and *args and **kwargs parameters,
128
# which means some mechanism to describe how the parameter was being
129
# passed before deprecation, and some way to deprecate parameters that
130
# were not at the end of the arg list. Thats needed for __init__ where
131
# we cannot just forward to a new method name.I.e. in the following
132
# examples we would want to have callers that pass any value to 'bad' be
133
# given a warning - because we have applied:
134
# @deprecated_parameter('bad', zero_seven)
136
# def __init__(self, bad=None)
137
# def __init__(self, bad, other)
138
# def __init__(self, **kwargs)
140
return not parameter_value is DEPRECATED_PARAMETER
143
def _decorate_docstring(callable, deprecation_version, label,
146
docstring_lines = callable.__doc__.split('\n')
149
if len(docstring_lines) == 0:
150
decorated_callable.__doc__ = deprecation_version % ("This " + label)
151
elif len(docstring_lines) == 1:
152
decorated_callable.__doc__ = (callable.__doc__
155
+ deprecation_version % ("This " + label)
158
spaces = len(docstring_lines[-1])
159
new_doc = callable.__doc__
160
new_doc += "\n" + " " * spaces
161
new_doc += deprecation_version % ("This " + label)
162
new_doc += "\n" + " " * spaces
163
decorated_callable.__doc__ = new_doc
166
def _populate_decorated(callable, deprecation_version, label,
168
"""Populate attributes like __name__ and __doc__ on the decorated callable.
170
_decorate_docstring(callable, deprecation_version, label,
172
decorated_callable.__module__ = callable.__module__
173
decorated_callable.__name__ = callable.__name__
174
decorated_callable.is_deprecated = True
177
def deprecated_list(deprecation_version, variable_name,
178
initial_value, extra=None):
179
"""Create a list that warns when modified
181
:param deprecation_version: something like zero_nine
182
:param initial_value: The contents of the list
183
:param variable_name: This allows better warnings to be printed
184
:param extra: Extra info to print when printing a warning
187
subst_text = 'Modifying %s' % (variable_name,)
188
msg = deprecation_version % (subst_text,)
192
class _DeprecatedList(list):
193
__doc__ = list.__doc__ + msg
197
def _warn_deprecated(self, func, *args, **kwargs):
198
warn(msg, DeprecationWarning, stacklevel=3)
199
return func(self, *args, **kwargs)
201
def append(self, obj):
202
"""appending to %s is deprecated""" % (variable_name,)
203
return self._warn_deprecated(list.append, obj)
205
def insert(self, index, obj):
206
"""inserting to %s is deprecated""" % (variable_name,)
207
return self._warn_deprecated(list.insert, index, obj)
209
def extend(self, iterable):
210
"""extending %s is deprecated""" % (variable_name,)
211
return self._warn_deprecated(list.extend, iterable)
213
def remove(self, value):
214
"""removing from %s is deprecated""" % (variable_name,)
215
return self._warn_deprecated(list.remove, value)
217
def pop(self, index=None):
218
"""pop'ing from from %s is deprecated""" % (variable_name,)
220
return self._warn_deprecated(list.pop, index)
223
return self._warn_deprecated(list.pop)
225
return _DeprecatedList(initial_value)
added
removed
bzrlib/symbol_versioning.py
