45 lines
1.1 KiB
Python
45 lines
1.1 KiB
Python
"""The module contains miscellaneous helpers.
|
|
It's not considered part of the public ufoLib API.
|
|
"""
|
|
import warnings
|
|
import functools
|
|
|
|
|
|
def deprecated(msg=""):
|
|
"""Decorator factory to mark functions as deprecated with given message.
|
|
|
|
>>> @deprecated("Enough!")
|
|
... def some_function():
|
|
... "I just print 'hello world'."
|
|
... print("hello world")
|
|
>>> some_function()
|
|
hello world
|
|
>>> warnings.simplefilter("error", DeprecationWarning)
|
|
>>> some_function()
|
|
Traceback (most recent call last):
|
|
...
|
|
DeprecationWarning: some_function function is a deprecated. Enough!
|
|
>>> some_function.__doc__
|
|
"I just print 'hello world'."
|
|
"""
|
|
|
|
def deprecated_decorator(func):
|
|
@functools.wraps(func)
|
|
def wrapper(*args, **kwargs):
|
|
warnings.warn(
|
|
"{} function is a deprecated. {}".format(func.__name__, msg),
|
|
category=DeprecationWarning,
|
|
stacklevel=2,
|
|
)
|
|
return func(*args, **kwargs)
|
|
|
|
return wrapper
|
|
|
|
return deprecated_decorator
|
|
|
|
|
|
if __name__ == "__main__":
|
|
import doctest
|
|
|
|
doctest.testmod()
|