first pylint correction

backend/src/main.py

@@ -1,5 +1,7 @@
+"""Main app for backend api"""
+
 import logging
-from fastapi import FastAPI, Query, Body, HTTPException
+from fastapi import FastAPI, HTTPException
 
 from .structs.landmark import Landmark
 from .structs.preferences import Preferences
@@ -21,13 +23,16 @@ refiner = Refiner(optimizer=optimizer)
 
 @app.post("/trip/new")
 def new_trip(preferences: Preferences, start: tuple[float, float], end: tuple[float, float] | None = None) -> Trip:
-    '''
+    """
     Main function to call the optimizer.
-    :param preferences: the preferences specified by the user as the post body
-    :param start: the coordinates of the starting point as a tuple of floats (as url query parameters)
-    :param end: the coordinates of the finishing point as a tuple of floats (as url query parameters)
-    :return: the uuid of the first landmark in the optimized route
-    '''
+
+    Args:
+        preferences (Preferences)   : the preferences specified by the user as the post body
+        start (tuple)   : the coordinates of the starting point as a tuple of floats (as url query parameters)
+        end (tuple)     : the coordinates of the finishing point as a tuple of floats (as url query parameters)
+    Returns: 
+        (uuid) : The uuid of the first landmark in the optimized route
+    """
     if preferences is None:
         raise HTTPException(status_code=406, detail="Preferences not provided")
     if preferences.shopping.score == 0 and preferences.sightseeing.score == 0 and preferences.nature.score == 0:
@@ -50,7 +55,7 @@ def new_trip(preferences: Preferences, start: tuple[float, float], end: tuple[fl
     # insert start and finish to the landmarks list
     landmarks_short.insert(0, start_landmark)
     landmarks_short.append(end_landmark)
-    
+
     # First stage optimization
     try:
         base_tour = optimizer.solve_optimization(preferences.max_time_minute, landmarks_short)
@@ -58,7 +63,7 @@ def new_trip(preferences: Preferences, start: tuple[float, float], end: tuple[fl
         raise HTTPException(status_code=500, detail="No solution found")
     except TimeoutError:
         raise HTTPException(status_code=500, detail="Optimzation took too long")
-    
+
     # Second stage optimization
     refined_tour = refiner.refine_optimization(landmarks, base_tour, preferences.max_time_minute, preferences.detour_tolerance_minute)
 
@@ -71,6 +76,15 @@ def new_trip(preferences: Preferences, start: tuple[float, float], end: tuple[fl
 #### For already existing trips/landmarks
 @app.get("/trip/{trip_uuid}")
 def get_trip(trip_uuid: str) -> Trip:
+    """
+    Look-up the cache for a trip that has been previously generated using its identifier.
+
+    Args:
+        trip_uuid (str) : unique identifier for a trip.
+
+    Returns:
+        (Trip)          : the corresponding trip.
+    """
     try:
         trip = cache_client.get(f"trip_{trip_uuid}")
         return trip
@@ -80,6 +94,15 @@ def get_trip(trip_uuid: str) -> Trip:
 
 @app.get("/landmark/{landmark_uuid}")
 def get_landmark(landmark_uuid: str) -> Landmark:
+    """
+    Returns a Landmark from its unique identifier.
+
+    Args:
+        landmark_uuid (str) : unique identifier for a Landmark.
+
+    Returns:
+        (Landmark)          : the corresponding Landmark.
+    """
     try:
         landmark = cache_client.get(f"landmark_{landmark_uuid}")
         return landmark