glances_api 0.3.6__tar.gz → 0.4.0__tar.gz

{glances_api-0.3.6 → glances_api-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: glances-api
-Version: 0.3.6
+Version: 0.4.0
 Summary: Python API for interacting with Glances
 Home-page: https://github.com/home-assistant-ecosystem/python-glances-api
 License: MIT

glances_api-0.4.0/glances_api/__init__.py

@@ -0,0 +1,153 @@
+"""Client to interact with the Glances API."""
+from __future__ import annotations
+
+import logging
+from typing import Any
+
+import httpx
+
+from . import exceptions
+
+_LOGGER = logging.getLogger(__name__)
+
+
+class Glances:
+    """A class for handling the data retrieval."""
+
+    def __init__(
+        self,
+        host: str = "localhost",
+        port: int = 61208,
+        version: int = 2,
+        ssl: bool = False,
+        verify_ssl: bool = True,
+        username: str | None = None,
+        password: str | None = None,
+        httpx_client: httpx.AsyncClient | None = None,
+    ):
+        """Initialize the connection."""
+        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.username = username
+        self.password = password
+        self.verify_ssl = verify_ssl
+        self.httpx_client = httpx_client
+
+    async def get_data(self, endpoint: str) -> None:
+        """Retrieve the data."""
+        url = f"{self.url}/{endpoint}"
+
+        httpx_client: Any = (
+            self.httpx_client
+            if self.httpx_client
+            else httpx.AsyncClient(verify=self.verify_ssl)
+        )
+
+        try:
+            async with httpx_client as client:
+                if self.password is None:
+                    response = await client.get(url)
+                else:
+                    response = await client.get(
+                        url, auth=(self.username, self.password)
+                    )
+        except (httpx.ConnectError, httpx.TimeoutException):
+            raise exceptions.GlancesApiConnectionError(f"Connection to {url} failed")
+
+        if response.status_code == httpx.codes.UNAUTHORIZED:
+            raise exceptions.GlancesApiAuthorizationError(
+                "Please check your credentials"
+            )
+        if response.status_code == httpx.codes.BAD_REQUEST:
+            raise exceptions.GlancesApiNoDataAvailable(
+                f"endpoint: '{endpoint}' is not valid"
+            )
+        if response.status_code == httpx.codes.OK:
+            try:
+                _LOGGER.debug(response.json())
+                if endpoint == "all":
+                    self.data = response.json()
+                elif endpoint == "pluginslist":
+                    self.plugins = response.json()
+            except TypeError:
+                _LOGGER.error("Can not load data from Glances")
+                raise exceptions.GlancesApiConnectionError(
+                    "Unable to get the data from Glances"
+                )
+
+    async def get_metrics(self, element: str) -> None:
+        """Get all the metrics for a monitored element."""
+        await self.get_data("all")
+        await self.get_data("pluginslist")
+
+        if element in self.plugins:
+            self.values = self.data[element]
+        else:
+            raise exceptions.GlancesApiError("Element data not available")
+
+    async def get_ha_sensor_data(self) -> dict[str, Any] | None:
+        """Create a dictionary with data for Home Assistant sensors."""
+        await self.get_data("all")
+
+        sensor_data: dict[str, Any] = {}
+
+        if disks := self.data.get("fs"):
+            sensor_data["fs"] = {}
+            for disk in disks:
+                disk_free = disk.get("free") or (disk["size"] - disk["used"])
+                sensor_data["fs"][disk["mnt_point"]] = {
+                    "disk_use": round(disk["used"] / 1024**3, 1),
+                    "disk_use_percent": disk["percent"],
+                    "disk_free": round(disk_free / 1024**3, 1),
+                }
+        if data := self.data.get("sensors"):
+            sensor_data["sensors"] = {}
+            for sensor in data:
+                sensor_data["sensors"][sensor["label"]] = {
+                    sensor["type"]: sensor["value"]
+                }
+        if data := self.data.get("mem"):
+            sensor_data["mem"] = {
+                "memory_use_percent": data["percent"],
+                "memory_use": round(data["used"] / 1024**2, 1),
+                "memory_free": round(data["free"] / 1024**2, 1),
+            }
+        if data := self.data.get("memswap"):
+            sensor_data["memswap"] = {
+                "swap_use_percent": data["percent"],
+                "swap_use": round(data["used"] / 1024**3, 1),
+                "swap_free": round(data["free"] / 1024**3, 1),
+            }
+        if data := self.data.get("load"):
+            sensor_data["load"] = {
+                "processor_load": data.get("min15")
+                or self.data["cpu"]["total"]  # to be checked
+            }
+        if data := self.data.get("processcount"):
+            sensor_data["processcount"] = {
+                "process_running": data["running"],
+                "process_total": data["total"],
+                "process_thread": data["thread"],
+                "process_sleeping": data["sleeping"],
+            }
+        if data := self.data.get("quicklook"):
+            sensor_data["cpu"] = {"cpu_use_percent": data["cpu"]}
+        if "docker" in self.data and (data := self.data["docker"].get("containers")):
+            active_containers = [
+                container for container in data if container["Status"] == "running"
+            ]
+            sensor_data["docker"] = {"docker_active": len(active_containers)}
+            cpu_use = 0.0
+            for container in active_containers:
+                cpu_use += container["cpu"]["total"]
+            sensor_data["docker"]["docker_cpu_use"] = round(cpu_use, 1)
+            mem_use = 0.0
+            for container in active_containers:
+                mem_use += container["memory"]["usage"]
+            sensor_data["docker"]["docker_memory_use"] = round(mem_use / 1024**2, 1)
+        if data := self.data.get("raid"):
+            sensor_data["raid"] = data
+        return sensor_data

{glances_api-0.3.6 → glances_api-0.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "glances_api"
-version = "0.3.6"
+version = "0.4.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"
@@ -27,6 +27,29 @@ pytest = "^6.2.5"
 pytest-httpx = ">0.15,<1"
 pytest-asyncio = "^0.16.0"
 isort = "^5.10.0"
+mypy = "^0.971"
+
+[tool.mypy]
+check_untyped_defs = true
+disallow_any_generics = true
+disallow_incomplete_defs = true
+disallow_untyped_defs = true
+mypy_path = "glances_api/"
+no_implicit_optional = true
+show_error_codes = true
+warn_unreachable = true
+warn_unused_ignores = true
+exclude = [
+    'pyproject.toml',
+]
+
+[[tool.mypy.overrides]]
+module = "tests.*"
+allow_untyped_defs = true
+
+[[tool.mypy.overrides]]
+module = "docs.*"
+ignore_errors = true
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]

{glances_api-0.3.6 → glances_api-0.4.0}/setup.py

@@ -12,7 +12,7 @@ install_requires = \
 
 setup_kwargs = {
     'name': 'glances-api',
-    'version': '0.3.6',
+    'version': '0.4.0',
     'description': 'Python API for interacting with Glances',
     'long_description': 'python-glances-api\n==================\n\nA Python client for interacting with `Glances <https://nicolargo.github.io/glances/>`_.\n\nThis module is not official, developed, supported or endorsed by Glances.\n\nInstallation\n------------\n\nThe module is available from the `Python Package Index <https://pypi.python.org/pypi>`_.\n\n.. code:: bash\n\n    $ pip3 install glances_api\n\nOr on a Fedora-based system or on a CentOS/RHEL machine with has EPEL enabled.\n\n.. code:: bash\n\n    $ sudo dnf -y install python3-glances-api\n\n\nFor Nix or NixOS is `pre-packed module <https://search.nixos.org/packages?channel=unstable&query=glances-api>`_\navailable. The lastest release is usually present in the ``unstable`` channel.\n\n.. code:: bash\n\n    $ nix-env -iA nixos.python3Packages.glances-api\n\nUsage\n-----\n\nThe file ``example.py`` contains an example about how to use this module.\n\nLicense\n-------\n\n``python-glances-api`` is licensed under MIT, for more details check LICENSE.\n',
     'author': 'Fabian Affolter',

glances_api-0.3.6/glances_api/__init__.py

@@ -1,86 +0,0 @@
-"""Client to interact with the Glances API."""
-import asyncio
-import logging
-
-import httpx
-
-from . import exceptions
-
-_LOGGER = logging.getLogger(__name__)
-_RESOURCE = "{schema}://{host}:{port}/api/{version}"
-
-
-class Glances(object):
-    """A class for handling the data retrieval."""
-
-    def __init__(
-        self,
-        host="localhost",
-        port=61208,
-        version=2,
-        ssl=False,
-        verify_ssl=True,
-        username=None,
-        password=None,
-        httpx_client=None,
-    ):
-        """Initialize the connection."""
-        schema = "https" if ssl else "http"
-        self.url = _RESOURCE.format(
-            schema=schema, host=host, port=port, version=version
-        )
-        self.plugins = None
-        self.values = None
-        self.username = username
-        self.password = password
-        self.verify_ssl = verify_ssl
-        self.httpx_client = httpx_client
-
-    async def get_data(self, endpoint):
-        """Retrieve the data."""
-        url = "{}/{}".format(self.url, endpoint)
-
-        httpx_client = (
-            self.httpx_client
-            if self.httpx_client
-            else httpx.AsyncClient(verify=self.verify_ssl)
-        )
-
-        try:
-            async with httpx_client as client:
-                if self.password is None:
-                    response = await client.get(str(url))
-                else:
-                    response = await client.get(
-                        str(url), auth=(self.username, self.password)
-                    )
-        except (httpx.ConnectError, httpx.TimeoutException):
-            raise exceptions.GlancesApiConnectionError(f"Connection to {url} failed")
-
-        if response.status_code == httpx.codes.UNAUTHORIZED:
-            raise exceptions.GlancesApiAuthorizationError(
-                "Please check your credentials"
-            )
-
-        if response.status_code == httpx.codes.OK:
-            try:
-                _LOGGER.debug(response.json())
-                if endpoint == "all":
-                    self.data = response.json()
-                if endpoint == "pluginslist":
-                    self.plugins = response.json()
-            except TypeError:
-                _LOGGER.error("Can not load data from Glances")
-                raise exceptions.GlancesApiConnectionError(
-                    "Unable to get the data from Glances"
-                )
-
-    async def get_metrics(self, element):
-        """Get all the metrics for a monitored element."""
-        await self.get_data("all")
-        await self.get_data("pluginslist")
-
-        if element in self.plugins:
-            self.values = self.data[element]
-        else:
-            raise exceptions.GlancesApiError("Element data not available")