Merge pull request #27 from CarletonURocketry/modify_linting_config

Move configurations to pyproject.toml where applicable and update configurations.

.gitignore

@@ -135,4 +135,4 @@ dmypy.json
 /missions/
 
 # Misc
-/.idea/
+.idea/

main.py

@@ -5,9 +5,12 @@
 # Thomas Selwyn (Devil)
 # Matteo Golin (linguini1)
 
-from multiprocessing import Process, Queue
+import multiprocessing as mp
+from multiprocessing import Process
+from queue import Queue
 from re import sub
 import logging
+from typing import TypeAlias, Any
 from modules.misc.config import load_config
 
 from modules.misc.messages import print_cu_rocket
@@ -16,6 +19,7 @@
 from modules.websocket.websocket import WebSocketHandler
 from modules.misc.cli import parser
 
+JSON: TypeAlias = dict[str, Any]
 VERSION: str = "0.5.0-DEV"
 STR_TO_LOGGING_MODE: dict[str, int] = {
     "debug": logging.DEBUG,
@@ -35,7 +39,7 @@ class ShutdownException(Exception):
 
 # Set up logging
 
-log_handlers: list = [logging.StreamHandler()]  # Always print to stdout
+log_handlers: list[logging.Handler] = [logging.StreamHandler()]  # Always print to stdout
 if args.get("o") is not None:
     log_handlers.append(logging.FileHandler(args.get("o", "logfile.log")))
 
@@ -48,15 +52,15 @@ class ShutdownException(Exception):
 
 def main():
     # Set up queues
-    serial_status = Queue()
-    ws_commands = Queue()
-    serial_ws_commands = Queue()
-    telemetry_ws_commands = Queue()
+    serial_status: Queue[str] = mp.Queue()  # type: ignore
+    ws_commands: Queue[str] = mp.Queue()  # type: ignore
+    serial_ws_commands: Queue[list[str]] = mp.Queue()  # type: ignore
+    telemetry_ws_commands: Queue[list[str]] = mp.Queue()  # type: ignore
 
-    radio_signal_report = Queue()
-    rn2483_radio_input = Queue()
-    rn2483_radio_payloads = Queue()
-    telemetry_json_output = Queue()
+    radio_signal_report: Queue[str] = mp.Queue()  # type: ignore
+    rn2483_radio_input: Queue[str] = mp.Queue()  # type: ignore
+    rn2483_radio_payloads: Queue[str] = mp.Queue()  # type: ignore
+    telemetry_json_output: Queue[JSON] = mp.Queue()  # type: ignore
 
     # Print display screen
     print_cu_rocket("No Name (Gas Propelled Launching Device)", VERSION)
@@ -123,7 +127,7 @@ def main():
                 exit(0)
 
 
-def parse_ws_command(ws_cmd: str, serial_commands: Queue, telemetry_commands: Queue) -> None:
+def parse_ws_command(ws_cmd: str, serial_commands: Queue[list[str]], telemetry_commands: Queue[list[str]]) -> None:
     """Parses a websocket command and places it on the correct process queue (telemetry or serial)."""
 
     # Remove special characters

modules/misc/cli.py

@@ -11,25 +11,25 @@
 
 # Custom types
 def file_path(path: str):
-    """Verifies that the argument is a valid filepath."""
+    """Verifies that the argument is a valid file path."""
 
     if os.path.isfile(path) or os.access(os.path.dirname(path), os.W_OK):
         return path
     else:
-        raise FileNotFoundError(f"{path} is not a valid filepath.")
+        raise FileNotFoundError(f"{path} is not a valid file path.")
 
 
 # Arguments
 parser = argparse.ArgumentParser(description=DESC)
 
-parser.add_argument(
+_ = parser.add_argument(
     "-l",
     help="Selects the logging level for messages in the console.",
     choices=["debug", "info", "warning", "error", "critical"],
-    default="info"
+    default="info",
 )
 
-parser.add_argument(
+_ = parser.add_argument(
     "-o",
     help="Output file for logging messages. Logs to console by default.",
     type=file_path,

modules/misc/config.py

@@ -69,8 +69,7 @@ class RadioParameters:
     def __post_init__(self):
         if self.frequency not in range(*LF_RANGE) and self.frequency not in range(*HF_RANGE):
             raise ValueError(
-                f"Frequency '{self.frequency}' not in low frequency range {LF_RANGE} "
-                f"or high frequency range {HF_RANGE}"
+                f"Frequency '{self.frequency}' not in low frequency range {LF_RANGE} or high frequency range {HF_RANGE}"
             )
 
         if self.power not in range(*POWER_RANGE):
@@ -127,7 +126,7 @@ class Config:
     approved_callsigns: dict[str, str] = field(default_factory=dict)
 
     def __post_init__(self):
-        if self.approved_callsigns is None or len(self.approved_callsigns) == 0:
+        if len(self.approved_callsigns) == 0:
             raise ValueError("You must provide at least one approved callsign.")
 
     @classmethod

modules/misc/converter.py

@@ -2,19 +2,20 @@
 # Thomas Selwyn (Devil)
 # Matteo Golin (linguini1)
 
+
 def celsius_to_fahrenheit(celsius: float) -> float:
-    """ Returns the passed Celsius value in Fahrenheit as a float. """
+    """Returns the passed Celsius value in Fahrenheit as a float."""
 
     return round((celsius * 1.8) + 32, 1)
 
 
 def metres_to_feet(metres: float) -> float:
-    """ Returns the passed metres value in feet as a float. """
+    """Returns the passed metres value in feet as a float."""
 
     return round(metres * 3.28, 1)
 
 
 def pascals_to_psi(pascals: int) -> float:
-    """ Returns the passed pascals value in psi as a float. """
+    """Returns the passed pascals value in psi as a float."""
 
     return round(pascals / 6895, 2)