tools/update: add a typed inventory

Signed-off-by: Olivier Hoareau <olivier.hoareau@vates.tech>

Author: olivierh-pro

lib/tools/inventory.py

@@ -1,15 +1,24 @@
-"""Inventory for tools scripts.
-"""
+"""Inventory for tools scripts."""
+
 from __future__ import annotations
 
 import tomllib
 from pathlib import Path
 
 from lib.common import HostAddress
 
-def load_inventory(inventory_path: Path) -> dict[str, dict[str, list[str]]]:
+from typing import TypeAlias, TypedDict
+
+class Server(TypedDict):
+    enablerepos: list[str]
+
+
+Inventory: TypeAlias = dict[HostAddress, Server]
+
+
+def load_inventory(inventory_path: Path) -> Inventory:
     """Create an inventory object from loaded inventory file."""
-    inventory: dict[str, dict[str, list[str]]] = {}
+    inventory: Inventory = {}
 
     with open(inventory_path, "rb") as f:
         data = tomllib.load(f)
@@ -19,24 +28,21 @@ def load_inventory(inventory_path: Path) -> dict[str, dict[str, list[str]]]:
 
     for server, config in servers.items():
         repos = config.get("enablerepos", [])
-        host = {
-            "enablerepos": repos or all.get("enablerepos", [])
-        }
+        host: Server = {"enablerepos": repos or all.get("enablerepos", [])}
         inventory[server] = host
 
     return inventory
 
-def into_inventory(hosts: list[HostAddress], enablerepos: list[str]) -> dict[HostAddress, dict[str, list[str]]]:
+
+def into_inventory(hosts: list[HostAddress], enablerepos: list[str]) -> Inventory:
     """Create an inventory object from arguments.
 
     Basically, it is used as compatibility when we don't want inventory from file.
     """
-    inventory: dict[HostAddress, dict[str, list[str]]] = {}
+    inventory: Inventory = {}
 
     for h in hosts:
-        host = {
-            "enablerepos": enablerepos or [],
-        }
+        host: Server = {"enablerepos": enablerepos or []}
         inventory[h] = host
 
     return inventory