Skip to content

Api Resource

ApiResource

Bases: Resource

Source code in src/hassette/core/api_resource.py
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
class ApiResource(Resource):
    depends_on: ClassVar[list[type[Resource]]] = [WebsocketService]

    _stack: AsyncExitStack
    """Async context stack for managing resources."""

    _session: aiohttp.ClientSession | None
    """HTTP client session for making requests."""

    def __init__(
        self,
        hassette: "Hassette",
        *,
        parent: "Resource | None" = None,
        rest_url: str | None = None,
        headers_factory: Callable[[], dict[str, str]] | None = None,
    ) -> None:
        super().__init__(hassette, parent=parent)
        self._stack = AsyncExitStack()
        self._session = None
        self._rest_url_override: str | None = rest_url
        self._headers_factory: Callable[[], dict[str, str]] | None = headers_factory

    async def on_initialize(self):
        """
        Start the API service.

        WebsocketService is guaranteed ready by depends_on auto-wait.
        """
        # Use injected overrides when provided; fall back to config-derived properties.
        rest_url = self._rest_url_override if self._rest_url_override is not None else self._rest_url
        headers = self._headers_factory() if self._headers_factory is not None else self._headers
        await self._stack.__aenter__()
        self._session = await self._stack.enter_async_context(aiohttp.ClientSession(headers=headers, base_url=rest_url))
        self.mark_ready(reason="API session initialized")

    async def on_shutdown(self) -> None:
        await self._stack.aclose()
        await asyncio.sleep(_SSL_SHUTDOWN_DELAY if self.hassette.config.verify_ssl else 0)

    @property
    def config_log_level(self) -> LOG_LEVEL_TYPE:
        return self.hassette.config.logging.api

    @property
    def _headers(self) -> dict[str, str]:
        """Get the headers for this API instance."""
        return self.hassette.config.headers

    @property
    def _rest_url(self) -> str:
        """Get the REST URL for this API instance."""
        return self.hassette.rest_url

    @property
    def _ws_conn(self) -> "WebsocketService":
        """Get the WebSocket connection for this API instance."""
        assert self.hassette._websocket_service is not None
        return self.hassette._websocket_service

    async def _rest_request(
        self,
        method: str,
        url: str,
        params: dict[str, Any] | None = None,
        data: dict[str, Any] | None = None,
        suppress_error_message: bool = False,
        **kwargs,
    ) -> aiohttp.ClientResponse:
        """Make a REST request to the Home Assistant API."""

        # inner function to allow retry decorator to use `self`
        @retry(
            retry=(retry_if_not_exception_type(NOT_RETRYABLE) | retry_if_exception_type(RETRYABLE)),
            wait=wait_exponential_jitter(),
            stop=stop_after_attempt(MAX_RETRY_ATTEMPTS),
            before_sleep=before_sleep_log(self.logger, logging.WARNING),
            reraise=True,
        )
        async def inner_request(
            method: str,
            url: str,
            params: dict[str, Any] | None = None,
            data: dict[str, Any] | None = None,
            suppress_error_message: bool = False,
            **kwargs,
        ) -> aiohttp.ClientResponse:
            if self._session is None or self._session.closed:
                raise ResourceNotReadyError("Client session is not connected")

            params = clean_kwargs(**(params or {}))
            str_data = orjson_dump(data or {})

            request_kwargs = {}

            if str_data:
                request_kwargs["data"] = str_data
                request_kwargs["headers"] = {"Content-Type": "application/json"}

            if params:
                request_kwargs["params"] = params

            try:
                response = await self._session.request(
                    method, url, ssl=self.hassette.config.verify_ssl, **request_kwargs, **kwargs
                )
                self.logger.debug("Making %s request to %s with data %s", method, response.real_url, str_data)
                response.raise_for_status()

                return response
            except aiohttp.ClientResponseError as e:
                if e.status == 404:
                    if not suppress_error_message:
                        self.logger.error(
                            "Error occurred while making %s request to %s: %s", method, url, e, stacklevel=2
                        )

                    raise EntityNotFoundError(f"Entity not found: {url}") from None
                raise

            except aiohttp.ClientError as e:
                if not suppress_error_message:
                    self.logger.error("Error occurred while making %s request to %s: %s", method, url, e, stacklevel=2)

                raise

        return await inner_request(
            method, url, params=params, data=data, suppress_error_message=suppress_error_message, **kwargs
        )

    async def _get_history_raw(
        self,
        entity_id: str,
        start_time: PlainDateTime | ZonedDateTime | Date | str,
        end_time: PlainDateTime | ZonedDateTime | Date | str | None = None,
        significant_changes_only: bool = False,
        minimal_response: bool = False,
        no_attributes: bool = False,
    ) -> list[list[dict[str, Any]]]:
        """Get the history of a specific entity."""

        url = f"history/period/{format_time_param(start_time)}"

        params = {
            "filter_entity_id": entity_id,
            "end_time": end_time,
            "significant_changes_only": significant_changes_only,
            "minimal_response": minimal_response,
            "no_attributes": no_attributes,
        }
        # having parameters like `minimal_response` in the parameters changes the response format
        # regardless of whether they are set to True or False
        # so we remove them if they are False
        params = {k: v for k, v in params.items() if v is not False}

        response = await self._rest_request("GET", url, params=params)

        entries = await response.json()

        normalized = normalize_history(entries)

        return normalized

on_initialize() async

Start the API service.

WebsocketService is guaranteed ready by depends_on auto-wait.

Source code in src/hassette/core/api_resource.py
75
76
77
78
79
80
81
82
83
84
85
86
async def on_initialize(self):
    """
    Start the API service.

    WebsocketService is guaranteed ready by depends_on auto-wait.
    """
    # Use injected overrides when provided; fall back to config-derived properties.
    rest_url = self._rest_url_override if self._rest_url_override is not None else self._rest_url
    headers = self._headers_factory() if self._headers_factory is not None else self._headers
    await self._stack.__aenter__()
    self._session = await self._stack.enter_async_context(aiohttp.ClientSession(headers=headers, base_url=rest_url))
    self.mark_ready(reason="API session initialized")