kml/modules/ground_locations_to_kml.py

@@ -6,7 +6,7 @@
 
 import simplekml
 
-from kml.modules import location_ground
+from . import location_ground
 
 
 def ground_locations_to_kml(ground_locations: "list[location_ground.LocationGround]",
@@ -30,13 +30,13 @@ def ground_locations_to_kml(ground_locations: "list[location_ground.LocationGrou
     """
     kml = simplekml.Kml()
 
-    for index, ground_location in enumerate(ground_locations):
-        ground_location_name = f"Point {index + 1}: {ground_location.name}"
-        lat = ground_location.latitude
-        lng = ground_location.longitude
+    for i, ground_location in enumerate(ground_locations):
+        ground_location_name = f"Point {i + 1}: {ground_location.name}"
+        latitude = ground_location.latitude
+        longitude = ground_location.longitude
 
-        # coords parameters are in the order: lon, lat, optional height
-        kml.newpoint(name=ground_location_name, coords=[(lng, lat)])
+        # Coordinates are in the order: longitude, latitude, optional height
+        kml.newpoint(name=ground_location_name, coords=[(longitude, latitude)])
 
     kml_file_path = pathlib.Path(save_directory, f"{document_name_prefix}_{int(time.time())}.kml")
 

kml/modules/location_ground.py

@@ -4,7 +4,8 @@
 
 class LocationGround:
     """
-    LocationGround class represents a geographical ground location with a name, latitude, and longitude.
+    LocationGround class represents a geographical ground location with
+    a name, latitude, and longitude.
 
     Attributes:
         name (str): The name or label for the location.
@@ -29,7 +30,7 @@ def __init__(self, name: str, latitude: float, longitude: float):
         self.latitude = latitude
         self.longitude = longitude
 
-    def __eq__(self, other: "LocationGround"):
+    def __eq__(self, other: "LocationGround") -> bool:
         """
         Checks if two LocationGround objects are equal.
 
@@ -45,8 +46,9 @@ def __eq__(self, other: "LocationGround"):
             and self.longitude == other.longitude
         )
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         """
-        Returns a string representation of the LocationGround object.
+        String representation
         """
-        return f"LocationGround: {self.name}, latitude: {self.latitude}, longitude: {self.longitude})"
+        return \
+            f"LocationGround: {self.name}, latitude: {self.latitude}, longitude: {self.longitude}"

kml/test_waypoints_to_kml.py → kml/test_ground_locations_to_kml.py

@@ -14,18 +14,18 @@
 
 
 @pytest.fixture
-def waypoints():
+def locations():
     """
-    Waypoints input.
+    List of LocationGround.
     """
-    return [
-        location_ground.LocationGround("San Francisco", 37.7749, -122.4194), 
-        location_ground.LocationGround("Los Angeles", 34.0522, -118.2437), 
-        location_ground.LocationGround("New York City", 40.7128, -74.0060)
+    yield [
+        location_ground.LocationGround("San Francisco", 37.7749, -122.4194),
+        location_ground.LocationGround("Los Angeles", 34.0522, -118.2437),
+        location_ground.LocationGround("New York City", 40.7128, -74.0060),
     ]
 
 
-def test_waypoints_to_kml_with_save_path(waypoints: "list[location_ground.LocationGround]",
+def test_locations_to_kml_with_save_path(locations: "list[location_ground.LocationGround]",
                                          tmp_path: pathlib.Path):
     """
     Basic test case to save KML to the correct path when provided.
@@ -37,7 +37,7 @@ def test_waypoints_to_kml_with_save_path(waypoints: "list[location_ground.Locati
     tmp_path.mkdir(parents=True, exist_ok=True)
 
     result, actual_kml_file_path = ground_locations_to_kml.ground_locations_to_kml(
-        waypoints,
+        locations,
         actual_kml_document_name,
         tmp_path,
     )