← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/symbol_versioning.py

(vila) Revise legal option names to be less drastic. (Vincent Ladeuil)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/symbol_versioning.py
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 bzrlib can call it even if we redefine it
32
37
from warnings import warn
33
38
 
34
39
import bzrlib
296
301
    :param error_only: Only match an 'error' filter
297
302
    :return: True if a filter is found, False otherwise
298
303
    """
299
 
    import warnings
300
304
    for filter in warnings.filters:
301
305
        if issubclass(DeprecationWarning, filter[2]):
302
306
            # This filter will effect DeprecationWarning
305
309
    return False
306
310
 
307
311
 
 
312
def _remove_filter_callable(filter):
 
313
    """Build and returns a callable removing filter from the warnings.
 
314
 
 
315
    :param filter: The filter to remove (can be None).
 
316
 
 
317
    :return: A callable that will remove filter from warnings.filters.
 
318
    """
 
319
    def cleanup():
 
320
        if filter:
 
321
            warnings.filters.remove(filter)
 
322
    return cleanup
 
323
 
 
324
 
308
325
def suppress_deprecation_warnings(override=True):
309
326
    """Call this function to suppress all deprecation warnings.
310
327
 
314
331
 
315
332
    :param override: If True, always set the ignore, if False, only set the
316
333
        ignore if there isn't already a filter.
 
334
 
317
335
    :return: A callable to remove the new warnings this added.
318
336
    """
319
 
    import warnings
320
337
    if not override and _check_for_filter(error_only=False):
321
338
        # If there is already a filter effecting suppress_deprecation_warnings,
322
339
        # then skip it.
323
 
        return
324
 
    warnings.filterwarnings('ignore', category=DeprecationWarning)
325
 
    filter = warnings.filters[0]
326
 
    def cleanup():
327
 
        warnings.filters.remove(filter)
328
 
    return cleanup
 
340
        filter = None
 
341
    else:
 
342
        warnings.filterwarnings('ignore', category=DeprecationWarning)
 
343
        filter = warnings.filters[0]
 
344
    return _remove_filter_callable(filter)
329
345
 
330
346
 
331
347
def activate_deprecation_warnings(override=True):
342
358
    :param override: If False, only add a filter if there isn't an error filter
343
359
        already. (This slightly differs from suppress_deprecation_warnings, in
344
360
        because it always overrides everything but -Werror).
 
361
 
 
362
    :return: A callable to remove the new warnings this added.
345
363
    """
346
 
    import warnings
347
364
    if not override and _check_for_filter(error_only=True):
348
365
        # DeprecationWarnings are already turned into errors, don't downgrade
349
366
        # them to 'default'.
350
 
        return
351
 
    warnings.filterwarnings('default', category=DeprecationWarning)
 
367
        filter = None
 
368
    else:
 
369
        warnings.filterwarnings('default', category=DeprecationWarning)
 
370
        filter = warnings.filters[0]
 
371
    return _remove_filter_callable(filter)