1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
|
# Copyright (C) 2006 Canonical Ltd
# Authors: Robert Collins <robert.collins@canonical.com>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
"""Symbol versioning
The methods here allow for api symbol versioning.
"""
__all__ = ['deprecated_function',
'deprecated_list',
'deprecated_method',
'DEPRECATED_PARAMETER',
'deprecated_passed',
'warn', 'set_warning_method', 'zero_seven',
'zero_eight',
'zero_nine',
'zero_ten',
'zero_eleven',
'zero_twelve',
]
from warnings import warn
DEPRECATED_PARAMETER = "A deprecated parameter marker."
zero_seven = "%s was deprecated in version 0.7."
zero_eight = "%s was deprecated in version 0.8."
zero_nine = "%s was deprecated in version 0.9."
zero_ten = "%s was deprecated in version 0.10."
zero_eleven = "%s was deprecated in version 0.11."
zero_twelve = "%s was deprecated in version 0.12."
def set_warning_method(method):
"""Set the warning method to be used by this module.
It should take a message and a warning category as warnings.warn does.
"""
global warn
warn = method
# TODO - maybe this would be easier to use as one 'smart' method that
# guess if it is a method or a class or an attribute ? If so, we can
# add that on top of the primitives, once we have all three written
# - RBC 20050105
def deprecation_string(a_callable, deprecation_version):
"""Generate an automatic deprecation string for a_callable.
:param a_callable: The callable to substitute into deprecation_version.
:param deprecation_version: A deprecation format warning string. This should
have a single %s operator in it. a_callable will be turned into a nice
python symbol and then substituted into deprecation_version.
"""
if getattr(a_callable, 'im_class', None) is None:
symbol = "%s.%s" % (a_callable.__module__,
a_callable.__name__)
else:
symbol = "%s.%s.%s" % (a_callable.im_class.__module__,
a_callable.im_class.__name__,
a_callable.__name__
)
return deprecation_version % symbol
def deprecated_function(deprecation_version):
"""Decorate a function so that use of it will trigger a warning."""
def function_decorator(callable):
"""This is the function python calls to perform the decoration."""
def decorated_function(*args, **kwargs):
"""This is the decorated function."""
warn(deprecation_string(callable, deprecation_version),
DeprecationWarning, stacklevel=2)
return callable(*args, **kwargs)
_populate_decorated(callable, deprecation_version, "function",
decorated_function)
return decorated_function
return function_decorator
def deprecated_method(deprecation_version):
"""Decorate a method so that use of it will trigger a warning.
To deprecate an entire class, decorate __init__.
"""
def method_decorator(callable):
"""This is the function python calls to perform the decoration."""
def decorated_method(self, *args, **kwargs):
"""This is the decorated method."""
symbol = "%s.%s.%s" % (self.__class__.__module__,
self.__class__.__name__,
callable.__name__
)
warn(deprecation_version % symbol, DeprecationWarning, stacklevel=2)
return callable(self, *args, **kwargs)
_populate_decorated(callable, deprecation_version, "method",
decorated_method)
return decorated_method
return method_decorator
def deprecated_passed(parameter_value):
"""Return True if parameter_value was used."""
# FIXME: it might be nice to have a parameter deprecation decorator.
# it would need to handle positional and *args and **kwargs parameters,
# which means some mechanism to describe how the parameter was being
# passed before deprecation, and some way to deprecate parameters that
# were not at the end of the arg list. Thats needed for __init__ where
# we cannot just forward to a new method name.I.e. in the following
# examples we would want to have callers that pass any value to 'bad' be
# given a warning - because we have applied:
# @deprecated_parameter('bad', zero_seven)
#
# def __init__(self, bad=None)
# def __init__(self, bad, other)
# def __init__(self, **kwargs)
# RBC 20060116
return not parameter_value is DEPRECATED_PARAMETER
def _decorate_docstring(callable, deprecation_version, label,
decorated_callable):
if callable.__doc__:
docstring_lines = callable.__doc__.split('\n')
else:
docstring_lines = []
if len(docstring_lines) == 0:
decorated_callable.__doc__ = deprecation_version % ("This " + label)
elif len(docstring_lines) == 1:
decorated_callable.__doc__ = (callable.__doc__
+ "\n"
+ "\n"
+ deprecation_version % ("This " + label)
+ "\n")
else:
spaces = len(docstring_lines[-1])
new_doc = callable.__doc__
new_doc += "\n" + " " * spaces
new_doc += deprecation_version % ("This " + label)
new_doc += "\n" + " " * spaces
decorated_callable.__doc__ = new_doc
def _populate_decorated(callable, deprecation_version, label,
decorated_callable):
"""Populate attributes like __name__ and __doc__ on the decorated callable.
"""
_decorate_docstring(callable, deprecation_version, label,
decorated_callable)
decorated_callable.__module__ = callable.__module__
decorated_callable.__name__ = callable.__name__
decorated_callable.is_deprecated = True
def deprecated_list(deprecation_version, variable_name,
initial_value, extra=None):
"""Create a list that warns when modified
:param deprecation_version: something like zero_nine
:param initial_value: The contents of the list
:param variable_name: This allows better warnings to be printed
:param extra: Extra info to print when printing a warning
"""
subst_text = 'Modifying %s' % (variable_name,)
msg = deprecation_version % (subst_text,)
if extra:
msg += ' ' + extra
class _DeprecatedList(list):
__doc__ = list.__doc__ + msg
is_deprecated = True
def _warn_deprecated(self, func, *args, **kwargs):
warn(msg, DeprecationWarning, stacklevel=3)
return func(self, *args, **kwargs)
def append(self, obj):
"""appending to %s is deprecated""" % (variable_name,)
return self._warn_deprecated(list.append, obj)
def insert(self, index, obj):
"""inserting to %s is deprecated""" % (variable_name,)
return self._warn_deprecated(list.insert, index, obj)
def extend(self, iterable):
"""extending %s is deprecated""" % (variable_name,)
return self._warn_deprecated(list.extend, iterable)
def remove(self, value):
"""removing from %s is deprecated""" % (variable_name,)
return self._warn_deprecated(list.remove, value)
def pop(self, index=None):
"""pop'ing from from %s is deprecated""" % (variable_name,)
if index:
return self._warn_deprecated(list.pop, index)
else:
# Can't pass None
return self._warn_deprecated(list.pop)
return _DeprecatedList(initial_value)
|