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',
25
'DEPRECATED_PARAMETER',
27
'warn', 'set_warning_method', 'zero_seven',
32
from warnings import warn
35
DEPRECATED_PARAMETER = "A deprecated parameter marker."
36
zero_seven = "%s was deprecated in version 0.7."
37
zero_eight = "%s was deprecated in version 0.8."
38
zero_nine = "%s was deprecated in version 0.9."
41
def set_warning_method(method):
42
"""Set the warning method to be used by this module.
44
It should take a message and a warning category as warnings.warn does.
50
# TODO - maybe this would be easier to use as one 'smart' method that
51
# guess if it is a method or a class or an attribute ? If so, we can
52
# add that on top of the primitives, once we have all three written
55
def deprecated_function(deprecation_version):
56
"""Decorate a function so that use of it will trigger a warning."""
58
def function_decorator(callable):
59
"""This is the function python calls to perform the decoration."""
61
def decorated_function(*args, **kwargs):
62
"""This is the decorated function."""
63
symbol = "%s.%s" % (callable.__module__,
66
warn(deprecation_version % symbol, DeprecationWarning, stacklevel=2)
67
return callable(*args, **kwargs)
68
_populate_decorated(callable, deprecation_version, "function",
70
return decorated_function
71
return function_decorator
74
def deprecated_method(deprecation_version):
75
"""Decorate a method so that use of it will trigger a warning.
77
To deprecate an entire class, decorate __init__.
80
def method_decorator(callable):
81
"""This is the function python calls to perform the decoration."""
83
def decorated_method(self, *args, **kwargs):
84
"""This is the decorated method."""
85
symbol = "%s.%s.%s" % (self.__class__.__module__,
86
self.__class__.__name__,
89
warn(deprecation_version % symbol, DeprecationWarning, stacklevel=2)
90
return callable(self, *args, **kwargs)
91
_populate_decorated(callable, deprecation_version, "method",
93
return decorated_method
94
return method_decorator
97
def deprecated_passed(parameter_value):
98
"""Return True if parameter_value was used."""
99
# FIXME: it might be nice to have a parameter deprecation decorator.
100
# it would need to handle positional and *args and **kwargs parameters,
101
# which means some mechanism to describe how the parameter was being
102
# passed before deprecation, and some way to deprecate parameters that
103
# were not at the end of the arg list. Thats needed for __init__ where
104
# we cannot just forward to a new method name.I.e. in the following
105
# examples we would want to have callers that pass any value to 'bad' be
106
# given a warning - because we have applied:
107
# @deprecated_parameter('bad', zero_seven)
109
# def __init__(self, bad=None)
110
# def __init__(self, bad, other)
111
# def __init__(self, **kwargs)
113
return not parameter_value is DEPRECATED_PARAMETER
116
def _decorate_docstring(callable, deprecation_version, label,
119
docstring_lines = callable.__doc__.split('\n')
122
if len(docstring_lines) == 0:
123
decorated_callable.__doc__ = deprecation_version % ("This " + label)
124
elif len(docstring_lines) == 1:
125
decorated_callable.__doc__ = (callable.__doc__
128
+ deprecation_version % ("This " + label)
131
spaces = len(docstring_lines[-1])
132
new_doc = callable.__doc__
133
new_doc += "\n" + " " * spaces
134
new_doc += deprecation_version % ("This " + label)
135
new_doc += "\n" + " " * spaces
136
decorated_callable.__doc__ = new_doc
139
def _populate_decorated(callable, deprecation_version, label,
141
"""Populate attributes like __name__ and __doc__ on the decorated callable.
143
_decorate_docstring(callable, deprecation_version, label,
145
decorated_callable.__module__ = callable.__module__
146
decorated_callable.__name__ = callable.__name__
147
decorated_callable.is_deprecated = True
added
removed
bzrlib/symbol_versioning.py
