glances_api 0.5.0__tar.gz → 0.6.0__tar.gz

{glances_api-0.5.0 → glances_api-0.6.0}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017-2023 Fabian Affolter <fabian@affolter-engineering.ch>
+Copyright (c) 2017-2024 Fabian Affolter <fabian@affolter-engineering.ch>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

{glances_api-0.5.0 → glances_api-0.6.0}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.1
 Name: glances_api
-Version: 0.5.0
+Version: 0.6.0
 Summary: Python API for interacting with Glances
 Home-page: https://github.com/home-assistant-ecosystem/python-glances-api
 License: MIT
 Author: Fabian Affolter
 Author-email: fabian@affolter-engineering.ch
-Requires-Python: >=3.9,<4.0
+Requires-Python: >=3.11,<4.0
 Classifier: Development Status :: 3 - Alpha
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
@@ -15,9 +15,8 @@ Classifier: Operating System :: MacOS :: MacOS X
 Classifier: Operating System :: Microsoft :: Windows
 Classifier: Operating System :: POSIX
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Utilities
 Requires-Dist: httpx (>=0.23,<1)
 Project-URL: Repository, https://github.com/home-assistant-ecosystem/python-glances-api/releases

{glances_api-0.5.0 → glances_api-0.6.0}/glances_api/__init__.py

@@ -1,4 +1,5 @@
 """Client to interact with the Glances API."""
+
 from __future__ import annotations
 
 import logging
@@ -35,7 +36,7 @@ class Glances:
         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 +46,7 @@ class Glances:
         """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 +56,16 @@ class Glances:
             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 +82,11 @@ class Glances:
                 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."""
@@ -149,10 +154,11 @@ class Glances:
         if networks := self.data.get("network"):
             sensor_data["network"] = {}
             for network in networks:
+                time_since_update = network["time_since_update"]
                 sensor_data["network"][network["interface_name"]] = {
-                    "is_up": network["is_up"],
-                    "rx": round(network["rx"] / 1024, 1),
-                    "tx": round(network["tx"] / 1024, 1),
+                    "is_up": network.get("is_up"),
+                    "rx": round(network["rx"] / time_since_update),
+                    "tx": round(network["tx"] / time_since_update),
                     "speed": round(network["speed"] / 1024**3, 1),
                 }
         data = self.data.get("dockers") or self.data.get("containers")
@@ -178,11 +184,18 @@ class Glances:
         if data := self.data.get("gpu"):
             sensor_data["gpu"] = {}
             for sensor in data:
-                sensor_data["gpu"][f"GPU_{sensor['gpu_id']}__{sensor['name']}"] = {
-                    "name": sensor["name"],
-                    "temperature": sensor["temperature"],
-                    "mem": sensor["mem"],
-                    "proc": sensor["proc"],
-                    "fan_speed": sensor["fan_speed"] if "fan_speed" in sensor else 0,
+                sensor_data["gpu"][f"{sensor['name']} (GPU {sensor['gpu_id']})"] = {
+                    "temperature": sensor.get("temperature", 0),
+                    "mem": sensor.get("mem", 0),
+                    "proc": sensor.get("proc", 0),
+                    "fan_speed": sensor.get("fan_speed", 0),
+                }
+        if data := self.data.get("diskio"):
+            sensor_data["diskio"] = {}
+            for disk in data:
+                time_since_update = disk["time_since_update"]
+                sensor_data["diskio"][disk["disk_name"]] = {
+                    "read": round(disk["read_bytes"] / time_since_update),
+                    "write": round(disk["write_bytes"] / time_since_update),
                 }
         return sensor_data

{glances_api-0.5.0 → glances_api-0.6.0}/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

{glances_api-0.5.0 → glances_api-0.6.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "glances_api"
-version = "0.5.0"
+version = "0.6.0"
 description = "Python API for interacting with Glances"
 authors = ["Fabian Affolter <fabian@affolter-engineering.ch>"]
 homepage = "https://github.com/home-assistant-ecosystem/python-glances-api"
@@ -18,12 +18,12 @@ classifiers = [
 ]
 
 [tool.poetry.dependencies]
-python = "^3.9"
+python = "^3.11"
 httpx = ">=0.23,<1"
 
 [tool.poetry.dev-dependencies]
-black = "^23.3"
-pytest = "^7.3.0"
+black = "^24.3"
+pytest = "^8"
 pytest-httpx = ">0.15,<1"
 pytest-asyncio = "^0.16.0"
 isort = "^5.10.0"