Avoid unnecessary typing imports (#199)

- Use collection keyword instead of typing.{Dict|List|Tuple|Set}
- replace typing.Union with `|`

Author: grahamalama

jbi/__init__.py

@@ -4,7 +4,6 @@
 This part of the code is not aware of the HTTP context it runs in.
 """
 from enum import Enum
-from typing import Dict, Tuple
 
 
 class Operation(str, Enum):
@@ -22,4 +21,4 @@ class Operation(str, Enum):
     LINK = "link"
 
 
-ActionResult = Tuple[bool, Dict]
+ActionResult = tuple[bool, dict]

jbi/log.py

@@ -6,7 +6,6 @@
 import sys
 import time
 from datetime import datetime
-from typing import Dict
 
 from fastapi import Request
 
@@ -46,7 +45,7 @@
 
 def format_request_summary_fields(
     request: Request, request_time: float, status_code: int
-) -> Dict:
+) -> dict:
     """Prepare Fields for Mozlog request summary"""
 
     current_time = time.time()

jbi/models.py

@@ -9,7 +9,7 @@
 import warnings
 from inspect import signature
 from types import ModuleType
-from typing import Any, Callable, Dict, List, Literal, Mapping, Optional, Set, Union
+from typing import Any, Callable, Literal, Mapping, Optional
 from urllib.parse import ParseResult, urlparse
 
 from pydantic import BaseModel, EmailStr, Field, PrivateAttr, root_validator, validator
@@ -30,13 +30,13 @@ class Action(YamlModel):
     whiteboard_tag: str
     module: str = "jbi.actions.default"
     # TODO: Remove the tbd literal option when all actions have contact info # pylint: disable=fixme
-    contact: Union[EmailStr, List[EmailStr], Literal["tbd"]]
+    contact: EmailStr | list[EmailStr] | Literal["tbd"]
     description: str
     enabled: bool = False
     allow_private: bool = False
     parameters: dict = {}
     _caller: Callable = PrivateAttr(default=None)
-    _required_jira_permissions: Set[str] = PrivateAttr(default=None)
+    _required_jira_permissions: set[str] = PrivateAttr(default=None)
 
     @property
     def caller(self) -> Callable:
@@ -48,7 +48,7 @@ def caller(self) -> Callable:
         return self._caller
 
     @property
-    def required_jira_permissions(self) -> Set[str]:
+    def required_jira_permissions(self) -> set[str]:
         """Return the required Jira permissions for this action to be executed."""
         if not self._required_jira_permissions:
             action_module: ModuleType = importlib.import_module(self.module)
@@ -61,7 +61,7 @@ def validate_action_config(cls, values):  # pylint: disable=no-self-argument
         """Validate action: exists, has init function, and has expected params"""
         try:
             module: str = values["module"]  # type: ignore
-            action_parameters: Optional[Dict[str, Any]] = values["parameters"]
+            action_parameters: Optional[dict[str, Any]] = values["parameters"]
             action_module: ModuleType = importlib.import_module(module)
             if not action_module:
                 raise TypeError("Module is not found.")
@@ -81,7 +81,7 @@ class Actions(YamlModel):
     Actions is the container model for the list of actions in the configuration file
     """
 
-    __root__: List[Action] = Field(..., min_items=1)
+    __root__: list[Action] = Field(..., min_items=1)
 
     @functools.cached_property
     def by_tag(self) -> Mapping[str, Action]:
@@ -102,7 +102,7 @@ def get(self, tag: Optional[str]) -> Optional[Action]:
         return self.by_tag.get(tag.lower()) if tag else None
 
     @functools.cached_property
-    def configured_jira_projects_keys(self) -> Set[str]:
+    def configured_jira_projects_keys(self) -> set[str]:
         """Return the list of Jira project keys from all configured actions"""
         return {
             action.parameters["jira_project_key"]
@@ -112,7 +112,7 @@ def configured_jira_projects_keys(self) -> Set[str]:
 
     @validator("__root__")
     def validate_actions(  # pylint: disable=no-self-argument
-        cls, actions: List[Action]
+        cls, actions: list[Action]
     ):
         """
         Inspect the list of actions:
@@ -160,11 +160,11 @@ class BugzillaWebhookEvent(BaseModel):
     action: str
     time: Optional[datetime.datetime]
     user: Optional[BugzillaWebhookUser]
-    changes: Optional[List[BugzillaWebhookEventChange]]
+    changes: Optional[list[BugzillaWebhookEventChange]]
     target: Optional[str]
     routing_key: Optional[str]
 
-    def changed_fields(self) -> Optional[List[str]]:
+    def changed_fields(self) -> Optional[list[str]]:
         """Returns the names of changed fields in a bug"""
         if self.changes:
             return [c.field for c in self.changes]
@@ -184,7 +184,7 @@ class BugzillaWebhookAttachment(BaseModel):
     creation_time: Optional[datetime.datetime]
     description: Optional[str]
     file_name: Optional[str]
-    flags: Optional[List]
+    flags: Optional[list]
     id: int
     is_obsolete: Optional[bool]
     is_patch: Optional[bool]
@@ -211,34 +211,34 @@ class BugzillaBug(BaseModel):
     product: Optional[str]
     component: Optional[str]
     whiteboard: Optional[str]
-    keywords: Optional[List]
-    flags: Optional[List]
-    groups: Optional[List]
+    keywords: Optional[list]
+    flags: Optional[list]
+    groups: Optional[list]
     status: Optional[str]
     resolution: Optional[str]
-    see_also: Optional[List]
+    see_also: Optional[list]
     summary: Optional[str]
     severity: Optional[str]
     priority: Optional[str]
     creator: Optional[str]
     assigned_to: Optional[str]
     comment: Optional[BugzillaWebhookComment]
 
-    def get_whiteboard_as_list(self) -> List[str]:
+    def get_whiteboard_as_list(self) -> list[str]:
         """Convert string whiteboard into list, splitting on ']' and removing '['."""
         if self.whiteboard is not None:
             split_list = self.whiteboard.replace("[", "").split("]")
             return [x.strip() for x in split_list if x not in ["", " "]]
         return []
 
-    def get_whiteboard_with_brackets_as_list(self) -> List[str]:
+    def get_whiteboard_with_brackets_as_list(self) -> list[str]:
         """Convert string whiteboard into list, splitting on ']' and removing '['; then re-adding."""
         wb_list = self.get_whiteboard_as_list()
         if wb_list is not None and len(wb_list) > 0:
             return [f"[{element}]" for element in wb_list]
         return []
 
-    def get_jira_labels(self) -> List[str]:
+    def get_jira_labels(self) -> list[str]:
         """
         whiteboard labels are added as a convenience for users to search in jira;
         bugzilla is an expected label in Jira
@@ -251,9 +251,9 @@ def get_jira_labels(self) -> List[str]:
 
         return ["bugzilla"] + wb_list + wb_bracket_list
 
-    def get_potential_whiteboard_config_list(self) -> List[str]:
+    def get_potential_whiteboard_config_list(self) -> list[str]:
         """Get all possible tags from `whiteboard` field"""
-        converted_list: List = []
+        converted_list: list = []
         for whiteboard in self.get_whiteboard_as_list():
             first_tag = whiteboard.strip().lower().split(sep="-", maxsplit=1)[0]
             if first_tag:
@@ -266,7 +266,7 @@ def issue_type(self) -> str:
         type_map: dict = {"enhancement": "Task", "task": "Task", "defect": "Bug"}
         return type_map.get(self.type, "Task")
 
-    def map_as_jira_issue(self) -> Dict:
+    def map_as_jira_issue(self) -> dict:
         """Extract bug info as jira issue dictionary"""
         return {
             "summary": self.summary,
@@ -304,7 +304,7 @@ def extract_from_see_also(self):
 
     def lookup_action(self, actions: Actions) -> Action:
         """Find first matching action from bug's whiteboard list"""
-        tags: List[str] = self.get_potential_whiteboard_config_list()
+        tags: list[str] = self.get_potential_whiteboard_config_list()
         for tag in tags:
             if action := actions.get(tag):
                 return action
@@ -354,10 +354,10 @@ def map_as_comments(
         self,
         status_log_enabled: bool = True,
         assignee_log_enabled: bool = True,
-    ) -> List[str]:
+    ) -> list[str]:
         """Extract update dict and comment list from Webhook Event"""
 
-        comments: List = []
+        comments: list = []
         bug: BugzillaBug = self.bug  # type: ignore
 
         if self.event.changes:
@@ -396,5 +396,5 @@ def bugzilla_object(self) -> BugzillaBug:
 class BugzillaApiResponse(BaseModel):
     """Bugzilla Response Object"""
 
-    faults: Optional[List]
-    bugs: Optional[List[BugzillaBug]]
+    faults: Optional[list]
+    bugs: Optional[list[BugzillaBug]]

jbi/router.py

@@ -2,7 +2,7 @@
 Core FastAPI app (setup, middleware)
 """
 from pathlib import Path
-from typing import Dict, List, Optional
+from typing import Optional
 
 from fastapi import APIRouter, Body, Depends, Request, Response
 from fastapi.encoders import jsonable_encoder
@@ -87,7 +87,7 @@ def get_whiteboard_tags(
 @router.get("/jira_projects/")
 def get_jira_projects():
     """API for viewing projects that are currently accessible by API"""
-    visible_projects: List[Dict] = jira_visible_projects()
+    visible_projects: list[dict] = jira_visible_projects()
     return [project["key"] for project in visible_projects]
 
 

jbi/services.py

@@ -3,7 +3,7 @@
 
 import concurrent.futures
 import logging
-from typing import TYPE_CHECKING, Dict, List
+from typing import TYPE_CHECKING
 
 import backoff
 import bugzilla as rh_bugzilla
@@ -20,7 +20,7 @@
 logger = logging.getLogger(__name__)
 
 
-ServiceHealth = Dict[str, bool]
+ServiceHealth = dict[str, bool]
 
 
 class InstrumentedClient:
@@ -77,10 +77,10 @@ def get_jira():
     )
 
 
-def jira_visible_projects(jira=None) -> List[Dict]:
+def jira_visible_projects(jira=None) -> list[dict]:
     """Return list of projects that are visible with the configured Jira credentials"""
     jira = jira or get_jira()
-    projects: List[Dict] = jira.projects(included_archived=None)
+    projects: list[dict] = jira.projects(included_archived=None)
     return projects