chore: add type-hints to gitlab/v4/objects/sidekiq.py

JohnVillalovos · JohnVillalovos · commit 1ecb0a68e86c · 2021-11-21T14:43:04.000-08:00
diff --git a/gitlab/v4/objects/sidekiq.py b/gitlab/v4/objects/sidekiq.py
@@ -1,3 +1,7 @@
+from typing import Any, Dict, Union
+
+import requests
+
 from gitlab import cli
 from gitlab import exceptions as exc
 from gitlab.base import RESTManager
@@ -16,7 +20,7 @@ class SidekiqManager(RESTManager):
 
     @cli.register_custom_action("SidekiqManager")
     @exc.on_http_error(exc.GitlabGetError)
-    def queue_metrics(self, **kwargs):
+    def queue_metrics(self, **kwargs: Any) -> Union[Dict[str, Any], requests.Response]:
         """Return the registered queues information.
 
         Args:
@@ -33,7 +37,9 @@ def queue_metrics(self, **kwargs):
 
     @cli.register_custom_action("SidekiqManager")
     @exc.on_http_error(exc.GitlabGetError)
-    def process_metrics(self, **kwargs):
+    def process_metrics(
+        self, **kwargs: Any
+    ) -> Union[Dict[str, Any], requests.Response]:
         """Return the registered sidekiq workers.
 
         Args:
@@ -50,7 +56,7 @@ def process_metrics(self, **kwargs):
 
     @cli.register_custom_action("SidekiqManager")
     @exc.on_http_error(exc.GitlabGetError)
-    def job_stats(self, **kwargs):
+    def job_stats(self, **kwargs: Any) -> Union[Dict[str, Any], requests.Response]:
         """Return statistics about the jobs performed.
 
         Args:
@@ -67,7 +73,9 @@ def job_stats(self, **kwargs):
 
     @cli.register_custom_action("SidekiqManager")
     @exc.on_http_error(exc.GitlabGetError)
-    def compound_metrics(self, **kwargs):
+    def compound_metrics(
+        self, **kwargs: Any
+    ) -> Union[Dict[str, Any], requests.Response]:
         """Return all available metrics and statistics.
 
         Args:
diff --git a/pyproject.toml b/pyproject.toml
@@ -12,7 +12,6 @@ files = "."
 module = [
     "docs.*",
     "docs.ext.*",
-    "gitlab.v4.objects.sidekiq",
     "tests.functional.*",
     "tests.functional.api.*",
     "tests.meta.*",
