← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/symbol_versioning.py

  • Committer: Aaron Bentley
  • Date: 2007-12-21 06:34:27 UTC
  • mto: This revision was merged to the branch mainline in revision 3140.
  • Revision ID: aaron.bentley@utoronto.ca-20071221063427-pavy148wf806gf11
https://launchpad.net/bugs/177592
Fix commit for a checkout sharing a repo with its branch (abentley, #177592)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/symbol_versioning.py
1
 
# Copyright (C) 2006, 2007, 2008, 2009 Canonical Ltd
 
1
# Copyright (C) 2006, 2007 Canonical Ltd
 
2
#   Authors: Robert Collins <robert.collins@canonical.com> and others
2
3
#
3
4
# This program is free software; you can redistribute it and/or modify
4
5
# it under the terms of the GNU General Public License as published by
12
13
#
13
14
# You should have received a copy of the GNU General Public License
14
15
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
17
 
17
18
"""Symbol versioning
18
19
 
20
21
"""
21
22
 
22
23
__all__ = ['deprecated_function',
23
 
           'deprecated_in',
24
24
           'deprecated_list',
25
25
           'deprecated_method',
26
26
           'DEPRECATED_PARAMETER',
27
27
           'deprecated_passed',
28
 
           'set_warning_method',
29
 
           'warn',
 
28
           'warn', 'set_warning_method', 'zero_seven',
 
29
           'zero_eight',
 
30
           'zero_nine',
 
31
           'zero_ten',
 
32
           'zero_eleven',
 
33
           'zero_twelve',
 
34
           'zero_thirteen',
 
35
           'zero_fourteen',
 
36
           'zero_fifteen',
 
37
           'zero_sixteen',
 
38
           'zero_seventeen',
 
39
           'zero_eighteen',
 
40
           'zero_ninety',
 
41
           'zero_ninetyone',
 
42
           'zero_ninetytwo',
 
43
           'zero_ninetythree',
 
44
           'one_zero',
 
45
           'one_one',
30
46
           ]
31
47
 
32
48
from warnings import warn
33
49
 
34
 
import bzrlib
35
 
 
36
50
 
37
51
DEPRECATED_PARAMETER = "A deprecated parameter marker."
38
 
 
39
 
 
40
 
def deprecated_in(version_tuple):
41
 
    """Generate a message that something was deprecated in a release.
42
 
 
43
 
    >>> deprecated_in((1, 4, 0))
44
 
    '%s was deprecated in version 1.4.0.'
45
 
    """
46
 
    return ("%%s was deprecated in version %s."
47
 
            % bzrlib._format_version_tuple(version_tuple))
 
52
zero_seven = "%s was deprecated in version 0.7."
 
53
zero_eight = "%s was deprecated in version 0.8."
 
54
zero_nine = "%s was deprecated in version 0.9."
 
55
zero_ten = "%s was deprecated in version 0.10."
 
56
zero_eleven = "%s was deprecated in version 0.11."
 
57
zero_twelve = "%s was deprecated in version 0.12."
 
58
zero_thirteen = "%s was deprecated in version 0.13."
 
59
zero_fourteen = "%s was deprecated in version 0.14."
 
60
zero_fifteen = "%s was deprecated in version 0.15."
 
61
zero_sixteen = "%s was deprecated in version 0.16."
 
62
zero_seventeen = "%s was deprecated in version 0.17."
 
63
zero_eighteen = "%s was deprecated in version 0.18."
 
64
zero_ninety = "%s was deprecated in version 0.90."
 
65
zero_ninetyone = "%s was deprecated in version 0.91."
 
66
zero_ninetytwo = "%s was deprecated in version 0.92."
 
67
one_zero = "%s was deprecated in version 1.0."
 
68
zero_ninetythree = one_zero # Maintained for backwards compatibility
 
69
one_one = "%s was deprecated in version 1.1."
48
70
 
49
71
 
50
72
def set_warning_method(method):
88
110
 
89
111
    def function_decorator(callable):
90
112
        """This is the function python calls to perform the decoration."""
91
 
 
 
113
        
92
114
        def decorated_function(*args, **kwargs):
93
115
            """This is the decorated function."""
94
 
            from bzrlib import trace
95
 
            trace.mutter_callsite(4, "Deprecated function called")
96
116
            warn(deprecation_string(callable, deprecation_version),
97
117
                DeprecationWarning, stacklevel=2)
98
118
            return callable(*args, **kwargs)
105
125
def deprecated_method(deprecation_version):
106
126
    """Decorate a method so that use of it will trigger a warning.
107
127
 
108
 
    To deprecate a static or class method, use
 
128
    To deprecate a static or class method, use 
109
129
 
110
130
        @staticmethod
111
131
        @deprecated_function
112
132
        def ...
113
 
 
 
133
    
114
134
    To deprecate an entire class, decorate __init__.
115
135
    """
116
136
 
117
137
    def method_decorator(callable):
118
138
        """This is the function python calls to perform the decoration."""
119
 
 
 
139
        
120
140
        def decorated_method(self, *args, **kwargs):
121
141
            """This is the decorated method."""
122
 
            from bzrlib import trace
123
142
            if callable.__name__ == '__init__':
124
143
                symbol = "%s.%s" % (self.__class__.__module__,
125
144
                                    self.__class__.__name__,
129
148
                                       self.__class__.__name__,
130
149
                                       callable.__name__
131
150
                                       )
132
 
            trace.mutter_callsite(4, "Deprecated method called")
133
151
            warn(deprecation_version % symbol, DeprecationWarning, stacklevel=2)
134
152
            return callable(self, *args, **kwargs)
135
153
        _populate_decorated(callable, deprecation_version, "method",
140
158
 
141
159
def deprecated_passed(parameter_value):
142
160
    """Return True if parameter_value was used."""
143
 
    # FIXME: it might be nice to have a parameter deprecation decorator.
 
161
    # FIXME: it might be nice to have a parameter deprecation decorator. 
144
162
    # it would need to handle positional and *args and **kwargs parameters,
145
163
    # which means some mechanism to describe how the parameter was being
146
164
    # passed before deprecation, and some way to deprecate parameters that
148
166
    # we cannot just forward to a new method name.I.e. in the following
149
167
    # examples we would want to have callers that pass any value to 'bad' be
150
168
    # given a warning - because we have applied:
151
 
    # @deprecated_parameter('bad', deprecated_in((1, 5, 0))
 
169
    # @deprecated_parameter('bad', zero_seven)
152
170
    #
153
171
    # def __init__(self, bad=None)
154
172
    # def __init__(self, bad, other)
166
184
    if len(docstring_lines) == 0:
167
185
        decorated_callable.__doc__ = deprecation_version % ("This " + label)
168
186
    elif len(docstring_lines) == 1:
169
 
        decorated_callable.__doc__ = (callable.__doc__
 
187
        decorated_callable.__doc__ = (callable.__doc__ 
170
188
                                    + "\n"
171
189
                                    + "\n"
172
190
                                    + deprecation_version % ("This " + label)
216
234
        ):
217
235
        """Create a dict that warns when read or modified.
218
236
 
219
 
        :param deprecation_version: string for the warning format to raise,
220
 
            typically from deprecated_in()
 
237
        :param deprecation_version: something like zero_nine
221
238
        :param initial_value: The contents of the dict
222
239
        :param variable_name: This allows better warnings to be printed
223
 
        :param advice: String of advice on what callers should do instead
 
240
        :param advice: String of advice on what callers should do instead 
224
241
            of using this variable.
225
242
        """
226
243
        self._deprecation_version = deprecation_version
242
259
                    initial_value, extra=None):
243
260
    """Create a list that warns when modified
244
261
 
245
 
    :param deprecation_version: string for the warning format to raise,
246
 
        typically from deprecated_in()
 
262
    :param deprecation_version: something like zero_nine
247
263
    :param initial_value: The contents of the list
248
264
    :param variable_name: This allows better warnings to be printed
249
265
    :param extra: Extra info to print when printing a warning
262
278
        def _warn_deprecated(self, func, *args, **kwargs):
263
279
            warn(msg, DeprecationWarning, stacklevel=3)
264
280
            return func(self, *args, **kwargs)
265
 
 
 
281
            
266
282
        def append(self, obj):
267
283
            """appending to %s is deprecated""" % (variable_name,)
268
284
            return self._warn_deprecated(list.append, obj)
280
296
            return self._warn_deprecated(list.remove, value)
281
297
 
282
298
        def pop(self, index=None):
283
 
            """pop'ing from %s is deprecated""" % (variable_name,)
 
299
            """pop'ing from from %s is deprecated""" % (variable_name,)
284
300
            if index:
285
301
                return self._warn_deprecated(list.pop, index)
286
302
            else:
288
304
                return self._warn_deprecated(list.pop)
289
305
 
290
306
    return _DeprecatedList(initial_value)
291
 
 
292
 
 
293
 
def _check_for_filter(error_only):
294
 
    """Check if there is already a filter for deprecation warnings.
295
 
 
296
 
    :param error_only: Only match an 'error' filter
297
 
    :return: True if a filter is found, False otherwise
298
 
    """
299
 
    import warnings
300
 
    for filter in warnings.filters:
301
 
        if issubclass(DeprecationWarning, filter[2]):
302
 
            # This filter will effect DeprecationWarning
303
 
            if not error_only or filter[0] == 'error':
304
 
                return True
305
 
    return False
306
 
 
307
 
 
308
 
def suppress_deprecation_warnings(override=True):
309
 
    """Call this function to suppress all deprecation warnings.
310
 
 
311
 
    When this is a final release version, we don't want to annoy users with
312
 
    lots of deprecation warnings. We only want the deprecation warnings when
313
 
    running a dev or release candidate.
314
 
 
315
 
    :param override: If True, always set the ignore, if False, only set the
316
 
        ignore if there isn't already a filter.
317
 
    """
318
 
    import warnings
319
 
    if not override and _check_for_filter(error_only=False):
320
 
        # If there is already a filter effecting suppress_deprecation_warnings,
321
 
        # then skip it.
322
 
        return
323
 
    warnings.filterwarnings('ignore', category=DeprecationWarning)
324
 
 
325
 
 
326
 
def activate_deprecation_warnings(override=True):
327
 
    """Call this function to activate deprecation warnings.
328
 
 
329
 
    When running in a 'final' release we suppress deprecation warnings.
330
 
    However, the test suite wants to see them. So when running selftest, we
331
 
    re-enable the deprecation warnings.
332
 
 
333
 
    Note: warnings that have already been issued under 'ignore' will not be
334
 
    reported after this point. The 'warnings' module has already marked them as
335
 
    handled, so they don't get issued again.
336
 
 
337
 
    :param override: If False, only add a filter if there isn't an error filter
338
 
        already. (This slightly differs from suppress_deprecation_warnings, in
339
 
        because it always overrides everything but -Werror).
340
 
    """
341
 
    import warnings
342
 
    if not override and _check_for_filter(error_only=True):
343
 
        # DeprecationWarnings are already turned into errors, don't downgrade
344
 
        # them to 'default'.
345
 
        return
346
 
    warnings.filterwarnings('default', category=DeprecationWarning)