35 lines
1.3 KiB
Python
35 lines
1.3 KiB
Python
"""Typing helpers for Home Assistant tests."""
|
|
|
|
from __future__ import annotations
|
|
|
|
from collections.abc import Callable, Coroutine
|
|
from typing import TYPE_CHECKING, Any, TypeAlias
|
|
from unittest.mock import MagicMock
|
|
|
|
from aiohttp import ClientWebSocketResponse
|
|
from aiohttp.test_utils import TestClient
|
|
|
|
if TYPE_CHECKING:
|
|
# Local import to avoid processing recorder module when running a
|
|
# testcase which does not use the recorder.
|
|
from homeassistant.components.recorder import Recorder
|
|
|
|
|
|
class MockHAClientWebSocket(ClientWebSocketResponse):
|
|
"""Protocol for a wrapped ClientWebSocketResponse."""
|
|
|
|
client: TestClient
|
|
send_json_auto_id: Callable[[dict[str, Any]], Coroutine[Any, Any, None]]
|
|
|
|
|
|
ClientSessionGenerator = Callable[..., Coroutine[Any, Any, TestClient]]
|
|
MqttMockPahoClient = MagicMock
|
|
"""MagicMock for `paho.mqtt.client.Client`"""
|
|
MqttMockHAClient = MagicMock
|
|
"""MagicMock for `homeassistant.components.mqtt.MQTT`."""
|
|
MqttMockHAClientGenerator = Callable[..., Coroutine[Any, Any, MqttMockHAClient]]
|
|
"""MagicMock generator for `homeassistant.components.mqtt.MQTT`."""
|
|
RecorderInstanceGenerator: TypeAlias = Callable[..., Coroutine[Any, Any, "Recorder"]]
|
|
"""Instance generator for `homeassistant.components.recorder.Recorder`."""
|
|
WebSocketGenerator = Callable[..., Coroutine[Any, Any, MockHAClientWebSocket]]
|