chore: Do not initialize unnecessary attributes in GitHubEvent. (#79)

bot/models/github/event.py

@@ -1,6 +1,7 @@
 """
 Model class that can store all relevant info about all events that the project handles.
 """
+from typing import Optional
 
 from ..link import Link
 from . import Commit, EventType, Issue, PullRequest, Ref, Repository, User
@@ -25,37 +26,48 @@ class GitHubEvent:
     :keyword links: List of miscellaneous links.
     """
 
+    type: EventType
+    repo: Repository
+    status: Optional[str]
+    issue: Optional[Issue]
+    pull_request: Optional[PullRequest]
+    ref: Optional[Ref]
+    user: Optional[User]
+    comments: Optional[list[str]]
+    commits: Optional[list[Commit]]
+    links: Optional[list[Link]]
+    reviewers: Optional[list[User]]
+
     def __init__(self, event_type: EventType, repo: Repository, **kwargs):
         self.type = event_type
         self.repo = repo
 
-        self.status: str | None = kwargs.get("status", None)
-
-        self.issue: Issue | None = kwargs.get("issue", None)
-        self.pull_request: PullRequest | None = kwargs.get(
-            "pull_request",
-            None,
-        )
-        self.ref: Ref | None = kwargs.get("ref", None)
-        self.user: User | None = kwargs.get("user", None)
-
-        self.comments: list[str] | None = kwargs.get("comments", None)
-
-        self.commits: list[Commit] | None = kwargs.get("commits", None)
-        self.links: list[Link] | None = kwargs.get("links", None)
-        self.reviewers: list[User] | None = kwargs.get("reviewers", None)
+        if "status" in kwargs:
+            self.status = kwargs["status"]
+        if "issue" in kwargs:
+            self.issue = kwargs["issue"]
+        if "pull_request" in kwargs:
+            self.pull_request = kwargs["pull_request"]
+        if "ref" in kwargs:
+            self.ref = kwargs["ref"]
+        if "user" in kwargs:
+            self.user = kwargs["user"]
+        if "comments" in kwargs:
+            self.comments = kwargs["comments"]
+        if "commits" in kwargs:
+            self.commits = kwargs["commits"]
+        if "links" in kwargs:
+            self.links = kwargs["links"]
+        if "reviewers" in kwargs:
+            self.comments = kwargs["reviewers"]
 
     def __str__(self):
-        return f"""(
-            type={self.type},
-            repo={self.repo.name},
-            status={self.status},
-            issue={self.issue.title},
-            pull_request={self.pull_request.title},
-            ref={self.ref.name},
-            user={self.user.name},
-            comments={[comment for comment in self.comments]},
-            commits={[commit.message for commit in self.commits]},
-            links={[link.url for link in self.links]},
-            users={[reviewer.name for reviewer in self.reviewers]},
-        )"""
+        string = ""
+        for var, value in vars(self).items():
+            string += var + "="
+            if isinstance(value, (list, tuple, set)):
+                string += str([str(v) for v in value])
+            else:
+                string += str(value)
+            string += ", "
+        return "(" + string[:-2] + ")"

tests/github/data.json

@@ -16,15 +16,8 @@
       }
     },
     {
-      "comments": "None",
-      "commits": "None",
-      "issue": "None",
-      "links": "None",
-      "pull_request": "None",
       "ref": "branch-name",
       "repo": "<https://github.com/example-org/example-repo|example-org/example-repo>",
-      "reviewers": "None",
-      "status": "None",
       "type": "EventType.BRANCH_CREATED",
       "user": "<https://github.com/example-user|example-user>"
     }