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

alertproviders/alert_provider.py

@@ -5,11 +5,12 @@ import pytz
 from core.config import MAX_ALERT_AGE
 
 
-# Generic alert provider class. Subclasses of this query the individual APIs for alerts.
 class AlertProvider:
+    """Generic alert provider class. Subclasses of this query the individual APIs for alerts."""
 
-    # Constructor
     def __init__(self, provider_config):
+        """Constructor"""
+
         self.name = provider_config["name"]
         self.enabled = provider_config["enabled"]
         self.last_update_time = datetime.min.replace(tzinfo=pytz.UTC)
@@ -17,19 +18,22 @@ class AlertProvider:
         self.alerts = None
         self.web_server = None
 
-    # Set up the provider, e.g. giving it the alert list to work from
     def setup(self, alerts, web_server):
+        """Set up the provider, e.g. giving it the alert list to work from"""
+
         self.alerts = alerts
         self.web_server = web_server
 
-    # Start the provider. This should return immediately after spawning threads to access the remote resources
     def start(self):
+        """Start the provider. This should return immediately after spawning threads to access the remote resources"""
+
         raise NotImplementedError("Subclasses must implement this method")
 
-    # Submit a batch of alerts retrieved from the provider. There is no timestamp checking like there is for spots,
-    # because alerts could be created at any point for any time in the future. Rely on hashcode-based id matching
-    # to deal with duplicates.
     def submit_batch(self, alerts):
+        """Submit a batch of alerts retrieved from the provider. There is no timestamp checking like there is for spots,
+        because alerts could be created at any point for any time in the future. Rely on hashcode-based id matching
+        to deal with duplicates."""
+
         # Sort the batch so that earliest ones go in first. This helps keep the ordering correct when alerts are fired
         # off to SSE listeners.
         alerts = sorted(alerts, key=lambda alert: (alert.start_time if alert and alert.start_time else 0))
@@ -45,6 +49,7 @@ class AlertProvider:
             if self.web_server:
                 self.web_server.notify_new_alert(alert)
 
-    # Stop any threads and prepare for application shutdown
     def stop(self):
-        raise NotImplementedError("Subclasses must implement this method")
+        """Stop any threads and prepare for application shutdown"""
+
+        raise NotImplementedError("Subclasses must implement this method")