kuon.decorators

Complexity

Total Complexity

1

Size/Duplication

Total Lines	22
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes

0

1 Function

Rating	Name	Duplication	Size	Complexity
A	deprecated()	0	15	1

#!/usr/bin/python
# -*- coding: utf-8 -*-
import functools
import warnings


def deprecated(func):
    """This is a decorator which can be used to mark functions
    as deprecated. It will result in a warning being emitted
    when the function is used."""

    @functools.wraps(func)
    def new_func(*args, **kwargs):
        warnings.simplefilter('always', DeprecationWarning)  # turn off filter
        warnings.warn("Call to deprecated function {}.".format(func.__name__),
                      category=DeprecationWarning,
                      stacklevel=2)
        warnings.simplefilter('default', DeprecationWarning)  # reset filter
        return func(*args, **kwargs)

    return new_func