Add missing type hints and some code cleanup (#29)

Author: engrbm87

glances_api/__init__.py

@@ -35,7 +35,7 @@ def __init__(
         self.url = f"{schema}://{host}:{port}/api/{version}"
         self.data: dict[str, Any] = {}
         self.plugins: list[str] = []
-        self.values: Any | None = None
+        self.values: dict[str, Any] | None = None
         self.username = username
         self.password = password
         self.verify_ssl = verify_ssl
@@ -45,7 +45,7 @@ async def get_data(self, endpoint: str) -> None:
         """Retrieve the data."""
         url = f"{self.url}/{endpoint}"
 
-        httpx_client: Any = (
+        httpx_client = (
             self.httpx_client
             if self.httpx_client
             else httpx.AsyncClient(verify=self.verify_ssl)
@@ -55,12 +55,16 @@ async def get_data(self, endpoint: str) -> None:
             async with httpx_client as client:
                 if self.password is None:
                     response = await client.get(url)
-                else:
+                elif self.username is not None:
                     response = await client.get(
                         url, auth=(self.username, self.password)
                     )
-        except (httpx.ConnectError, httpx.TimeoutException):
-            raise exceptions.GlancesApiConnectionError(f"Connection to {url} failed")
+                else:
+                    raise ValueError("username and password must be provided.")
+        except (httpx.ConnectError, httpx.TimeoutException) as err:
+            raise exceptions.GlancesApiConnectionError(
+                f"Connection to {url} failed"
+            ) from err
 
         if response.status_code == httpx.codes.UNAUTHORIZED:
             raise exceptions.GlancesApiAuthorizationError(
@@ -77,11 +81,11 @@ async def get_data(self, endpoint: str) -> None:
                 self.data = response.json()
             elif endpoint == "pluginslist":
                 self.plugins = response.json()
-        except TypeError:
+        except TypeError as err:
             _LOGGER.error("Can not load data from Glances")
             raise exceptions.GlancesApiConnectionError(
                 "Unable to get the data from Glances"
-            )
+            ) from err
 
     async def get_metrics(self, element: str) -> None:
         """Get all the metrics for a monitored element."""

glances_api/exceptions.py

@@ -4,22 +4,14 @@
 class GlancesApiError(Exception):
     """General GlancesApiError exception occurred."""
 
-    pass
-
 
 class GlancesApiConnectionError(GlancesApiError):
     """When a connection error is encountered."""
 
-    pass
-
 
 class GlancesApiAuthorizationError(GlancesApiError):
     """When a connection error is encountered."""
 
-    pass
-
 
 class GlancesApiNoDataAvailable(GlancesApiError):
     """When no data is available."""
-
-    pass

tests/test_responses.py

@@ -1,8 +1,11 @@
 """Test the interaction with the Glances API."""
+from typing import Any
+
 import pytest
+from pytest_httpx import HTTPXMock
+
 from glances_api import Glances
 from glances_api.exceptions import GlancesApiNoDataAvailable
-from pytest_httpx import HTTPXMock
 
 PLUGINS_LIST_RESPONSE = [
     "alert",
@@ -17,7 +20,7 @@
     "fs",
 ]
 
-RESPONSE = {
+RESPONSE: dict[str, Any] = {
     "cpu": {
         "total": 10.6,
         "user": 7.6,
@@ -241,7 +244,7 @@
     "uptime": "3 days, 10:25:20",
 }
 
-HA_SENSOR_DATA = {
+HA_SENSOR_DATA: dict[str, Any] = {
     "fs": {
         "/ssl": {"disk_use": 30.7, "disk_use_percent": 6.7, "disk_free": 426.5},
         "/media": {"disk_use": 30.7, "disk_use_percent": 6.7, "disk_free": 426.5},
@@ -267,7 +270,7 @@
 
 
 @pytest.mark.asyncio
-async def test_non_existing_endpoint(httpx_mock: HTTPXMock):
+async def test_non_existing_endpoint(httpx_mock: HTTPXMock) -> None:
     """Test a non-exisiting endpoint."""
     httpx_mock.add_response(status_code=400)
 
@@ -279,7 +282,7 @@ async def test_non_existing_endpoint(httpx_mock: HTTPXMock):
 
 
 @pytest.mark.asyncio
-async def test_plugins_list(httpx_mock: HTTPXMock):
+async def test_plugins_list(httpx_mock: HTTPXMock) -> None:
     """Test the plugins list response."""
     httpx_mock.add_response(json=PLUGINS_LIST_RESPONSE)
 
@@ -290,19 +293,19 @@ async def test_plugins_list(httpx_mock: HTTPXMock):
 
 
 @pytest.mark.asyncio
-async def test_exisiting_endpoint(httpx_mock: HTTPXMock):
+async def test_exisiting_endpoint(httpx_mock: HTTPXMock) -> None:
     """Test the a valid endpoint."""
     httpx_mock.add_response(json=RESPONSE)
 
     client = Glances()
     await client.get_metrics("cpu")
-
+    assert client.values
     assert client.values["total"] == 10.6
     assert client.values["system"] == 2.1
 
 
 @pytest.mark.asyncio
-async def test_ha_sensor_data(httpx_mock: HTTPXMock):
+async def test_ha_sensor_data(httpx_mock: HTTPXMock) -> None:
     """Test the return value for ha sensors."""
     httpx_mock.add_response(json=RESPONSE)
 
@@ -315,21 +318,21 @@ async def test_ha_sensor_data(httpx_mock: HTTPXMock):
 @pytest.mark.asyncio
 async def test_ha_sensor_data_with_incomplete_container_information(
     httpx_mock: HTTPXMock,
-):
-    """Test the return value for ha sensors when container memory and cpu data is not exposed by glances."""
-    TEST_RESPONSE = RESPONSE
-    del TEST_RESPONSE["containers"]["containers"][0]["memory"]["usage"]
-    del TEST_RESPONSE["containers"]["containers"][0]["cpu"]["total"]
-    del TEST_RESPONSE["containers"]["containers"][1]["memory"]["usage"]
-    del TEST_RESPONSE["containers"]["containers"][1]["cpu"]["total"]
+) -> None:
+    """Test the return value for ha sensors when some data is not exposed."""
+    response = RESPONSE.copy()
+    del response["containers"]["containers"][0]["memory"]["usage"]
+    del response["containers"]["containers"][0]["cpu"]["total"]
+    del response["containers"]["containers"][1]["memory"]["usage"]
+    del response["containers"]["containers"][1]["cpu"]["total"]
 
-    TEST_HA_SENSOR_DATA = HA_SENSOR_DATA
-    TEST_HA_SENSOR_DATA["docker"]["docker_memory_use"] = 0
-    TEST_HA_SENSOR_DATA["docker"]["docker_cpu_use"] = 0
+    ha_sensor_data = HA_SENSOR_DATA.copy()
+    ha_sensor_data["docker"]["docker_memory_use"] = 0
+    ha_sensor_data["docker"]["docker_cpu_use"] = 0
 
-    httpx_mock.add_response(json=TEST_RESPONSE)
+    httpx_mock.add_response(json=response)
 
     client = Glances()
     result = await client.get_ha_sensor_data()
 
-    assert result == TEST_HA_SENSOR_DATA
+    assert result == ha_sensor_data

tests/test_timeout.py

@@ -7,7 +7,7 @@
 
 
 @pytest.mark.asyncio
-async def test_timeout(httpx_mock: HTTPXMock):
+async def test_timeout(httpx_mock: HTTPXMock) -> None:
     """Test if the connection is hitting the timeout."""
 
     def raise_timeout(request):