pre-commit reformatting

Author: sidamd

.github/workflows/code_quality_checks.yml

@@ -6,15 +6,22 @@ permissions:
 
 on: [pull_request]
 
+permissions:
+  contents: read
+
 jobs:
   pre-commit:
     runs-on: [ self-hosted ]
     container: python:3.10
 
     steps:
       - uses: actions/checkout@v3
-      - uses: pre-commit/action@v3.0.1
-
+      - name: setup environment
+        run: |
+          ./dev-setup.sh
+      - name: run pre-commit hooks
+        run: |
+          pre-commit run --all-files --show-diff-on-failure --color=always
       - name: Print message on failure
         if: failure()
         run: |

.pre-commit-config.yaml

@@ -15,3 +15,9 @@ repos:
     rev: 25.1.0
     hooks:
       - id: black
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.15.0
+    hooks:
+      - id: mypy
+        args: [--install-types, --non-interactive, --explicit-package-bases, --allow-redefinition]
+        language: system

nodescraper/interfaces/dataanalyzertask.py

@@ -125,13 +125,13 @@ def __init_subclass__(cls, **kwargs: dict[str, Any]) -> None:
     def analyze_data(
         self,
         data: TDataModel,
-        args: Optional[TAnalyzeArg | dict],
+        args: Optional[TAnalyzeArg],
     ) -> TaskResult:
         """Analyze the provided data and return a TaskResult
 
         Args:
             data (TDataModel): data to analyze
-            args (Optional[TAnalyzeArg  |  dict]): Optional arguments for analysis, can be a model or dict
+            args (Optional[TAnalyzeArg]): Optional arguments for analysis. Dicts will be handled in the decorator"
 
         Returns:
             TaskResult: Task result containing the analysis outcome

nodescraper/interfaces/task.py

@@ -81,7 +81,7 @@ def max_event_priority_level(self, input_value: str | EventPriority):
         if isinstance(input_value, str):
             value: EventPriority = getattr(EventPriority, input_value)
         elif isinstance(input_value, EventPriority):
-            value: EventPriority = input_value
+            value: EventPriority = input_value  # type:ignore
         else:
             raise ValueError(f"Invalid type for max_event_priority_level: {type(input_value)}")
 

nodescraper/models/event.py

@@ -51,7 +51,7 @@ class Event(BaseModel):
         default_factory=lambda: datetime.datetime.now(datetime.timezone.utc)
     )
     reporter: str = "ERROR_SCRAPER"
-    category: str
+    category: str | Enum
     description: str
     data: dict = Field(default_factory=dict)
     priority: EventPriority

nodescraper/plugins/inband/cmdline/cmdline_analyzer.py

@@ -23,7 +23,7 @@
 # SOFTWARE.
 #
 ###############################################################################
-from typing import Optional
+from typing import Any, Optional
 
 from nodescraper.enums import EventCategory, EventPriority, ExecutionStatus
 from nodescraper.interfaces import DataAnalyzer
@@ -38,13 +38,15 @@ class CmdlineAnalyzer(DataAnalyzer[CmdlineDataModel, CmdlineAnalyzerArgs]):
 
     DATA_MODEL = CmdlineDataModel
 
-    def _compare_cmdline(self, cmdline: str, required_cmdline: list, banned_cmdline: list) -> bool:
+    def _compare_cmdline(
+        self, cmdline: str, required_cmdline: str | list[Any], banned_cmdline: str | list[Any]
+    ) -> bool:
         """Compare the kernel cmdline against required and banned cmdline arguments.
 
         Args:
             cmdline (str): Kernel command line arguments as a string.
-            required_cmdline (list): required kernel cmdline arguments that must be present.
-            banned_cmdline (list): banned kernel cmdline arguments that must not be present.
+            required_cmdline (str) | (list): required kernel cmdline arguments that must be present.
+            banned_cmdline (str) | (list): banned kernel cmdline arguments that must not be present.
 
         Returns:
             bool: True if the cmdline matches the required arguments and does not contain banned arguments,

nodescraper/resultcollators/tablesummary.py

@@ -40,7 +40,7 @@ def collate_results(
             connection_results (list[TaskResult]): list of connection results to collate
         """
 
-        def gen_str_table(headers: list[str], rows: list[str]):
+        def gen_str_table(headers: list[str], rows: list[list[str | None]]):
             column_widths = [len(header) for header in headers]
             for row in rows:
                 for i, cell in enumerate(row):
@@ -67,8 +67,10 @@ def gen_row(row):
 
         if plugin_results:
             rows = []
-            for result in plugin_results:
-                rows.append([result.source, result.status.name, result.message])
+            for plugin_result in plugin_results:
+                rows.append(
+                    [plugin_result.source, plugin_result.status.name, plugin_result.message]
+                )
 
             table = gen_str_table(["Plugin", "Status", "Message"], rows)
             tables += f"\n\n{table}"

pyproject.toml

@@ -28,7 +28,8 @@ dev = [
     "ruff",
     "pre-commit",
     "pytest",
-    "pytest-cov"
+    "pytest-cov",
+    "mypy"
 ]
 
 [project.urls]