deprecate_settings()

Complexity

Conditions

7

Size

Total Lines

23

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	wrapping_function()	0	8	4
B	_deprecate_decorator()	0	14	6

from coalib.settings.FunctionMetadata import FunctionMetadata


def deprecate_settings(**depr_args):
    """
     The purpose of this decorator is to Allow passing old settings names to
     bears due to the heavy changes in their names.

     :param depr_args:     A dictionnary of settings as keys and their
                           deprecated names as values.
    """
    def _deprecate_decorator(func):
        def wrapping_function(*args, **kwargs):
            for arg, deprecated_arg in depr_args.items():
                if deprecated_arg in kwargs and arg not in kwargs:
                    print("The setting `{}` is deprecated. Please use `{}` "
                          "instead.".format(deprecated_arg, arg))
                    kwargs[arg] = kwargs[deprecated_arg]
                    del kwargs[deprecated_arg]
            return func(*args, **kwargs)
        wrapping_function.__metadata__ = FunctionMetadata.from_function(func)
        for arg, deprecated_arg in depr_args.items():
            wrapping_function.__metadata__.optional_params[deprecated_arg] = (
                wrapping_function.__metadata__.optional_params[arg])
        return wrapping_function
    return _deprecate_decorator