Add mypy (typing) check to pre-commit (#20)

RedHatQE · Apr 4, 2024 · 6a7a436 · 6a7a436
1 parent 405e645
commit 6a7a436
Show file tree

Hide file tree

Showing 4 changed files with 43 additions and 33 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,39 +1,40 @@
 default_language_version:
-    python: python3
+  python: python3
 
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: "v4.5.0"
     hooks:
-    - id: check-added-large-files
-    - id: check-docstring-first
-    - id: check-executables-have-shebangs
-    - id: check-merge-conflict
-    - id: check-symlinks
-    - id: check-yaml
-      args:
-      - "--allow-multiple-documents"
-        # https://github.com/pre-commit/pre-commit-hooks/issues/273
-      - "--unsafe"
-    - id: detect-private-key
-    - id: mixed-line-ending
-    - id: debug-statements
-    - id: trailing-whitespace
-      args: [--markdown-linebreak-ext=md] # Do not process Markdown files.
-    - id: end-of-file-fixer
-    - id: check-ast
-    - id: check-builtin-literals
-    - id: check-docstring-first
-    - id: check-toml
+      - id: check-added-large-files
+      - id: check-docstring-first
+      - id: check-executables-have-shebangs
+      - id: check-merge-conflict
+      - id: check-symlinks
+      - id: check-yaml
+        args:
+          - "--allow-multiple-documents"
+            # https://github.com/pre-commit/pre-commit-hooks/issues/273
+          - "--unsafe"
+      - id: detect-private-key
+      - id: mixed-line-ending
+      - id: debug-statements
+      - id: trailing-whitespace
+        args: [--markdown-linebreak-ext=md] # Do not process Markdown files.
+      - id: end-of-file-fixer
+      - id: check-ast
+      - id: check-builtin-literals
+      - id: check-docstring-first
+      - id: check-toml
 
   - repo: https://github.com/PyCQA/flake8
     rev: "7.0.0"
     hooks:
       - id: flake8
-        additional_dependencies: [
-          "git+https://github.com/RedHatQE/flake8-plugins.git",
-          "flake8-mutable",
-        ]
+        additional_dependencies:
+          [
+            "git+https://github.com/RedHatQE/flake8-plugins.git",
+            "flake8-mutable",
+          ]
 
   - repo: https://github.com/Yelp/detect-secrets
     rev: v1.4.0
@@ -56,3 +57,10 @@ repos:
     rev: 37.264.0
     hooks:
       - id: renovate-config-validator
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.9.0
+    hooks:
+      - id: mypy
+        exclude: ^(tests/)
+        additional_dependencies: [types-all]
diff --git a/pyhelper_utils/general.py b/pyhelper_utils/general.py
@@ -2,7 +2,7 @@
 from time import sleep
 from functools import wraps
 from logging import Logger
-from typing import Any
+from typing import Any, Optional
 
 
 def tts(ts: Any) -> int:
@@ -22,9 +22,9 @@ def tts(ts: Any) -> int:
     Returns:
         int: Time in seconds
     """
-    try:
-        time_and_unit = re.match(r"(?P<time>\d+)(?P<unit>\w)", str(ts)).groupdict()
-    except AttributeError:
+    if time_and_unit_match := re.match(r"(?P<time>\d+)(?P<unit>\w)", str(ts)):
+        time_and_unit = time_and_unit_match.groupdict()
+    else:
         return int(ts)
 
     _time = int(time_and_unit["time"])
@@ -39,7 +39,7 @@ def tts(ts: Any) -> int:
         return int(ts)
 
 
-def ignore_exceptions(logger: Logger = None, retry: int = 0) -> Any:
+def ignore_exceptions(logger: Optional[Logger] = None, retry: int = 0) -> Any:
     """
     Decorator to ignore exceptions with support for retry.
 

diff --git a/pyhelper_utils/notifications.py b/pyhelper_utils/notifications.py
@@ -1,12 +1,13 @@
 from logging import Logger
+from typing import Optional
 import requests
 import json
 
 
 def send_slack_message(
     message: str,
-    webhook_url: str = None,
-    logger: Logger = None,
+    webhook_url: Optional[str] = None,
+    logger: Optional[Logger] = None,
     post_timout: int = 30,
     raise_on_error: bool = True,
 ) -> None:

diff --git a/pyhelper_utils/shell.py b/pyhelper_utils/shell.py
@@ -1,4 +1,5 @@
 import subprocess
+from typing import Optional
 
 from simple_logger.logger import get_logger
 
@@ -11,7 +12,7 @@ def run_command(
     command: list,
     verify_stderr: bool = True,
     shell: bool = False,
-    timeout: int = None,
+    timeout: Optional[int] = None,
     capture_output: bool = True,
     check: bool = True,
     hide_log_command: bool = False,