Add typing information, 1/2 (#1176)

* Re-enable typing and improve config.

* Make mypy pass.

* Improve settings.

* First batch of types.

* Add more type hints.

* Fixes.

* Format.

* Fix split_port() without returning to previous type chaos.

* Continue with type hints (and ignores).

plugins/module_utils/_api/credentials/errors.py

@@ -11,6 +11,12 @@
 
 from __future__ import annotations
 
+import typing as t
+
+
+if t.TYPE_CHECKING:
+    from subprocess import CalledProcessError
+
 
 class StoreError(RuntimeError):
     pass
@@ -24,7 +30,7 @@ class InitializationError(StoreError):
     pass
 
 
-def process_store_error(cpe, program):
+def process_store_error(cpe: CalledProcessError, program: str) -> StoreError:
     message = cpe.output.decode("utf-8")
     if "credentials not found in native keychain" in message:
         return CredentialsNotFound(f"No matching credentials in {program}")

plugins/module_utils/_api/credentials/store.py

@@ -14,13 +14,14 @@ from __future__ import annotations
 import errno
 import json
 import subprocess
+import typing as t
 
 from . import constants, errors
 from .utils import create_environment_dict, find_executable
 
 
 class Store:
-    def __init__(self, program, environment=None):
+    def __init__(self, program: str, environment: dict[str, str] | None = None) -> None:
         """Create a store object that acts as an interface to
         perform the basic operations for storing, retrieving
         and erasing credentials using `program`.
@@ -33,7 +34,7 @@ class Store:
                 f"{self.program} not installed or not available in PATH"
             )
 
-    def get(self, server):
+    def get(self, server: str | bytes) -> dict[str, t.Any]:
         """Retrieve credentials for `server`. If no credentials are found,
         a `StoreError` will be raised.
         """
@@ -53,7 +54,7 @@ class Store:
 
         return result
 
-    def store(self, server, username, secret):
+    def store(self, server: str, username: str, secret: str) -> bytes:
         """Store credentials for `server`. Raises a `StoreError` if an error
         occurs.
         """
@@ -62,7 +63,7 @@ class Store:
         ).encode("utf-8")
         return self._execute("store", data_input)
 
-    def erase(self, server):
+    def erase(self, server: str | bytes) -> None:
         """Erase credentials for `server`. Raises a `StoreError` if an error
         occurs.
         """
@@ -70,12 +71,16 @@ class Store:
             server = server.encode("utf-8")
         self._execute("erase", server)
 
-    def list(self):
+    def list(self) -> t.Any:
         """List stored credentials. Requires v0.4.0+ of the helper."""
         data = self._execute("list", None)
         return json.loads(data.decode("utf-8"))
 
-    def _execute(self, subcmd, data_input):
+    def _execute(self, subcmd: str, data_input: bytes | None) -> bytes:
+        if self.exe is None:
+            raise errors.StoreError(
+                f"{self.program} not installed or not available in PATH"
+            )
         output = None
         env = create_environment_dict(self.environment)
         try:

plugins/module_utils/_api/credentials/utils.py

@@ -15,7 +15,7 @@ import os
 from shutil import which
 
 
-def find_executable(executable, path=None):
+def find_executable(executable: str, path: str | None = None) -> str | None:
     """
     As distutils.spawn.find_executable, but on Windows, look up
     every extension declared in PATHEXT instead of just `.exe`
@@ -26,7 +26,7 @@ def find_executable(executable, path=None):
     return which(executable, path=path)
 
 
-def create_environment_dict(overrides):
+def create_environment_dict(overrides: dict[str, str] | None) -> dict[str, str]:
     """
     Create and return a copy of os.environ with the specified overrides
     """