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
def deprecated_method(deprecation_version):
41
"""Decorate a method so that use of it will trigger a warning.
43
To deprecate an entire class, decorate __init__.
46
def method_decorator(callable):
47
"""This is the function python calls to perform the decoration."""
49
def decorated_method(self, *args, **kwargs):
50
"""This is the decorated method."""
51
symbol = "%s.%s.%s" % (self.__class__.__module__,
52
self.__class__.__name__,
55
warn(deprecation_version % symbol, DeprecationWarning)
56
return callable(self, *args, **kwargs)
57
return decorated_method
58
return method_decorator
added
removed
bzrlib/symbol_versioning.py
