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__ = ['warn', 'set_warning_method', 'zero_seven']
25
from warnings import warn
28
zero_seven = "%s was deprecated in version 0.7."
31
def set_warning_method(method):
32
"""Set the warning method to be used by this module.
34
It should take a message and a warning category as warnings.warn does.
40
# TODO - maybe this would be easier to use as one 'smart' method that
41
# guess if it is a method or a class or an attribute ? If so, we can
42
# add that on top of the primitives, once we have all three written
45
def deprecated_function(deprecation_version):
46
"""Decorate a function so that use of it will trigger a warning."""
48
def function_decorator(callable):
49
"""This is the function python calls to perform the decoration."""
51
def decorated_function(*args, **kwargs):
52
"""This is the decorated function."""
53
symbol = "%s.%s" % (callable.__module__,
56
warn(deprecation_version % symbol, DeprecationWarning)
57
return callable(*args, **kwargs)
58
_populate_decorated(callable, deprecation_version, "function",
60
return decorated_function
61
return function_decorator
64
def deprecated_method(deprecation_version):
65
"""Decorate a method so that use of it will trigger a warning.
67
To deprecate an entire class, decorate __init__.
70
def method_decorator(callable):
71
"""This is the function python calls to perform the decoration."""
73
def decorated_method(self, *args, **kwargs):
74
"""This is the decorated method."""
75
symbol = "%s.%s.%s" % (self.__class__.__module__,
76
self.__class__.__name__,
79
warn(deprecation_version % symbol, DeprecationWarning)
80
return callable(self, *args, **kwargs)
81
_populate_decorated(callable, deprecation_version, "method",
83
return decorated_method
84
return method_decorator
87
def _decorate_docstring(callable, deprecation_version, label,
89
docstring_lines = callable.__doc__.split('\n')
90
if len(docstring_lines) == 0:
91
decorated_callable.__doc__ = deprecation_version % ("This " + label)
92
elif len(docstring_lines) == 1:
93
decorated_callable.__doc__ = (callable.__doc__
96
+ deprecation_version % ("This " + label)
99
spaces = len(docstring_lines[-1])
100
new_doc = callable.__doc__
101
new_doc += "\n" + " " * spaces
102
new_doc += deprecation_version % ("This " + label)
103
new_doc += "\n" + " " * spaces
104
decorated_callable.__doc__ = new_doc
107
def _populate_decorated(callable, deprecation_version, label,
109
"""Populate attributes like __name__ and __doc__ on the decorated callable.
111
_decorate_docstring(callable, deprecation_version, label,
113
decorated_callable.__module__ = callable.__module__
114
decorated_callable.__name__ = callable.__name__
added
removed
bzrlib/symbol_versioning.py
