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
60
def deprecated_function(deprecation_version):
61
"""Decorate a function so that use of it will trigger a warning."""
63
def function_decorator(callable):
64
"""This is the function python calls to perform the decoration."""
66
def decorated_function(*args, **kwargs):
67
"""This is the decorated function."""
68
symbol = "%s.%s" % (callable.__module__,
71
warn(deprecation_version % symbol, DeprecationWarning, stacklevel=2)
72
return callable(*args, **kwargs)
73
_populate_decorated(callable, deprecation_version, "function",
75
return decorated_function
76
return function_decorator
79
def deprecated_method(deprecation_version):
80
"""Decorate a method so that use of it will trigger a warning.
82
To deprecate an entire class, decorate __init__.
85
def method_decorator(callable):
86
"""This is the function python calls to perform the decoration."""
88
def decorated_method(self, *args, **kwargs):
89
"""This is the decorated method."""
90
symbol = "%s.%s.%s" % (self.__class__.__module__,
91
self.__class__.__name__,
94
warn(deprecation_version % symbol, DeprecationWarning, stacklevel=2)
95
return callable(self, *args, **kwargs)
96
_populate_decorated(callable, deprecation_version, "method",
98
return decorated_method
99
return method_decorator
102
def deprecated_passed(parameter_value):
103
"""Return True if parameter_value was used."""
104
# FIXME: it might be nice to have a parameter deprecation decorator.
105
# it would need to handle positional and *args and **kwargs parameters,
106
# which means some mechanism to describe how the parameter was being
107
# passed before deprecation, and some way to deprecate parameters that
108
# were not at the end of the arg list. Thats needed for __init__ where
109
# we cannot just forward to a new method name.I.e. in the following
110
# examples we would want to have callers that pass any value to 'bad' be
111
# given a warning - because we have applied:
112
# @deprecated_parameter('bad', zero_seven)
114
# def __init__(self, bad=None)
115
# def __init__(self, bad, other)
116
# def __init__(self, **kwargs)
118
return not parameter_value is DEPRECATED_PARAMETER
121
def _decorate_docstring(callable, deprecation_version, label,
124
docstring_lines = callable.__doc__.split('\n')
127
if len(docstring_lines) == 0:
128
decorated_callable.__doc__ = deprecation_version % ("This " + label)
129
elif len(docstring_lines) == 1:
130
decorated_callable.__doc__ = (callable.__doc__
133
+ deprecation_version % ("This " + label)
136
spaces = len(docstring_lines[-1])
137
new_doc = callable.__doc__
138
new_doc += "\n" + " " * spaces
139
new_doc += deprecation_version % ("This " + label)
140
new_doc += "\n" + " " * spaces
141
decorated_callable.__doc__ = new_doc
144
def _populate_decorated(callable, deprecation_version, label,
146
"""Populate attributes like __name__ and __doc__ on the decorated callable.
148
_decorate_docstring(callable, deprecation_version, label,
150
decorated_callable.__module__ = callable.__module__
151
decorated_callable.__name__ = callable.__name__
152
decorated_callable.is_deprecated = True
155
def deprecated_list(deprecation_version, variable_name,
156
initial_value, extra=None):
157
"""Create a list that warns when modified
159
:param deprecation_version: something like zero_nine
160
:param initial_value: The contents of the list
161
:param variable_name: This allows better warnings to be printed
162
:param extra: Extra info to print when printing a warning
165
subst_text = 'Modifying %s' % (variable_name,)
166
msg = deprecation_version % (subst_text,)
170
class _DeprecatedList(list):
171
__doc__ = list.__doc__ + msg
175
def _warn_deprecated(self, func, *args, **kwargs):
176
warn(msg, DeprecationWarning, stacklevel=3)
177
return func(self, *args, **kwargs)
179
def append(self, obj):
180
"""appending to %s is deprecated""" % (variable_name,)
181
return self._warn_deprecated(list.append, obj)
183
def insert(self, index, obj):
184
"""inserting to %s is deprecated""" % (variable_name,)
185
return self._warn_deprecated(list.insert, index, obj)
187
def extend(self, iterable):
188
"""extending %s is deprecated""" % (variable_name,)
189
return self._warn_deprecated(list.extend, iterable)
191
def remove(self, value):
192
"""removing from %s is deprecated""" % (variable_name,)
193
return self._warn_deprecated(list.remove, value)
195
def pop(self, index=None):
196
"""pop'ing from from %s is deprecated""" % (variable_name,)
198
return self._warn_deprecated(list.pop, index)
201
return self._warn_deprecated(list.pop)
203
return _DeprecatedList(initial_value)
added
removed
bzrlib/symbol_versioning.py
