glances_api 0.4.3__tar.gz → 0.5.1__tar.gz

{glances_api-0.4.3 → glances_api-0.5.1}/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.4.3 → glances_api-0.5.1}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.1
-Name: glances-api
-Version: 0.4.3
+Name: glances_api
+Version: 0.5.1
 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.4.3 → glances_api-0.5.1}/glances_api/__init__.py

@@ -18,7 +18,7 @@ class Glances:
         self,
         host: str = "localhost",
         port: int = 61208,
-        version: int = 2,
+        version: int = 3,
         ssl: bool = False,
         verify_ssl: bool = True,
         username: str | None = None,
@@ -26,11 +26,16 @@ class Glances:
         httpx_client: httpx.AsyncClient | None = None,
     ):
         """Initialize the connection."""
+        if version == 2:
+            _LOGGER.warning(
+                "Glances api older than v3 will not be supported in the next release."
+            )
+
         schema = "https" if ssl else "http"
         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
@@ -40,7 +45,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)
@@ -50,12 +55,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(
@@ -72,11 +81,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."""
@@ -88,7 +97,7 @@ class Glances:
         else:
             raise exceptions.GlancesApiError("Element data not available")
 
-    async def get_ha_sensor_data(self) -> dict[str, Any] | None:
+    async def get_ha_sensor_data(self) -> dict[str, Any]:
         """Create a dictionary with data for Home Assistant sensors."""
         await self.get_data("all")
 
@@ -135,18 +144,27 @@ class Glances:
             }
         if data := self.data.get("quicklook"):
             sensor_data["cpu"] = {"cpu_use_percent": data["cpu"]}
+        if data := self.data.get("percpu"):
+            sensor_data["percpu"] = {}
+            for cpu in data:
+                sensor_data["percpu"][str(cpu["cpu_number"])] = {
+                    "cpu_use_percent": cpu["total"]
+                }
         if networks := self.data.get("network"):
             sensor_data["network"] = {}
             for network in networks:
                 sensor_data["network"][network["interface_name"]] = {
-                    "is_up": network["is_up"],
+                    "is_up": network.get("is_up"),
                     "rx": round(network["rx"] / 1024, 1),
                     "tx": round(network["tx"] / 1024, 1),
                     "speed": round(network["speed"] / 1024**3, 1),
                 }
-        if "docker" in self.data and (data := self.data["docker"].get("containers")):
+        data = self.data.get("dockers") or self.data.get("containers")
+        if data and (containers_data := data.get("containers")):
             active_containers = [
-                container for container in data if container["Status"] == "running"
+                container
+                for container in containers_data
+                if container["Status"] == "running"
             ]
             sensor_data["docker"] = {"docker_active": len(active_containers)}
             cpu_use = 0.0
@@ -161,4 +179,14 @@ class Glances:
             sensor_data["raid"] = data
         if data := self.data.get("uptime"):
             sensor_data["uptime"] = data
+        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,
+                }
         return sensor_data

{glances_api-0.4.3 → glances_api-0.5.1}/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.4.3 → glances_api-0.5.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "glances_api"
-version = "0.4.3"
+version = "0.5.1"
 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,7 +18,7 @@ classifiers = [
 ]
 
 [tool.poetry.dependencies]
-python = "^3.9"
+python = "^3.11"
 httpx = ">=0.23,<1"
 
 [tool.poetry.dev-dependencies]