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."
29
zero_eight = "%s was deprecated in version 0.8."
32
def set_warning_method(method):
33
"""Set the warning method to be used by this module.
35
It should take a message and a warning category as warnings.warn does.
41
# TODO - maybe this would be easier to use as one 'smart' method that
42
# guess if it is a method or a class or an attribute ? If so, we can
43
# add that on top of the primitives, once we have all three written
46
def deprecated_function(deprecation_version):
47
"""Decorate a function so that use of it will trigger a warning."""
49
def function_decorator(callable):
50
"""This is the function python calls to perform the decoration."""
52
def decorated_function(*args, **kwargs):
53
"""This is the decorated function."""
54
symbol = "%s.%s" % (callable.__module__,
57
warn(deprecation_version % symbol, DeprecationWarning)
58
return callable(*args, **kwargs)
59
_populate_decorated(callable, deprecation_version, "function",
61
return decorated_function
62
return function_decorator
65
def deprecated_method(deprecation_version):
66
"""Decorate a method so that use of it will trigger a warning.
68
To deprecate an entire class, decorate __init__.
71
def method_decorator(callable):
72
"""This is the function python calls to perform the decoration."""
74
def decorated_method(self, *args, **kwargs):
75
"""This is the decorated method."""
76
symbol = "%s.%s.%s" % (self.__class__.__module__,
77
self.__class__.__name__,
80
warn(deprecation_version % symbol, DeprecationWarning)
81
return callable(self, *args, **kwargs)
82
_populate_decorated(callable, deprecation_version, "method",
84
return decorated_method
85
return method_decorator
88
def _decorate_docstring(callable, deprecation_version, label,
90
docstring_lines = callable.__doc__.split('\n')
91
if len(docstring_lines) == 0:
92
decorated_callable.__doc__ = deprecation_version % ("This " + label)
93
elif len(docstring_lines) == 1:
94
decorated_callable.__doc__ = (callable.__doc__
97
+ deprecation_version % ("This " + label)
100
spaces = len(docstring_lines[-1])
101
new_doc = callable.__doc__
102
new_doc += "\n" + " " * spaces
103
new_doc += deprecation_version % ("This " + label)
104
new_doc += "\n" + " " * spaces
105
decorated_callable.__doc__ = new_doc
108
def _populate_decorated(callable, deprecation_version, label,
110
"""Populate attributes like __name__ and __doc__ on the decorated callable.
112
_decorate_docstring(callable, deprecation_version, label,
114
decorated_callable.__module__ = callable.__module__
115
decorated_callable.__name__ = callable.__name__
added
removed
bzrlib/symbol_versioning.py
