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',
27
'warn', 'set_warning_method', 'zero_seven',
30
from warnings import warn
33
deprecated_nonce = "A deprecated parameter marker."
34
zero_seven = "%s was deprecated in version 0.7."
37
def set_warning_method(method):
38
"""Set the warning method to be used by this module.
40
It should take a message and a warning category as warnings.warn does.
46
# TODO - maybe this would be easier to use as one 'smart' method that
47
# guess if it is a method or a class or an attribute ? If so, we can
48
# add that on top of the primitives, once we have all three written
51
def deprecated_function(deprecation_version):
52
"""Decorate a function so that use of it will trigger a warning."""
54
def function_decorator(callable):
55
"""This is the function python calls to perform the decoration."""
57
def decorated_function(*args, **kwargs):
58
"""This is the decorated function."""
59
symbol = "%s.%s" % (callable.__module__,
62
warn(deprecation_version % symbol, DeprecationWarning)
63
return callable(*args, **kwargs)
64
_populate_decorated(callable, deprecation_version, "function",
66
return decorated_function
67
return function_decorator
70
def deprecated_method(deprecation_version):
71
"""Decorate a method so that use of it will trigger a warning.
73
To deprecate an entire class, decorate __init__.
76
def method_decorator(callable):
77
"""This is the function python calls to perform the decoration."""
79
def decorated_method(self, *args, **kwargs):
80
"""This is the decorated method."""
81
symbol = "%s.%s.%s" % (self.__class__.__module__,
82
self.__class__.__name__,
85
warn(deprecation_version % symbol, DeprecationWarning)
86
return callable(self, *args, **kwargs)
87
_populate_decorated(callable, deprecation_version, "method",
89
return decorated_method
90
return method_decorator
93
def deprecated_passed(parameter_value):
94
"""Return True if parameter_value was used."""
95
# FIXME: it might be nice to have a parameter deprecation decorator.
96
# it would need to handle positional and *args and **kwargs parameters,
97
# which means some mechanism to describe how the parameter was being
98
# passed before deprecation, and some way to deprecate parameters that
99
# were not at the end of the arg list. Thats needed for __init__ where
100
# we cannot just forward to a new method name.I.e. in the following
101
# examples we would want to have callers that pass any value to 'bad' be
102
# given a warning - because we have applied:
103
# @deprecated_parameter('bad', zero_seven)
105
# def __init__(self, bad=None)
106
# def __init__(self, bad, other)
107
# def __init__(self, **kwargs)
109
return not parameter_value is deprecated_nonce
112
def _decorate_docstring(callable, deprecation_version, label,
114
docstring_lines = callable.__doc__.split('\n')
115
if len(docstring_lines) == 0:
116
decorated_callable.__doc__ = deprecation_version % ("This " + label)
117
elif len(docstring_lines) == 1:
118
decorated_callable.__doc__ = (callable.__doc__
121
+ deprecation_version % ("This " + label)
124
spaces = len(docstring_lines[-1])
125
new_doc = callable.__doc__
126
new_doc += "\n" + " " * spaces
127
new_doc += deprecation_version % ("This " + label)
128
new_doc += "\n" + " " * spaces
129
decorated_callable.__doc__ = new_doc
132
def _populate_decorated(callable, deprecation_version, label,
134
"""Populate attributes like __name__ and __doc__ on the decorated callable.
136
_decorate_docstring(callable, deprecation_version, label,
138
decorated_callable.__module__ = callable.__module__
139
decorated_callable.__name__ = callable.__name__
added
removed
bzrlib/symbol_versioning.py
