Bulk convert comments above classes/functions/methods into proper docstrings

server/webserver.py

@@ -16,10 +16,12 @@ from server.handlers.metrics import PrometheusMetricsHandler
 from server.handlers.pagetemplate import PageTemplateHandler
 
 
-# Provides the public-facing web server.
 class WebServer:
-    # Constructor
+    """Provides the public-facing web server."""
+
     def __init__(self, spots, alerts, status_data, port):
+        """Constructor"""
+
         self.spots = spots
         self.alerts = alerts
         self.sse_spot_queues = []
@@ -35,24 +37,32 @@ class WebServer:
             "status": "Starting"
         }
 
-    # Start the web server
     def start(self):
+        """Start the web server"""
+
         asyncio.run(self.start_inner())
 
-    # Stop the web server
     def stop(self):
+        """Stop the web server"""
+
         self.shutdown_event.set()
 
-    # Start method (async). Sets up the Tornado application.
     async def start_inner(self):
+        """Start method (async). Sets up the Tornado application."""
+
         app = tornado.web.Application([
             # Routes for API calls
             (r"/api/v1/spots", APISpotsHandler, {"spots": self.spots, "web_server_metrics": self.web_server_metrics}),
-            (r"/api/v1/alerts", APIAlertsHandler, {"alerts": self.alerts, "web_server_metrics": self.web_server_metrics}),
-            (r"/api/v1/spots/stream", APISpotsStreamHandler, {"sse_spot_queues": self.sse_spot_queues, "web_server_metrics": self.web_server_metrics}),
-            (r"/api/v1/alerts/stream", APIAlertsStreamHandler, {"sse_alert_queues": self.sse_alert_queues, "web_server_metrics": self.web_server_metrics}),
-            (r"/api/v1/options", APIOptionsHandler, {"status_data": self.status_data, "web_server_metrics": self.web_server_metrics}),
-            (r"/api/v1/status", APIStatusHandler, {"status_data": self.status_data, "web_server_metrics": self.web_server_metrics}),
+            (r"/api/v1/alerts", APIAlertsHandler,
+             {"alerts": self.alerts, "web_server_metrics": self.web_server_metrics}),
+            (r"/api/v1/spots/stream", APISpotsStreamHandler,
+             {"sse_spot_queues": self.sse_spot_queues, "web_server_metrics": self.web_server_metrics}),
+            (r"/api/v1/alerts/stream", APIAlertsStreamHandler,
+             {"sse_alert_queues": self.sse_alert_queues, "web_server_metrics": self.web_server_metrics}),
+            (r"/api/v1/options", APIOptionsHandler,
+             {"status_data": self.status_data, "web_server_metrics": self.web_server_metrics}),
+            (r"/api/v1/status", APIStatusHandler,
+             {"status_data": self.status_data, "web_server_metrics": self.web_server_metrics}),
             (r"/api/v1/lookup/call", APILookupCallHandler, {"web_server_metrics": self.web_server_metrics}),
             (r"/api/v1/lookup/sigref", APILookupSIGRefHandler, {"web_server_metrics": self.web_server_metrics}),
             (r"/api/v1/lookup/grid", APILookupGridHandler, {"web_server_metrics": self.web_server_metrics}),
@@ -61,11 +71,15 @@ class WebServer:
             (r"/", PageTemplateHandler, {"template_name": "spots", "web_server_metrics": self.web_server_metrics}),
             (r"/map", PageTemplateHandler, {"template_name": "map", "web_server_metrics": self.web_server_metrics}),
             (r"/bands", PageTemplateHandler, {"template_name": "bands", "web_server_metrics": self.web_server_metrics}),
-            (r"/alerts", PageTemplateHandler, {"template_name": "alerts", "web_server_metrics": self.web_server_metrics}),
-            (r"/add-spot", PageTemplateHandler, {"template_name": "add_spot", "web_server_metrics": self.web_server_metrics}),
-            (r"/status", PageTemplateHandler, {"template_name": "status", "web_server_metrics": self.web_server_metrics}),
+            (r"/alerts", PageTemplateHandler,
+             {"template_name": "alerts", "web_server_metrics": self.web_server_metrics}),
+            (r"/add-spot", PageTemplateHandler,
+             {"template_name": "add_spot", "web_server_metrics": self.web_server_metrics}),
+            (r"/status", PageTemplateHandler,
+             {"template_name": "status", "web_server_metrics": self.web_server_metrics}),
             (r"/about", PageTemplateHandler, {"template_name": "about", "web_server_metrics": self.web_server_metrics}),
-            (r"/apidocs", PageTemplateHandler, {"template_name": "apidocs", "web_server_metrics": self.web_server_metrics}),
+            (r"/apidocs", PageTemplateHandler,
+             {"template_name": "apidocs", "web_server_metrics": self.web_server_metrics}),
             # Route for Prometheus metrics
             (r"/metrics", PrometheusMetricsHandler),
             # Default route to serve from "webassets"
@@ -76,9 +90,10 @@ class WebServer:
         app.listen(self.port)
         await self.shutdown_event.wait()
 
-    # Internal method called when a new spot is added to the system. This is used to ping any SSE clients that are
-    # awaiting a server-sent message with new spots.
     def notify_new_spot(self, spot):
+        """Internal method called when a new spot is added to the system. This is used to ping any SSE clients that are
+        awaiting a server-sent message with new spots."""
+
         for queue in self.sse_spot_queues:
             try:
                 queue.put(spot)
@@ -87,9 +102,10 @@ class WebServer:
                 pass
         pass
 
-    # Internal method called when a new alert is added to the system. This is used to ping any SSE clients that are
-    # awaiting a server-sent message with new spots.
     def notify_new_alert(self, alert):
+        """Internal method called when a new alert is added to the system. This is used to ping any SSE clients that are
+        awaiting a server-sent message with new spots."""
+
         for queue in self.sse_alert_queues:
             try:
                 queue.put(alert)
@@ -98,13 +114,15 @@ class WebServer:
                 pass
         pass
 
-    # Clean up any SSE queues that are growing too large; probably their client disconnected and we didn't catch it
-    # properly for some reason.
     def clean_up_sse_queues(self):
+        """Clean up any SSE queues that are growing too large; probably their client disconnected and we didn't catch it
+        properly for some reason."""
+
         for q in self.sse_spot_queues:
             try:
                 if q.full():
-                    logging.warn("A full SSE spot queue was found, presumably because the client disconnected strangely. It has been removed.")
+                    logging.warn(
+                        "A full SSE spot queue was found, presumably because the client disconnected strangely. It has been removed.")
                     self.sse_spot_queues.remove(q)
                     empty_queue(q)
             except:
@@ -113,7 +131,8 @@ class WebServer:
         for q in self.sse_alert_queues:
             try:
                 if q.full():
-                    logging.warn("A full SSE alert queue was found, presumably because the client disconnected strangely. It has been removed.")
+                    logging.warn(
+                        "A full SSE alert queue was found, presumably because the client disconnected strangely. It has been removed.")
                     self.sse_alert_queues.remove(q)
                     empty_queue(q)
             except: