Add missing type hints to sidebar snapins

Change-Id: Ib9a9715624498239129f65e7f8e4f68ae8baf53d

Author: LarsMichelsen

cmk/gui/nagvis/_nagvis_maps.py

@@ -3,42 +3,44 @@
 # This file is part of Checkmk (https://checkmk.com). It is subject to the terms and
 # conditions defined in the file COPYING, which is part of this source code package.
 
+from collections.abc import Mapping
+from typing import Any
+
 from cmk.gui.config import Config
 from cmk.gui.htmllib.foldable_container import foldable_container
 from cmk.gui.htmllib.html import html
 from cmk.gui.http import request
 from cmk.gui.i18n import _
-from cmk.gui.sidebar._snapin._base import SidebarSnapin
-from cmk.gui.sidebar._snapin._helpers import footnotelinks
+from cmk.gui.sidebar import footnotelinks, PageHandlers, SidebarSnapin
 
 
 class NagVisMaps(SidebarSnapin):
     @staticmethod
-    def type_name():
+    def type_name() -> str:
         return "nagvis_maps"
 
     @classmethod
-    def title(cls):
+    def title(cls) -> str:
         return _("NagVis maps")
 
     @classmethod
-    def description(cls):
+    def description(cls) -> str:
         return _("List of available NagVis maps")
 
     @classmethod
-    def refresh_regularly(cls):
+    def refresh_regularly(cls) -> bool:
         return False
 
     def show(self, config: Config) -> None:
         html.div(_("Loading maps..."), class_="loading")
         html.javascript("cmk.sidebar.fetch_nagvis_snapin_contents()")
 
-    def page_handlers(self):
+    def page_handlers(self) -> PageHandlers:
         return {
             "ajax_nagvis_maps_snapin": self._ajax_show_nagvis_maps_snapin,
         }
 
-    def _ajax_show_nagvis_maps_snapin(self):
+    def _ajax_show_nagvis_maps_snapin(self) -> None:
         api_request = request.get_request()
         if api_request["type"] == "table":
             self._show_table(api_request)
@@ -51,7 +53,7 @@ def _ajax_show_nagvis_maps_snapin(self):
 
         self._show_footnote_links()
 
-    def _show_table(self, api_request):
+    def _show_table(self, api_request: Mapping[str, Any]) -> None:
         html.open_table(class_="allhosts")
         html.open_tbody()
 
@@ -63,9 +65,9 @@ def _show_table(self, api_request):
                 class_=[
                     "statebullet",
                     self._state_class(map_cfg),
-                    self._sub_state_class(map_cfg),
-                    self._stale_class(map_cfg),
-                ],
+                ]
+                + self._sub_state_class(map_cfg)
+                + self._stale_class(map_cfg),
                 title=self._state_title(map_cfg),
             )
             html.a(map_cfg["alias"], href=map_cfg["url"], class_="link", target="main")
@@ -75,7 +77,7 @@ def _show_table(self, api_request):
         html.close_tbody()
         html.close_table()
 
-    def _state_class(self, map_cfg):
+    def _state_class(self, map_cfg: Mapping[str, Any]) -> str:
         return {
             "OK": "state0",
             "UP": "state0",
@@ -86,19 +88,19 @@ def _state_class(self, map_cfg):
             "PENDING": "statep",
         }.get(map_cfg["summary_state"], "state3")
 
-    def _sub_state_class(self, map_cfg):
+    def _sub_state_class(self, map_cfg: Mapping[str, Any]) -> list[str]:
         if map_cfg["summary_in_downtime"]:
-            return "stated"
+            return ["stated"]
         if map_cfg["summary_problem_has_been_acknowledged"]:
-            return "statea"
-        return None
+            return ["statea"]
+        return []
 
-    def _stale_class(self, map_cfg):
+    def _stale_class(self, map_cfg: Mapping[str, Any]) -> list[str]:
         if map_cfg["summary_stale"]:
-            return "stale"
-        return None
+            return ["stale"]
+        return []
 
-    def _state_title(self, map_cfg):
+    def _state_title(self, map_cfg: Mapping[str, Any]) -> str:
         title = map_cfg["summary_state"]
 
         if map_cfg["summary_in_downtime"]:
@@ -115,16 +117,20 @@ def _state_title(self, map_cfg):
 
         return title
 
-    def _show_footnote_links(self):
+    def _show_footnote_links(self) -> None:
         edit_url = "../nagvis/"
         footnotelinks([(_("Edit"), edit_url)])
 
-    def _show_tree(self, api_request):
+    def _show_tree(self, api_request: Mapping[str, Any]) -> None:
         html.open_ul()
         self._show_tree_nodes(api_request["maps"]["maps"], api_request["maps"]["childs"])
         html.close_ul()
 
-    def _show_tree_nodes(self, maps, children):
+    def _show_tree_nodes(
+        self,
+        maps: Mapping[str, Mapping[str, Any]],
+        children: Mapping[str, Mapping[str, Mapping[str, Any]]],
+    ) -> None:
         for map_name, map_cfg in maps.items():
             html.open_li()
             if map_name in children:

cmk/gui/sidebar/_snapin/_groups.py

@@ -7,6 +7,7 @@
 
 from cmk.gui import sites
 from cmk.gui.config import Config
+from cmk.gui.groups import GroupType
 from cmk.gui.htmllib.html import html
 from cmk.gui.i18n import _
 from cmk.gui.utils.urls import urlencode
@@ -17,13 +18,22 @@
 
 class GroupSnapin(SidebarSnapin, abc.ABC):
     @abc.abstractmethod
-    def _group_type_ident(self):
-        raise NotImplementedError()
+    def _group_type_ident(self) -> str: ...
 
     def show(self, config: Config) -> None:
         group_type = self._group_type_ident()
+
+        grouped_type: GroupType
+        match group_type:
+            case "hostgroup":
+                grouped_type = "host"
+            case "servicegroup":
+                grouped_type = "service"
+            case _:
+                raise ValueError(f"Unknown group type: {group_type}")
+
         html.open_ul()
-        for name, alias in sites.all_groups(group_type.replace("group", "")):
+        for name, alias in sites.all_groups(grouped_type):
             url = f"view.py?view_name={group_type}&{group_type}={urlencode(name)}"
             bulletlink(alias or name, url)
         html.close_ul()
@@ -34,34 +44,34 @@ def refresh_on_restart(cls):
 
 
 class HostGroups(GroupSnapin):
-    def _group_type_ident(self):
+    def _group_type_ident(self) -> str:
         return "hostgroup"
 
     @staticmethod
-    def type_name():
+    def type_name() -> str:
         return "hostgroups"
 
     @classmethod
-    def title(cls):
+    def title(cls) -> str:
         return _("Host groups")
 
     @classmethod
-    def description(cls):
+    def description(cls) -> str:
         return _("Directs links to all host groups")
 
 
 class ServiceGroups(GroupSnapin):
-    def _group_type_ident(self):
+    def _group_type_ident(self) -> str:
         return "servicegroup"
 
     @staticmethod
-    def type_name():
+    def type_name() -> str:
         return "servicegroups"
 
     @classmethod
-    def title(cls):
+    def title(cls) -> str:
         return _("Service groups")
 
     @classmethod
-    def description(cls):
+    def description(cls) -> str:
         return _("Direct links to all service groups")

cmk/gui/sidebar/_snapin/_performance.py

@@ -16,23 +16,23 @@
 
 class Performance(SidebarSnapin):
     @staticmethod
-    def type_name():
+    def type_name() -> str:
         return "performance"
 
     @classmethod
-    def title(cls):
+    def title(cls) -> str:
         return _("Server performance")
 
     @classmethod
     def has_show_more_items(cls) -> bool:
         return True
 
     @classmethod
-    def description(cls):
+    def description(cls) -> str:
         return _("Live monitor of the overall performance of all monitoring servers")
 
     @classmethod
-    def refresh_regularly(cls):
+    def refresh_regularly(cls) -> bool:
         return True
 
     def show(self, config: Config) -> None:
@@ -94,7 +94,7 @@ def write_line(left, right, show_more):
         html.close_table()
 
     @classmethod
-    def refresh_on_restart(cls):
+    def refresh_on_restart(cls) -> bool:
         return True
 
     @classmethod

cmk/gui/sidebar/_snapin/_search.py

@@ -701,15 +701,15 @@ def __init__(self) -> None:
         super().__init__()
 
     @classmethod
-    def type_name(cls):
+    def type_name(cls) -> str:
         return "search"
 
     @classmethod
-    def title(cls):
+    def title(cls) -> str:
         return _("Quicksearch")
 
     @classmethod
-    def description(cls):
+    def description(cls) -> str:
         return _(
             "Interactive search field for direct access to monitoring instances (hosts, services, "
             "host and service groups).<br>You can use the following filters: <i>h:</i> Host,<br> "
@@ -908,7 +908,7 @@ def get_matches(
 
 
 class MatchPluginRegistry(cmk.ccc.plugin_registry.Registry[ABCMatchPlugin]):
-    def plugin_name(self, instance):
+    def plugin_name(self, instance: ABCMatchPlugin) -> str:
         return instance.name
 
     def get_livestatus_match_plugins(self) -> list[ABCLivestatusMatchPlugin]:

cmk/gui/sidebar/_snapin/_server_time.py

@@ -14,19 +14,19 @@
 
 class CurrentTime(SidebarSnapin):
     @staticmethod
-    def type_name():
+    def type_name() -> str:
         return "time"
 
     @classmethod
-    def title(cls):
+    def title(cls) -> str:
         return _("Server time")
 
     @classmethod
-    def description(cls):
+    def description(cls) -> str:
         return _("A large clock showing the current time of the web server")
 
     @classmethod
-    def refresh_regularly(cls):
+    def refresh_regularly(cls) -> bool:
         return True
 
     def show(self, config: Config) -> None:

cmk/gui/sidebar/_snapin/_site_status.py

@@ -18,25 +18,25 @@
 from cmk.gui.utils.html import HTML
 from cmk.gui.utils.urls import makeuri_contextless
 
-from ._base import SidebarSnapin
+from ._base import PageHandlers, SidebarSnapin
 from ._helpers import begin_footnote_links, end_footnote_links, link, render_link
 
 
 class SiteStatus(SidebarSnapin):
     @staticmethod
-    def type_name():
+    def type_name() -> str:
         return "sitestatus"
 
     @classmethod
-    def refresh_regularly(cls):
+    def refresh_regularly(cls) -> bool:
         return True
 
     @classmethod
-    def title(cls):
+    def title(cls) -> str:
         return _("Site status")
 
     @classmethod
-    def description(cls):
+    def description(cls) -> str:
         return _(
             "Connection state of each site and button for enabling "
             "and disabling the site connection"
@@ -118,13 +118,13 @@ def show(self, config: Config) -> None:
     def allowed_roles(cls) -> list[RoleName]:
         return ["user", "admin"]
 
-    def page_handlers(self):
+    def page_handlers(self) -> PageHandlers:
         return {
             "switch_site": self._ajax_switch_site,
             "set_all_sites": self._ajax_set_all_sites,
         }
 
-    def _ajax_switch_site(self):
+    def _ajax_switch_site(self) -> None:
         check_csrf_token()
         response.set_content_type("application/json")
         # _site_switch=sitename1:on,sitename2:off,...
@@ -146,7 +146,7 @@ def _ajax_switch_site(self):
 
             user.save_site_config()
 
-    def _ajax_set_all_sites(self):
+    def _ajax_set_all_sites(self) -> None:
         sites.update_site_states_from_dead_sites()
         new_state = request.var("_new_state")
 

cmk/gui/sidebar/_snapin/_speedometer.py

@@ -13,21 +13,21 @@
 from cmk.gui.theme.current_theme import theme
 from cmk.gui.type_defs import RoleName
 
-from ._base import SidebarSnapin
+from ._base import PageHandlers, SidebarSnapin
 from ._helpers import snapin_width
 
 
 class Speedometer(SidebarSnapin):
     @staticmethod
-    def type_name():
+    def type_name() -> str:
         return "speedometer"
 
     @classmethod
-    def title(cls):
+    def title(cls) -> str:
         return _("Service Speed-O-Meter")
 
     @classmethod
-    def description(cls):
+    def description(cls) -> str:
         return _(
             "A gadget that shows your current service check rate in relation to "
             "the scheduled check rate. If the Speed-O-Meter shows a speed "
@@ -47,12 +47,12 @@ def show(self, config: Config) -> None:
     def allowed_roles(cls) -> list[RoleName]:
         return ["admin"]
 
-    def page_handlers(self):
+    def page_handlers(self) -> PageHandlers:
         return {
             "sidebar_ajax_speedometer": self._ajax_speedometer,
         }
 
-    def _ajax_speedometer(self):
+    def _ajax_speedometer(self) -> None:
         response.set_content_type("application/json")
         try:
             # Try to get values from last call in order to compute