/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/symbol_versioning.py

  • Committer: Jelmer Vernooij
  • Date: 2018-09-30 00:33:53 UTC
  • mto: This revision was merged to the branch mainline in revision 7134.
  • Revision ID: jelmer@jelmer.uk-20180930003353-2z5sugalbxfxfiru
When opening working trees with .git files, open the right control transport.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/symbol_versioning.py
1
 
# Copyright (C) 2006, 2007, 2008, 2009 Canonical Ltd
 
1
# Copyright (C) 2006-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
19
19
The methods here allow for api symbol versioning.
20
20
"""
21
21
 
 
22
from __future__ import absolute_import
 
23
 
22
24
__all__ = ['deprecated_function',
23
25
           'deprecated_in',
24
26
           'deprecated_list',
29
31
           'warn',
30
32
           ]
31
33
 
 
34
 
 
35
import warnings
 
36
# Import the 'warn' symbol so breezy can call it even if we redefine it
32
37
from warnings import warn
33
38
 
34
 
import bzrlib
 
39
import breezy
35
40
 
 
41
from .sixish import PY3
36
42
 
37
43
DEPRECATED_PARAMETER = "A deprecated parameter marker."
38
44
 
44
50
    '%s was deprecated in version 1.4.0.'
45
51
    """
46
52
    return ("%%s was deprecated in version %s."
47
 
            % bzrlib._format_version_tuple(version_tuple))
 
53
            % breezy._format_version_tuple(version_tuple))
48
54
 
49
55
 
50
56
def set_warning_method(method):
70
76
        have a single %s operator in it. a_callable will be turned into a nice
71
77
        python symbol and then substituted into deprecation_version.
72
78
    """
73
 
    # We also want to handle old-style classes, in particular exception, and
74
 
    # they don't have an im_class attribute.
75
 
    if getattr(a_callable, 'im_class', None) is None:
 
79
    if getattr(a_callable, '__self__', None) is not None:
 
80
        symbol = "%s.%s.%s" % (a_callable.__self__.__class__.__module__,
 
81
                               a_callable.__self__.__class__.__name__,
 
82
                               a_callable.__name__)
 
83
    elif getattr(a_callable, '__qualname__', None) is not None and not '<' in a_callable.__qualname__:
 
84
        symbol = "%s.%s" % (a_callable.__module__,
 
85
                            a_callable.__qualname__)
 
86
    else:
76
87
        symbol = "%s.%s" % (a_callable.__module__,
77
88
                            a_callable.__name__)
78
 
    else:
79
 
        symbol = "%s.%s.%s" % (a_callable.im_class.__module__,
80
 
                               a_callable.im_class.__name__,
81
 
                               a_callable.__name__
82
 
                               )
83
89
    return deprecation_version % symbol
84
90
 
85
91
 
91
97
 
92
98
        def decorated_function(*args, **kwargs):
93
99
            """This is the decorated function."""
94
 
            from bzrlib import trace
 
100
            from . import trace
95
101
            trace.mutter_callsite(4, "Deprecated function called")
96
102
            warn(deprecation_string(callable, deprecation_version),
97
103
                DeprecationWarning, stacklevel=2)
119
125
 
120
126
        def decorated_method(self, *args, **kwargs):
121
127
            """This is the decorated method."""
122
 
            from bzrlib import trace
 
128
            from . import trace
123
129
            if callable.__name__ == '__init__':
124
130
                symbol = "%s.%s" % (self.__class__.__module__,
125
131
                                    self.__class__.__name__,
296
302
    :param error_only: Only match an 'error' filter
297
303
    :return: True if a filter is found, False otherwise
298
304
    """
299
 
    import warnings
300
305
    for filter in warnings.filters:
301
306
        if issubclass(DeprecationWarning, filter[2]):
302
307
            # This filter will effect DeprecationWarning
305
310
    return False
306
311
 
307
312
 
 
313
def _remove_filter_callable(filter):
 
314
    """Build and returns a callable removing filter from the warnings.
 
315
 
 
316
    :param filter: The filter to remove (can be None).
 
317
 
 
318
    :return: A callable that will remove filter from warnings.filters.
 
319
    """
 
320
    def cleanup():
 
321
        if filter:
 
322
            warnings.filters.remove(filter)
 
323
    return cleanup
 
324
 
 
325
 
308
326
def suppress_deprecation_warnings(override=True):
309
327
    """Call this function to suppress all deprecation warnings.
310
328
 
314
332
 
315
333
    :param override: If True, always set the ignore, if False, only set the
316
334
        ignore if there isn't already a filter.
 
335
 
 
336
    :return: A callable to remove the new warnings this added.
317
337
    """
318
 
    import warnings
319
338
    if not override and _check_for_filter(error_only=False):
320
339
        # If there is already a filter effecting suppress_deprecation_warnings,
321
340
        # then skip it.
322
 
        return
323
 
    warnings.filterwarnings('ignore', category=DeprecationWarning)
 
341
        filter = None
 
342
    else:
 
343
        warnings.filterwarnings('ignore', category=DeprecationWarning)
 
344
        filter = warnings.filters[0]
 
345
    return _remove_filter_callable(filter)
324
346
 
325
347
 
326
348
def activate_deprecation_warnings(override=True):
337
359
    :param override: If False, only add a filter if there isn't an error filter
338
360
        already. (This slightly differs from suppress_deprecation_warnings, in
339
361
        because it always overrides everything but -Werror).
 
362
 
 
363
    :return: A callable to remove the new warnings this added.
340
364
    """
341
 
    import warnings
342
365
    if not override and _check_for_filter(error_only=True):
343
366
        # DeprecationWarnings are already turned into errors, don't downgrade
344
367
        # them to 'default'.
345
 
        return
346
 
    warnings.filterwarnings('default', category=DeprecationWarning)
 
368
        filter = None
 
369
    else:
 
370
        warnings.filterwarnings('default', category=DeprecationWarning)
 
371
        filter = warnings.filters[0]
 
372
    return _remove_filter_callable(filter)