Merge pull request #1035 from zapta/main

Fixed a few mypy reported type errors.

Author: zapta

apio/common/apio_console.py

@@ -13,7 +13,7 @@
 import os
 import traceback
 from dataclasses import dataclass
-from typing import Optional, List, NoReturn
+from typing import Optional, List, NoReturn, Literal
 from rich.console import Console
 from rich.ansi import AnsiDecoder
 from rich.theme import Theme
@@ -107,7 +107,9 @@ def configure(
             terminal_mode = AUTO_TERMINAL
 
     # -- Determine console color system parameter.
-    color_system = "auto" if theme.colors_enabled else None
+    color_system: Literal["auto"] | None = (
+        "auto" if theme.colors_enabled else None
+    )
 
     # -- Determine console's force_terminal parameter.
     if terminal_mode == FORCE_TERMINAL:
@@ -285,8 +287,8 @@ def cerror(*text_lines: str) -> None:
 
 def fatal_error(
     *error_text_lines: str,
-    info: List[str] | str = None,
-    cause: Exception = None,
+    info: List[str] | str | None = None,
+    cause: Exception | None = None,
 ) -> NoReturn:
     """Prints one or more error lines, then optional info lines, and then
     exists the program with an error status."""

apio/utils/util.py

@@ -36,7 +36,7 @@ class AsyncPipe(Thread):
     from an internal thread. Used to process in real time scons output to
     show its progress."""
 
-    def __init__(self, line_callback=None):
+    def __init__(self, line_callback=None) -> None:
         """If line_callback is not None, it is called for each line as
         line_callback(line:str, terminator:str) where line is the line content
         and terminator is one of:
@@ -54,28 +54,28 @@ def __init__(self, line_callback=None):
         self._fd_read, self._fd_write = os.pipe()
 
         # -- A list of lines received so far.
-        self._lines_buffer = []
+        self._lines_buffer: List[str] = []
 
         self.start()
 
-    def get_buffer(self):
+    def get_buffer(self) -> List[str]:
         """DOC: TODO"""
 
         return self._lines_buffer
 
-    def fileno(self):
+    def fileno(self) -> int:
         """DOC: TODO"""
 
         return self._fd_write
 
-    def _handle_incoming_line(self, bfr: bytearray, terminator: str):
+    def _handle_incoming_line(self, bfr: bytearray, terminator: str) -> None:
         """Handle a new incoming line.
         Bfr is a bytes with the line's content, possibly empty.
         See __init__ for the description of terminator.
         """
         # -- Convert the line's bytes to a string. Replace invalid utf-8
         # -- chars with "�"
-        line = bfr.decode("utf-8", errors="replace")
+        line: str = bfr.decode("utf-8", errors="replace")
 
         # -- Append to the lines log buffer.
         self._lines_buffer.append(line)
@@ -84,7 +84,7 @@ def _handle_incoming_line(self, bfr: bytearray, terminator: str):
         if self.outcallback:
             self.outcallback(line, terminator)
 
-    def run(self):
+    def run(self) -> None:
         """DOC: TODO"""
 
         # -- Prepare a buffer for collecting the line chars, excluding

scripts/diff_jsonc.py

@@ -25,7 +25,7 @@ def extract_command_list(node: dict, node_path: List[str]) -> list[List[str]]:
     return result
 
 
-def get_commands_list() -> List[str]:
+def get_commands_list() -> List[List[str]]:
     """Run 'apio apio get-commands' and extract the commands list."""
 
     # -- Get the command hierarchy as a JSON doc.

scripts/generate_commands_help.py

@@ -253,7 +253,7 @@ def clean_task(_: Context):
     assert isinstance(repo_root, Path)
 
     # -- Collect items to delete.
-    items = []
+    items: List[Path] = []
     # -- Collect top level items first so they will be deleted first.
     items.extend(repo_root.glob(".tox"))
     items.extend(repo_root.glob("_site"))