Python formatting tools (#26)

* Formatting fixes

* Configuration formatting

* PR fixes

* Formatting

* Make module names clearer

Author: Xierumeng

.github/workflows/run-tests.yml

@@ -39,6 +39,13 @@ jobs:
       - name: Install zbar library
         run: sudo apt-get install libzbar0
 
+      # Run linters and formatters
+      - name: Linters and formatters
+        run: |
+          black --check .
+          flake8 .
+          pylint .
+
       # Install dependencies and run tests with PyTest
       - name: Run PyTest
         run: pytest -vv

.gitignore

@@ -4,8 +4,7 @@
 
 # Python
 __pycache__/
-.pytest_cache/
 venv/
 
 # Logging
-*log*
+logs/

README.md

@@ -3,19 +3,3 @@
 Common code across WARG repositories.
 
 Follow the [instructions](https://uwarg-docs.atlassian.net/l/cp/2a6u0duY).
-
-## comms
-
-Python serialization and deserialization for Autonomy.
-
-## camera
-
-Python video ingest from camera device.
-
-## mavlink
-
-Connection to drone using the MAVLink protocol.
-
-## qr
-
-QR scanning and text output.

camera/modules/camera_device.py

@@ -1,6 +1,7 @@
 """
-Camera device using OpenCV
+Camera device using OpenCV.
 """
+
 import sys
 import time
 
@@ -10,15 +11,15 @@
 
 class CameraDevice:
     """
-    Wrapper for camera
+    Wrapper for camera.
     """
 
-    def __init__(self, name: "int | str", save_nth_image: int = 0, save_name: str = ""):
+    def __init__(self, name: "int | str", save_nth_image: int = 0, save_name: str = "") -> None:
         """
-        name: Device name or index (e.g. /dev/video0 )
+        name: Device name or index (e.g. /dev/video0 ).
         (optional) save_nth_image: For debugging, saves every nth image.
             A value of 0 indicates no images should be saved
-        (optional) save_name: For debugging, file name for saved images
+        (optional) save_name: For debugging, file name for saved images.
         """
         self.__camera = cv2.VideoCapture(name)
         assert self.__camera.isOpened()
@@ -32,7 +33,10 @@ def __init__(self, name: "int | str", save_nth_image: int = 0, save_name: str =
         if save_name != "":
             self.__filename_prefix = save_name + "_" + str(int(time.time())) + "_"
 
-    def __del__(self):
+    def __del__(self) -> None:
+        """
+        Destructor.
+        """
         self.__camera.release()
 
     def get_image(self) -> "tuple[bool, np.ndarray]":
@@ -41,9 +45,9 @@ def get_image(self) -> "tuple[bool, np.ndarray]":
         """
         result, image = self.__camera.read()
         if not result:
-            return result, image
+            return False, None
 
-        if self.__divisor != 0:
+        if self.__filename_prefix != "" and self.__divisor != 0:
             if self.__counter % self.__divisor == 0:
                 filename = self.__filename_prefix + str(self.__counter) + ".png"
                 cv2.imwrite(filename, image)

camera/test_camera.py

@@ -2,15 +2,20 @@
 Test camera physically.
 """
 
+import pathlib
+
 import cv2
 
 from camera.modules.camera_device import CameraDevice
 
 
-IMAGE_LOG_PREFIX = "log_image"
+IMAGE_LOG_PREFIX = pathlib.Path("logs", "log_image")
 
 
-if __name__ == "__main__":
+def main() -> int:
+    """
+    Main function.
+    """
     device = CameraDevice(0, 100, IMAGE_LOG_PREFIX)
 
     while True:
@@ -24,7 +29,15 @@
         cv2.imshow("Camera", image)
 
         # Delay for 1 ms
-        if cv2.waitKey(1) & 0xFF == ord('q'):
+        if cv2.waitKey(1) & 0xFF == ord("q"):
             break
 
+    return 0
+
+
+if __name__ == "__main__":
+    result_main = main()
+    if result_main < 0:
+        print(f"ERROR: Status code: {result_main}")
+
     print("Done!")

camera_qr_example.py

@@ -8,8 +8,10 @@
 from qr.modules import qr_scanner
 
 
-if __name__ == "__main__":
-
+def main() -> int:
+    """
+    Main function.
+    """
     camera = camera_device.CameraDevice(0, 0, "")
 
     text = ""
@@ -30,4 +32,12 @@
 
     print(text)
 
+    return 0
+
+
+if __name__ == "__main__":
+    result_main = main()
+    if result_main < 0:
+        print(f"ERROR: Status code: {result_main}")
+
     print("Done!")

kml/modules/ground_locations_to_kml.py

@@ -1,6 +1,7 @@
 """
 Module to convert ground locations list to kml document.
 """
+
 import pathlib
 import time
 
@@ -9,9 +10,11 @@
 from . import location_ground
 
 
-def ground_locations_to_kml(ground_locations: "list[location_ground.LocationGround]",
-                     document_name_prefix: str,
-                     save_directory: pathlib.Path) -> "tuple[bool, pathlib.Path | None]":
+def ground_locations_to_kml(
+    ground_locations: "list[location_ground.LocationGround]",
+    document_name_prefix: str,
+    save_directory: pathlib.Path,
+) -> "tuple[bool, pathlib.Path | None]":
     """
     Generates KML file from a list of ground locations.
 

kml/modules/location_ground.py

@@ -2,6 +2,7 @@
 Class to use instead of tuple for coordinates.
 """
 
+
 class LocationGround:
     """
     LocationGround class represents a geographical ground location with
@@ -15,9 +16,10 @@ class LocationGround:
     Methods:
         __init__(name, latitude, longitude): Initializes a LocationGround object.
         __eq__(other): Checks if two LocationGround objects are equal.
-        __repr__(): Returns a string representation of the LocationGround object.
+        __str__(): Returns a string representation of the LocationGround object.
     """
-    def __init__(self, name: str, latitude: float, longitude: float):
+
+    def __init__(self, name: str, latitude: float, longitude: float) -> None:
         """
         Constructor for the LocationGround object.
 
@@ -46,9 +48,10 @@ def __eq__(self, other: "LocationGround") -> bool:
             and self.longitude == other.longitude
         )
 
-    def __repr__(self) -> str:
+    def __str__(self) -> str:
         """
-        String representation
+        To string.
         """
-        return \
+        return (
             f"LocationGround: {self.name}, latitude: {self.latitude}, longitude: {self.longitude}"
+        )

kml/test_ground_locations_to_kml.py

@@ -1,6 +1,7 @@
 """
 Test Process.
 """
+
 import pathlib
 
 import pytest
@@ -13,8 +14,13 @@
 EXPECTED_KML_DOCUMENT_PATH = pathlib.Path(PARENT_DIRECTORY, "expected_document.kml")
 
 
+# Test functions use test fixture signature names and access class privates
+# No enable
+# pylint: disable=protected-access,redefined-outer-name
+
+
 @pytest.fixture
-def locations():
+def locations() -> "list[location_ground.LocationGround]":  # type: ignore
     """
     List of LocationGround.
     """
@@ -25,8 +31,9 @@ def locations():
     ]
 
 
-def test_locations_to_kml_with_save_path(locations: "list[location_ground.LocationGround]",
-                                         tmp_path: pathlib.Path):
+def test_locations_to_kml_with_save_path(
+    locations: "list[location_ground.LocationGround]", tmp_path: pathlib.Path
+) -> None:
     """
     Basic test case to save KML to the correct path when provided.
     """
@@ -51,5 +58,6 @@ def test_locations_to_kml_with_save_path(locations: "list[location_ground.Locati
     assert actual_kml_file_path.suffix == ".kml"
 
     # Compare the contents of the generated KML file with the static KML file
-    assert actual_kml_file_path.read_text(encoding="utf-8") \
-        == EXPECTED_KML_DOCUMENT_PATH.read_text(encoding="utf-8")
+    assert actual_kml_file_path.read_text(encoding="utf-8") == EXPECTED_KML_DOCUMENT_PATH.read_text(
+        encoding="utf-8"
+    )

mavlink/modules/drone_odometry.py

@@ -1,22 +1,21 @@
 """
 Position and orientation of drone.
 """
+
 import math
 
 
-# Basically a struct
-# pylint: disable=too-few-public-methods
 class DronePosition:
     """
     WGS 84 following ISO 6709 (latitude before longitude).
     """
+
     __create_key = object()
 
     @classmethod
-    def create(cls,
-               latitude: "float | None",
-               longitude: "float | None",
-               altitude: "float | None") -> "tuple[bool, DronePosition | None]":
+    def create(
+        cls, latitude: "float | None", longitude: "float | None", altitude: "float | None"
+    ) -> "tuple[bool, DronePosition | None]":
         """
         latitude, longitude in decimal degrees.
         altitude in metres.
@@ -35,11 +34,9 @@ def create(cls,
 
         return True, DronePosition(cls.__create_key, latitude, longitude, altitude)
 
-    def __init__(self,
-                 class_private_create_key,
-                 latitude: float,
-                 longitude: float,
-                 altitude: float):
+    def __init__(
+        self, class_private_create_key: object, latitude: float, longitude: float, altitude: float
+    ) -> None:
         """
         Private constructor, use create() method.
         """
@@ -49,25 +46,21 @@ def __init__(self,
         self.longitude = longitude
         self.altitude = altitude
 
-# pylint: enable=too-few-public-methods
-
 
-# Basically a struct
-# pylint: disable=too-few-public-methods
 class DroneOrientation:
     """
     Yaw, pitch, roll following NED system (x forward, y right, z down).
     Specifically, intrinsic (Tait-Bryan) rotations in the zyx/3-2-1 order.
     """
+
     __create_key = object()
 
     @classmethod
     # Required for checks
     # pylint: disable-next=too-many-return-statements
-    def create(cls,
-               yaw: "float | None",
-               pitch: "float | None",
-               roll: "float | None") -> "tuple[bool, DroneOrientation | None]":
+    def create(
+        cls, yaw: "float | None", pitch: "float | None", roll: "float | None"
+    ) -> "tuple[bool, DroneOrientation | None]":
         """
         yaw, pitch, roll in radians.
         """
@@ -91,7 +84,9 @@ def create(cls,
 
         return True, DroneOrientation(cls.__create_key, yaw, pitch, roll)
 
-    def __init__(self, class_private_create_key, yaw: float, pitch: float, roll: float):
+    def __init__(
+        self, class_private_create_key: object, yaw: float, pitch: float, roll: float
+    ) -> None:
         """
         Private constructor, use create() method.
         """
@@ -101,21 +96,18 @@ def __init__(self, class_private_create_key, yaw: float, pitch: float, roll: flo
         self.pitch = pitch
         self.roll = roll
 
-# pylint: enable=too-few-public-methods
-
 
-# Basically a struct
-# pylint: disable=too-few-public-methods
 class DroneOdometry:
     """
     Wrapper for DronePosition and DroneOrientation.
     """
+
     __create_key = object()
 
     @classmethod
-    def create(cls,
-               position: DronePosition,
-               orientation: DroneOrientation) -> "tuple[bool, DroneOdometry | None]":
+    def create(
+        cls, position: DronePosition, orientation: DroneOrientation
+    ) -> "tuple[bool, DroneOdometry | None]":
         """
         Position and orientation in one class.
         """
@@ -127,10 +119,12 @@ def create(cls,
 
         return True, DroneOdometry(cls.__create_key, position, orientation)
 
-    def __init__(self,
-                 class_private_create_key,
-                 position: DronePosition,
-                 orientation: DroneOrientation):
+    def __init__(
+        self,
+        class_private_create_key: object,
+        position: DronePosition,
+        orientation: DroneOrientation,
+    ) -> None:
         """
         Private constructor, use create() method.
         """

mavlink/modules/flight_controller.py

@@ -1,6 +1,7 @@
 """
 Wrapper for the flight controller.
 """
+
 import time
 
 import dronekit
@@ -12,6 +13,7 @@ class FlightController:
     """
     Wrapper for DroneKit-Python and MAVLink.
     """
+
     __create_key = object()
 
     __MAVLINK_LANDING_FRAME = dronekit.mavutil.mavlink.MAV_FRAME_GLOBAL
@@ -36,7 +38,7 @@ def create(cls, address: str) -> "tuple[bool, FlightController | None]":
 
         return True, FlightController(cls.__create_key, drone)
 
-    def __init__(self, class_private_create_key, vehicle: dronekit.Vehicle):
+    def __init__(self, class_private_create_key: object, vehicle: dronekit.Vehicle) -> None:
         """
         Private constructor, use create() method.
         """
@@ -79,8 +81,9 @@ def get_odometry(self) -> "tuple[bool, drone_odometry.DroneOdometry | None]":
 
         return True, odometry_data
 
-    def get_home_location(self,
-                          timeout: float) -> "tuple[bool, drone_odometry.DronePosition | None]":
+    def get_home_location(
+        self, timeout: float
+    ) -> "tuple[bool, drone_odometry.DronePosition | None]":
         """
         Attempts to get the drone's home location until timeout.
         timeout: Seconds.
@@ -111,11 +114,11 @@ def upload_commands(self, commands: "list[dronekit.Command]") -> bool:
 
         Parameters
         ----------
-        commands: list[dronekit.Command]
+        commands: List of commands.
 
         Returns
         -------
-        bool
+        bool: Whether the upload is successful.
         """
         if len(commands) == 0:
             return False
@@ -142,16 +145,16 @@ def upload_commands(self, commands: "list[dronekit.Command]") -> bool:
     def upload_land_command(self, latitude: float, longitude: float) -> bool:
         """
         Given a target latitude and longitude, overwrite the drone's current mission
-        with a corresponding dronekit land command.
+        with a corresponding land command.
 
         Parameters
         ----------
-        latitude: float
-        longitude: float
+        latitude: Decimal degrees.
+        longitude: Decimal degrees.
 
         Returns
         -------
-        bool
+        bool: Whether the upload is successful.
         """
         # TODO: DroneKit-Python's Command uses floating point value, which is not accurate enough for WARG. Investigate using MAVLink's integer command.
         landing_command = dronekit.Command(

mavlink/test_flight_controller.py

@@ -1,7 +1,7 @@
 """
 Test for flight input device by printing to console.
 """
-import sys
+
 import time
 
 from mavlink.modules import flight_controller
@@ -12,16 +12,19 @@
 TIMEOUT = 1.0  # seconds
 
 
-if __name__ == "__main__":
+def main() -> int:
+    """
+    Main function.
+    """
     result, controller = flight_controller.FlightController.create(MISSION_PLANNER_ADDRESS)
     if not result:
-        print("failed")
-        sys.exit()
+        print("Failed to open flight controller")
+        return -1
 
     # Get Pylance to stop complaining
     assert controller is not None
 
-    for i in range(5):
+    for _ in range(5):
         result, odometry = controller.get_odometry()
         if result:
             print("lat: " + str(odometry.position.latitude))
@@ -32,23 +35,35 @@
             print("pitch: " + str(odometry.orientation.pitch))
             print("")
         else:
-            print("failed")
+            print("Failed to get odometry")
 
         result, home = controller.get_home_location(TIMEOUT)
         if result:
             print("lat: " + str(home.latitude))
             print("lon: " + str(home.longitude))
             print("alt: " + str(home.altitude))
+        else:
+            print("Failed to get home location")
 
         time.sleep(DELAY_TIME)
 
     result, home = controller.get_home_location(TIMEOUT)
+    if not result:
+        print("Failed to get home location")
+        return -1
 
     # Create and add land command
     result = controller.upload_land_command(home.latitude, home.longitude)
-
     if not result:
         print("Could not upload land command.")
-        sys.exit()
+        return -1
+
+    return 0
+
+
+if __name__ == "__main__":
+    result_main = main()
+    if result_main < 0:
+        print(f"ERROR: Status code: {result_main}")
 
     print("Done!")

mavlink/test_mission_ended.py

@@ -1,7 +1,7 @@
 """
 Test for drone's destination at final waypoint by uploading mission and monitoring it.
 """
-import sys
+
 import time
 
 import dronekit
@@ -24,8 +24,9 @@
 
 # TODO: This function is to be removed when Dronekit-Python interfaces are
 # moved from pathing repository.
-def upload_mission(controller: flight_controller.FlightController,
-                   waypoints: "list[tuple[float, float, float]]") -> bool:
+def upload_mission(
+    controller: flight_controller.FlightController, waypoints: "list[tuple[float, float, float]]"
+) -> bool:
     """
     Add a takeoff command and waypoint following commands to the drone's
     command sequence, and upload them.
@@ -96,11 +97,14 @@ def upload_mission(controller: flight_controller.FlightController,
         return False
 
 
-if __name__ == "__main__":
+def main() -> int:
+    """
+    Main function.
+    """
     result, controller = flight_controller.FlightController.create(MISSION_PLANNER_ADDRESS)
     if not result:
         print("Failed to create flight controller.")
-        sys.exit()
+        return -1
 
     # Get Pylance to stop complaining
     assert controller is not None
@@ -117,14 +121,15 @@ def upload_mission(controller: flight_controller.FlightController,
     result = upload_mission(controller, waypoints)
     if not result:
         print("Failed to upload mission.")
-        sys.exit()
+        return -1
 
     while True:
-        result, is_drone_destination_final_waypoint \
-            = controller.is_drone_destination_final_waypoint()
+        result, is_drone_destination_final_waypoint = (
+            controller.is_drone_destination_final_waypoint()
+        )
         if not result:
             print("Failed to get if the drone's destination is the final waypoint.")
-            sys.exit()
+            return -1
 
         # Get Pylance to stop complaining
         assert is_drone_destination_final_waypoint is not None
@@ -137,4 +142,12 @@ def upload_mission(controller: flight_controller.FlightController,
         time.sleep(DELAY_TIME)
 
     print("Drone's destination is final waypoint.")
+    return 0
+
+
+if __name__ == "__main__":
+    result_main = main()
+    if result_main < 0:
+        print(f"ERROR: Status code: {result_main}")
+
     print("Done!")

pyproject.toml

@@ -0,0 +1,102 @@
+[tool.pylint.main]
+# Add files or directories matching the regular expressions patterns to the
+# ignore-list. The regex matches against paths and can be in Posix or Windows
+# format. Because '\\' represents the directory delimiter on Windows systems, it
+# can't be used as an escape character.
+ignore-paths = [
+    # From .gitignore
+    # IDEs
+    ".idea/",
+    ".vscode/",
+
+    # Python
+    "__pycache__/",
+    "venv/",
+
+    # Logging
+    "logs/",
+]
+
+# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the
+# number of processors available to use, and will cap the count on Windows to
+# avoid hangs.
+jobs = 0
+
+# Minimum Python version to use for version dependent checks. Will default to the
+# version used to run pylint.
+py-version = "3.8"
+
+# Discover python modules and packages in the file system subtree.
+recursive = true
+
+# [tool.pylint.basic]
+# Good variable names which should always be accepted, separated by a comma.
+good-names = [
+    "i",
+    "j",
+    "k",
+    "ex",
+    "Run",
+    "_",
+
+    # Return of main()
+    "result_main",
+]
+
+[tool.pylint."messages control"]
+# Disable the message, report, category or checker with the given id(s). You can
+# either give multiple identifiers separated by comma (,) or put this option
+# multiple times (only on the command line, not in the configuration file where
+# it should appear only once). You can also use "--disable=all" to disable
+# everything first and then re-enable specific checks. For example, if you want
+# to run only the similarities checker, you can use "--disable=all
+# --enable=similarities". If you want to run only the classes checker, but have
+# no Warning level messages displayed, use "--disable=all --enable=classes
+# --disable=W".
+disable = [
+    "raw-checker-failed",
+    "bad-inline-option",
+    "locally-disabled",
+    "file-ignored",
+    "suppressed-message",
+    "useless-suppression",
+    "deprecated-pragma",
+    "use-symbolic-message-instead",
+    "use-implicit-booleaness-not-comparison-to-string",
+    "use-implicit-booleaness-not-comparison-to-zero",
+    # WARG
+    # Ignore TODOs
+    "fixme",
+    # Pylint cannot find modules
+    "import-error",
+    # Covered by Black formatter
+    "line-too-long",
+    # Pylint cannot handle 3rd party imports
+    "no-member",
+    # Some classes are simple
+    "too-few-public-methods",
+    # Function signatures
+    "too-many-arguments",
+    # Don't care
+    "too-many-branches",
+    # Line count in file
+    "too-many-lines",
+    # Don't care
+    "too-many-locals",
+    # Don't care
+    "too-many-statements",
+    # Don't care
+    "too-many-return-statements",
+]
+
+[tool.pylint.similarities]
+# Minimum lines number of a similarity.
+# Main guard
+min-similarity-lines = 10
+
+[tool.pytest.ini_options]
+minversion = "6.0"
+
+[tool.black]
+line-length = 100
+target-version = ["py38"]

qr/modules/qr_scanner.py

@@ -1,5 +1,5 @@
 """
-Converts an image containing QR codes into text
+Converts an image containing QR codes into text.
 """
 
 import numpy as np
@@ -8,18 +8,18 @@
 
 class QrScanner:
     """
-    Wrapper for pyzbar
+    Wrapper for pyzbar.
     """
 
-    def __init__(self):
+    def __init__(self) -> None:
         """
-        Nothing to do
+        Nothing to do.
         """
 
     @staticmethod
     def get_qr_text(frame: np.ndarray) -> "tuple[bool, str | None]":
         """
-        Attempts to find and decode a QR code from the given frame
+        Attempts to find and decode a QR code from the given frame.
         """
         decoded_qrs = pyzbar.decode(frame)
         if len(decoded_qrs) == 0:

qr/test_qr.py

@@ -1,6 +1,7 @@
 """
 Test on some basic QR codes.
 """
+
 import pathlib
 
 import cv2
@@ -15,38 +16,37 @@
 IMAGE_2023_TASK2_ROUTES_PATH = pathlib.Path(PARENT_DIRECTORY, "2023_task2_routes.png")
 
 IMAGE_2023_TASK1_ROUTE_TEXT = "Follow route: Quebec; Lima; Alpha; Tango"
-# Long strings
-# pylint: disable=[line-too-long]
-IMAGE_2023_TASK1_DIVERSION_TEXT = "Avoid the area bounded by: Zulu; Bravo; Tango; Uniform.  Rejoin the route at Lima"
-IMAGE_2023_TASK2_ROUTES_TEXT = "Route number 1: 2 pers; Alpha; Hotel; 15 kg; nil; $37\n" \
-                               + "Route number 2: 6 pers; Bravo; Oscar; 10 kg; nil; $150\n" \
-                               + "Route number 3: 3 pers; Alpha; Papa; 15 kg; nil; $101\n" \
-                               + "Route number 4: 2 pers; Papa; Whiskey; 15 kg; nil; $75\n" \
-                               + "Route number 5: 4 pers; Oscar; Golf; 10 kg; nil; $83\n" \
-                               + "Route number 6: 4 pers; Whiskey; Alpha; 15 kg; nil; $81\n" \
-                               + "Route number 7: 2 pers; Alpha; Zulu; 15 kg; No landing Zulu – Hover for 15s; $44\n" \
-                               + "Route number 8: 6 pers; Golf; Whiskey; 10 kg; nil; $115\n" \
-                               + "Route number 9: 6 pers; Tango; Zulu; 15 kg; No landing Zulu – Hover for 15s; $95\n" \
-                               + "Route number 10: 3 pers; Bravo; Tango; 10 kg; nil; $200\n" \
-                               + "Route number 11: 5 pers; Zulu; Oscar; 15 kg; No landing Zulu – Hover for 15s; $80\n" \
-                               + "Route number 12: 2 pers; Bravo; Papa; 10 kg; nil; $80\n" \
-                               + "Route number 13: 2 pers; Hotel; Zulu; 15 kg; No landing Zulu – Hover for 15s; $42\n" \
-                               + "Route number 14: 2 pers; Whiskey; Hotel; 15 kg; nil; $28\n" \
-                               + "Route number 15: 6 pers; Tango; Oscar; 15 kg; nil; $108\n" \
-                               + "Route number 16: 4 pers; Hotel; Tango; 15 kg; nil; $68\n" \
-                               + "Route number 17: 3 pers; Papa; Zulu; 15 kg; No landing Zulu – Hover for 15s; $93\n" \
-                               + "Route number 18: 2 pers; Bravo; Whiskey; 10 kg; nil; $35\n" \
-                               + "Route number 19: 2 pers; Whiskey; Zulu; 15 kg; No landing Zulu – Hover for 15s; $110\n" \
-
-# pylint: enable=[line-too-long]
+IMAGE_2023_TASK1_DIVERSION_TEXT = (
+    "Avoid the area bounded by: Zulu; Bravo; Tango; Uniform.  Rejoin the route at Lima"
+)
+IMAGE_2023_TASK2_ROUTES_TEXT = """Route number 1: 2 pers; Alpha; Hotel; 15 kg; nil; $37
+Route number 2: 6 pers; Bravo; Oscar; 10 kg; nil; $150
+Route number 3: 3 pers; Alpha; Papa; 15 kg; nil; $101
+Route number 4: 2 pers; Papa; Whiskey; 15 kg; nil; $75
+Route number 5: 4 pers; Oscar; Golf; 10 kg; nil; $83
+Route number 6: 4 pers; Whiskey; Alpha; 15 kg; nil; $81
+Route number 7: 2 pers; Alpha; Zulu; 15 kg; No landing Zulu – Hover for 15s; $44
+Route number 8: 6 pers; Golf; Whiskey; 10 kg; nil; $115
+Route number 9: 6 pers; Tango; Zulu; 15 kg; No landing Zulu – Hover for 15s; $95
+Route number 10: 3 pers; Bravo; Tango; 10 kg; nil; $200
+Route number 11: 5 pers; Zulu; Oscar; 15 kg; No landing Zulu – Hover for 15s; $80
+Route number 12: 2 pers; Bravo; Papa; 10 kg; nil; $80
+Route number 13: 2 pers; Hotel; Zulu; 15 kg; No landing Zulu – Hover for 15s; $42
+Route number 14: 2 pers; Whiskey; Hotel; 15 kg; nil; $28
+Route number 15: 6 pers; Tango; Oscar; 15 kg; nil; $108
+Route number 16: 4 pers; Hotel; Tango; 15 kg; nil; $68
+Route number 17: 3 pers; Papa; Zulu; 15 kg; No landing Zulu – Hover for 15s; $93
+Route number 18: 2 pers; Bravo; Whiskey; 10 kg; nil; $35
+Route number 19: 2 pers; Whiskey; Zulu; 15 kg; No landing Zulu – Hover for 15s; $110
+"""
 
 
 class TestScanner:
     """
-    Tests DetectTarget.run()
+    Tests DetectTarget.run() .
     """
 
-    def test_2023_task1_route(self):
+    def test_2023_task1_route(self) -> None:
         """
         Task 1 route
         """
@@ -63,7 +63,7 @@ def test_2023_task1_route(self):
         assert actual is not None
         assert actual == expected
 
-    def test_2023_task1_diversion(self):
+    def test_2023_task1_diversion(self) -> None:
         """
         Task 1 diversion
         """
@@ -80,7 +80,7 @@ def test_2023_task1_diversion(self):
         assert actual is not None
         assert actual == expected
 
-    def test_2023_task2_routes(self):
+    def test_2023_task2_routes(self) -> None:
         """
         Task 2 routes
         """

requirements.txt

@@ -4,19 +4,20 @@
 # Global
 pytest
 
-# camera
+# Module camera
 opencv-python
 numpy
 
-# comms
-libscrc
-pyserial
-
-# mavlink
+# Module mavlink
 dronekit
 
-# qr
+# Module qr
 pyzbar
 
-# kml
-simplekml
+# Module kml
+simplekml
+
+# Linters and formatters are explicitly versioned
+black==24.2.0
+flake8-annotations==3.0.1
+pylint==3.0.3

setup.cfg

@@ -0,0 +1,19 @@
+[flake8]
+# For annotations only
+select=ANN
+# Disable annotations for `self` and `cls`
+# https://github.com/sco1/flake8-annotations
+ignore=ANN101,ANN102
+# File exclusion
+extend-exclude=
+    # From .gitignore
+    # IDEs
+    .idea/,
+    .vscode/,
+
+    # Python
+    __pycache__/,
+    venv/,
+
+    # Logging
+    logs/,