Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 26 additions & 9 deletions homeassistant/helpers/deprecation.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
import functools
import inspect
import logging
from typing import Any, NamedTuple
from typing import Any, NamedTuple, cast


def deprecated_substitute[_ObjectT: object](
Expand Down Expand Up @@ -86,27 +86,44 @@ def get_deprecated(
return config.get(new_name, default)


def deprecated_class[**_P, _R](
def deprecated_class[_T](
replacement: str, *, breaks_in_ha_version: str | None = None
) -> Callable[[Callable[_P, _R]], Callable[_P, _R]]:
) -> Callable[[type[_T]], type[_T]]:
"""Mark class as deprecated and provide a replacement class to be used instead.

If the deprecated function was called from a custom integration, ask the user to
report an issue.
"""

def deprecated_decorator(cls: Callable[_P, _R]) -> Callable[_P, _R]:
def deprecated_decorator(cls: type[_T]) -> type[_T]:
"""Decorate class as deprecated."""
base_meta = type(cls)

@functools.wraps(cls)
def deprecated_cls(*args: _P.args, **kwargs: _P.kwargs) -> _R:
"""Wrap for the original class."""
def __call__(self: type[Any], *args: Any, **kwargs: Any) -> Any:
_print_deprecation_warning(
cls, replacement, "class", "instantiated", breaks_in_ha_version
)
return cls(*args, **kwargs)
return base_meta.__call__(self, *args, **kwargs)

deprecated_meta = type(
f"Deprecated{base_meta.__name__}",
(base_meta,),
{"__call__": __call__},
)

deprecated_cls = deprecated_meta(
cls.__name__,
(cls,),
{
"__module__": cls.__module__,
"__qualname__": cls.__qualname__,
"__doc__": cls.__doc__,
"__slots__": (),
"__wrapped__": cls,
},
)

return deprecated_cls
return cast(type[_T], deprecated_cls)

return deprecated_decorator

Expand Down
7 changes: 7 additions & 0 deletions tests/helpers/test_deprecation.py
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,10 @@ class MockDeprecatedClass:
"""Mock class for deprecated testing."""


class MockDeprecatedSubClass(MockDeprecatedClass):
"""Mock subclass for deprecated testing."""


@patch("logging.getLogger")
def test_deprecated_class(mock_get_logger) -> None:
"""Test deprecated class."""
Expand All @@ -131,6 +135,9 @@ def test_deprecated_class(mock_get_logger) -> None:
assert mock_logger.warning.called
assert len(mock_logger.warning.mock_calls) == 1

MockDeprecatedSubClass()
assert len(mock_logger.warning.mock_calls) == 2


@pytest.mark.parametrize(
("breaks_in_ha_version", "extra_msg"),
Expand Down