Fix: Typing in pontos/github/actions/ (#603)

* Fix: typing in pontos/github/actions * Fix: Linting * Fix: Linting
greenbone · Feb 8, 2023 · 596bb64 · 596bb64
1 parent 3a411e2
commit 596bb64
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 42 deletions.
diff --git a/pontos/github/actions/core.py b/pontos/github/actions/core.py
@@ -24,12 +24,12 @@
 
 
 def _to_options(
-    name: str = None,
-    line: str = None,
-    end_line: str = None,
-    column: str = None,
-    end_column: str = None,
-    title: str = None,
+    name: Optional[str] = None,
+    line: Optional[str] = None,
+    end_line: Optional[str] = None,
+    column: Optional[str] = None,
+    end_column: Optional[str] = None,
+    title: Optional[str] = None,
 ):
     options = []
     if name:
@@ -51,12 +51,12 @@ def _message(
     message_type: str,
     message: str,
     *,
-    name: str = None,
-    line: str = None,
-    end_line: str = None,
-    column: str = None,
-    end_column: str = None,
-    title: str = None,
+    name: Optional[str] = None,
+    line: Optional[str] = None,
+    end_line: Optional[str] = None,
+    column: Optional[str] = None,
+    end_column: Optional[str] = None,
+    title: Optional[str] = None,
 ):
     options = _to_options(name, line, end_line, column, end_column, title)
     print(f"::{message_type} {options}::{message}")
@@ -101,12 +101,12 @@ def end_group():
     def warning(
         message: str,
         *,
-        name: str = None,
-        line: str = None,
-        end_line: str = None,
-        column: str = None,
-        end_column: str = None,
-        title: str = None,
+        name: Optional[str] = None,
+        line: Optional[str] = None,
+        end_line: Optional[str] = None,
+        column: Optional[str] = None,
+        end_column: Optional[str] = None,
+        title: Optional[str] = None,
     ):
         """
         Print a warning message
@@ -128,12 +128,12 @@ def warning(
     def error(
         message: str,
         *,
-        name: str = None,
-        line: str = None,
-        end_line: str = None,
-        column: str = None,
-        end_column: str = None,
-        title: str = None,
+        name: Optional[str] = None,
+        line: Optional[str] = None,
+        end_line: Optional[str] = None,
+        column: Optional[str] = None,
+        end_column: Optional[str] = None,
+        title: Optional[str] = None,
     ):
         """
         Print an error message
@@ -155,12 +155,12 @@ def error(
     def notice(
         message: str,
         *,
-        name: str = None,
-        line: str = None,
-        end_line: str = None,
-        column: str = None,
-        end_column: str = None,
-        title: str = None,
+        name: Optional[str] = None,
+        line: Optional[str] = None,
+        end_line: Optional[str] = None,
+        column: Optional[str] = None,
+        end_column: Optional[str] = None,
+        title: Optional[str] = None,
     ):
         """
         Print a warning message
@@ -231,5 +231,5 @@ def input(name: str, default: Optional[str] = None) -> str:
             default: Use as default if the is no value for the variable
         """
         return os.environ.get(
-            f"INPUT_{name.replace(' ', '_').upper()}", default
+            f"INPUT_{name.replace(' ', '_').upper()}", default  # type: ignore
         )
diff --git a/pontos/github/actions/event.py b/pontos/github/actions/event.py
@@ -19,7 +19,7 @@
 from dataclasses import dataclass
 from enum import Enum
 from pathlib import Path
-from typing import Dict, Iterable
+from typing import Any, Dict, Iterable, Optional
 
 
 class PullRequestState(Enum):
@@ -54,30 +54,30 @@ class GitHubPullRequestEvent:
     https://docs.github.com/en/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull_request
     """
 
-    draft: bool
-    number: int
-    labels: Iterable[str]
-    title: str
-    merged: bool
+    draft: Optional[bool]
+    number: Optional[int]
+    labels: Optional[Iterable[str]]
+    title: Optional[str]
+    merged: Optional[bool]
     state: PullRequestState
     base: Ref
     head: Ref
 
-    def __init__(self, pull_request_data: Dict[str, str]):
+    def __init__(self, pull_request_data: Dict[str, Any]):
         data = pull_request_data or {}
 
         self.draft = data.get("draft")
         self.number = data.get("number")
-        self.labels = [Label(label.get("name")) for label in data.get("labels")]
+        self.labels = [Label(label.get("name")) for label in data.get("labels")]  # type: ignore #pylint: disable=line-too-long
         self.title = data.get("title")
         self.merged = data.get("merged")
         self.state = PullRequestState(data.get("state"))
 
         base = data.get("base") or {}
-        self.base = Ref(base.get("ref"), base.get("sha"))
+        self.base = Ref(base.get("ref"), base.get("sha"))  # type: ignore
 
         head = data.get("head") or {}
-        self.head = Ref(head.get("ref"), head.get("sha"))
+        self.head = Ref(head.get("ref"), head.get("sha"))  # type: ignore
 
 
 @dataclass
@@ -97,7 +97,7 @@ def __init__(self, event_path: Path):
         self._event_data = json.loads(content) if content else {}
         pull_request_data = self._event_data.get("pull_request")
         self.pull_request = (
-            GitHubPullRequestEvent(pull_request_data)
+            GitHubPullRequestEvent(pull_request_data)  # type: ignore
             if pull_request_data
             else None
         )