typing and kwarg removals

.github/workflows/python_actions.yml

@@ -26,7 +26,8 @@ jobs:
       coverage-package: spalloc tests
       flake8-packages:  spalloc_client tests
       pylint-packages: spalloc_client
-      mypy-packages: spalloc_client tests
+      mypy-packages: tests
+      mypy-full_packages: spalloc_client
       sphinx_directory: docs/source
     secrets: inherit
 

mypy.bash

@@ -0,0 +1,27 @@
+#!/bin/bash
+
+# Copyright (c) 2024 The University of Manchester
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# This bash assumes that other repositories are installed in paralled
+
+# requires the latest mypy
+# pip install --upgrade mypy
+
+utils="../SpiNNUtils/spinn_utilities"
+machine="../SpiNNMachine/spinn_machine"
+man="../SpiNNMan/spinnman"
+pacman="../PACMAN/pacman"
+
+mypy --python-version 3.8 $utils $machine $man $pacman spalloc_client tests

mypyd.bash

@@ -0,0 +1,28 @@
+#!/bin/bash
+
+# Copyright (c) 2024 The University of Manchester
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# This bash assumes that other repositories are installed in paralled
+
+# requires the latest mypy
+# pip install --upgrade mypy
+
+utils="../SpiNNUtils/spinn_utilities"
+machine="../SpiNNMachine/spinn_machine"
+man="../SpiNNMan/spinnman"
+pacman="../PACMAN/pacman"
+
+mypy --python-version 3.8 --disallow-untyped-defs $utils $machine $man $pacman spalloc_client
+

spalloc_client/__init__.py

@@ -23,5 +23,5 @@
 
 __all__ = [
     "Job", "JobDestroyedError", "JobState", "ProtocolClient",
-    "ProtocolError", "ProtocolTimeoutError", "SpallocServerException",
-    "StateChangeTimeoutError"]
+    "ProtocolError", "ProtocolTimeoutError",
+    "SpallocServerException", "StateChangeTimeoutError"]

spalloc_client/_keepalive_process.py

@@ -17,10 +17,11 @@
 """
 import sys
 import threading
+from typing import List
 from spalloc_client.protocol_client import ProtocolClient, ProtocolTimeoutError
 
 
-def wait_for_exit(stop_event):
+def wait_for_exit(stop_event: threading.Event) -> None:
     """ Listens to stdin for a line equal to 'exit' or end-of-file and then\
         notifies the given event (that it is time to stop keeping the Spalloc\
         job alive).
@@ -34,8 +35,10 @@ def wait_for_exit(stop_event):
     stop_event.set()
 
 
-def keep_job_alive(hostname, port, job_id, keepalive_period, timeout,
-                   reconnect_delay, stop_event):
+def keep_job_alive(
+        hostname: str, port: int, job_id: int, keepalive_period: float,
+        timeout: float, reconnect_delay: float,
+        stop_event: threading.Event) -> None:
     """ Keeps a Spalloc job alive. Run as a separate process to the main\
         Spalloc client.
 
@@ -78,7 +81,7 @@ def keep_job_alive(hostname, port, job_id, keepalive_period, timeout,
                         client.close()
 
 
-def _run(argv):
+def _run(argv: List[str]) -> None:
     print("KEEPALIVE")
     sys.stdout.flush()
     hostname = argv[1]

spalloc_client/_utils.py

@@ -14,33 +14,40 @@
 
 from datetime import datetime
 import time
+from typing import Optional
 
 
-def time_left(timestamp):
+def time_left_float(timestamp: float) -> float:
+    """ Convert a not None timestamp into how long to wait for it.
+    """
+    return max(0.0, timestamp - time.time())
+
+
+def time_left(timestamp: Optional[float]) -> Optional[float]:
     """ Convert a timestamp into how long to wait for it.
     """
     if timestamp is None:
         return None
     return max(0.0, timestamp - time.time())
 
 
-def timed_out(timestamp):
+def timed_out(timestamp: Optional[float]) -> bool:
     """ Check if a timestamp has been reached.
     """
     if timestamp is None:
         return False
     return timestamp < time.time()
 
 
-def make_timeout(delay_seconds):
+def make_timeout(delay_seconds: Optional[float]) -> Optional[float]:
     """ Convert a delay (in seconds) into a timestamp.
     """
     if delay_seconds is None:
         return None
     return time.time() + delay_seconds
 
 
-def render_timestamp(timestamp) -> str:
+def render_timestamp(timestamp: float) -> str:
     """ Convert a timestamp (Unix seconds) into a local human-readable\
         timestamp string.
     """