refactor: ♻️ update type hints to use built-in types for future types (#159)

Signed-off-by: Onuralp SEZER <[email protected]>
Signed-off-by: Glenn Jocher <[email protected]>
Co-authored-by: Glenn Jocher <[email protected]>

Author: onuralpszr

plugin/__init__.py

@@ -1,6 +1,6 @@
 # Ultralytics 🚀 AGPL-3.0 License - https://ultralytics.com/license
 
-__version__ = "0.1.29"
+__version__ = "0.1.30"
 
 from .main import MetaPlugin
 

plugin/main.py

@@ -1,12 +1,14 @@
 # Ultralytics 🚀 AGPL-3.0 License - https://ultralytics.com/license
 
+from __future__ import annotations
+
 import json
 import re
 import subprocess
 from datetime import datetime, timedelta
 from pathlib import Path
 from subprocess import check_output
-from typing import Any, Dict, List
+from typing import Any
 
 from bs4 import BeautifulSoup
 from mkdocs.config import config_options
@@ -70,7 +72,7 @@ def __init__(self):
         except (subprocess.CalledProcessError, FileNotFoundError):
             self.git_available = False
 
-    def get_git_info(self, file_path: str) -> Dict[str, Any]:
+    def get_git_info(self, file_path: str) -> dict[str, Any]:
         """Retrieve git information including creation/modified dates and optional authors."""
         file_path = str(Path(file_path).resolve())
         git_info = {"creation_date": DEFAULT_CREATION_DATE, "last_modified_date": DEFAULT_MODIFIED_DATE}
@@ -172,7 +174,7 @@ def insert_content(soup: BeautifulSoup, content_to_insert) -> None:
             md_typeset.append(content_to_insert)
 
     @staticmethod
-    def parse_faq(soup: BeautifulSoup) -> List[Dict[str, Any]]:
+    def parse_faq(soup: BeautifulSoup) -> list[dict[str, Any]]:
         """
         Parse the FAQ questions and answers from the HTML page content.
 

plugin/utils.py

@@ -1,12 +1,13 @@
 # Ultralytics 🚀 AGPL-3.0 License - https://ultralytics.com/license
 
+from __future__ import annotations
+
 import contextlib
 import re
 import subprocess
 from collections import Counter
 from datetime import datetime
 from pathlib import Path
-from typing import Dict, List, Optional, Tuple
 
 import requests
 import yaml  # YAML is used for its readability and consistency with MkDocs ecosystem
@@ -16,7 +17,7 @@
 DEFAULT_AVATAR = requests.head("https://github.com/github.png", allow_redirects=True).url
 
 
-def calculate_time_difference(date_string: str) -> Tuple[str, str]:
+def calculate_time_difference(date_string: str) -> tuple[str, str]:
     """
     Calculate the time difference between a given date and the current date in a human-readable format.
 
@@ -48,7 +49,7 @@ def calculate_time_difference(date_string: str) -> Tuple[str, str]:
     return difference, pretty_date
 
 
-def get_youtube_video_ids(soup: BeautifulSoup) -> List[str]:
+def get_youtube_video_ids(soup: BeautifulSoup) -> list[str]:
     """
     Extract YouTube video IDs from iframe elements present in the provided BeautifulSoup object.
 
@@ -83,8 +84,8 @@ def get_youtube_video_ids(soup: BeautifulSoup) -> List[str]:
 
 
 def get_github_username_from_email(
-    email: str, cache: Dict, file_path: str = "", verbose: bool = True
-) -> Tuple[Optional[str], Optional[str]]:
+    email: str, cache: dict, file_path: str = "", verbose: bool = True
+) -> tuple[str | None, str | None]:
     """
     Retrieve the GitHub username and avatar URL associated with the given email address.
 
@@ -137,7 +138,7 @@ def get_github_username_from_email(
     return None, None
 
 
-def get_github_usernames_from_file(file_path: str, default_user: Optional[str] = None) -> Dict[str, Dict[str, any]]:
+def get_github_usernames_from_file(file_path: str, default_user: str | None = None) -> dict[str, dict[str, any]]:
     """
     Fetch GitHub usernames associated with a file using Git Log and Git Blame commands.