hojichar.utils.warn_deprecation

 1import inspect
 2import logging
 3import warnings
 4from collections.abc import Callable
 5from functools import wraps
 6from typing import Any
 7
 8logger = logging.getLogger(__name__)
 9
10
11def deprecated_since(version: str, alternative: str | None = None) -> Callable[[Any], Any]:
12    """
13    Decorator to mark functions or classes as deprecated since a given version,
14    emitting both a DeprecationWarning and a logging.warning().
15    """
16
17    def decorator(obj: Any) -> Any:
18        name = obj.__name__
19        msg = f"'{name}' is deprecated since version {version} and will be removed in a future release."
20        if alternative:
21            msg += f" Use '{alternative}' instead."
22
23        def _emit_warning() -> None:
24            warnings.warn(msg, category=DeprecationWarning, stacklevel=3)
25
26        if inspect.isclass(obj):
27            orig_init = obj.__init__
28
29            @wraps(orig_init)
30            def new_init(self, *args, **kwargs):  # type: ignore
31                _emit_warning()
32                return orig_init(self, *args, **kwargs)
33
34            obj.__init__ = new_init
35            return obj
36        else:
37
38            @wraps(obj)
39            def new_func(*args, **kwargs):  # type: ignore
40                _emit_warning()
41                return obj(*args, **kwargs)
42
43            return new_func
44
45    return decorator
def deprecated_since( version: str, alternative: str | None = None) -> collections.abc.Callable[[typing.Any], typing.Any]:
12def deprecated_since(version: str, alternative: str | None = None) -> Callable[[Any], Any]:
13    """
14    Decorator to mark functions or classes as deprecated since a given version,
15    emitting both a DeprecationWarning and a logging.warning().
16    """
17
18    def decorator(obj: Any) -> Any:
19        name = obj.__name__
20        msg = f"'{name}' is deprecated since version {version} and will be removed in a future release."
21        if alternative:
22            msg += f" Use '{alternative}' instead."
23
24        def _emit_warning() -> None:
25            warnings.warn(msg, category=DeprecationWarning, stacklevel=3)
26
27        if inspect.isclass(obj):
28            orig_init = obj.__init__
29
30            @wraps(orig_init)
31            def new_init(self, *args, **kwargs):  # type: ignore
32                _emit_warning()
33                return orig_init(self, *args, **kwargs)
34
35            obj.__init__ = new_init
36            return obj
37        else:
38
39            @wraps(obj)
40            def new_func(*args, **kwargs):  # type: ignore
41                _emit_warning()
42                return obj(*args, **kwargs)
43
44            return new_func
45
46    return decorator

Decorator to mark functions or classes as deprecated since a given version, emitting both a DeprecationWarning and a logging.warning().