Adding type annotations and fixing up formatting.

[kiosk.git] / bellevue_reporter_rss_renderer.py

diff --git a/bellevue_reporter_rss_renderer.py b/bellevue_reporter_rss_renderer.py
index 1bd351475a16e20af841e84a2cf06d3c0200a2cb..2776ca0bbf52f95dd755a5e08b4e395c03e65830 100644 (file)
--- a/bellevue_reporter_rss_renderer.py
+++ b/bellevue_reporter_rss_renderer.py
@@ -1,27 +1,40 @@
-import generic_news_rss_renderer as gnrss
+#!/usr/bin/env python3
+
 import re
+from typing import List, Dict
+import xml
+
+import generic_news_rss_renderer as gnrss
 
 
 class bellevue_reporter_rss_renderer(gnrss.generic_news_rss_renderer):
-    def __init__(self, name_to_timeout_dict, feed_site, feed_uris, page_title):
+    """Read the Bellevue Reporter's RSS feed."""
+
+    def __init__(
+        self,
+        name_to_timeout_dict: Dict[str, int],
+        feed_site: str,
+        feed_uris: List[str],
+        page_title: str,
+    ):
         super(bellevue_reporter_rss_renderer, self).__init__(
             name_to_timeout_dict, feed_site, feed_uris, page_title
         )
-        self.debug = 1
+        self.debug = True
 
-    def debug_prefix(self):
+    def debug_prefix(self) -> str:
         return "bellevue_reporter(%s)" % (self.page_title)
 
-    def get_headlines_page_prefix(self):
+    def get_headlines_page_prefix(self) -> str:
         return "bellevue-reporter"
 
-    def get_details_page_prefix(self):
+    def get_details_page_prefix(self) -> str:
         return "bellevue-reporter-details"
 
-    def should_use_https(self):
+    def should_use_https(self) -> bool:
         return True
 
-    def munge_description(self, description):
+    def munge_description(self, description: str) -> str:
         description = re.sub("<[^>]+>", "", description)
         description = re.sub(
             "Bellevue\s+Reporter\s+Bellevue\s+Reporter", "", description
@@ -29,30 +42,33 @@ class bellevue_reporter_rss_renderer(gnrss.generic_news_rss_renderer):
         description = re.sub("\s*\-\s*Your local homepage\.\s*", "", description)
         return description
 
-    def item_is_interesting_for_headlines(self, title, description, item):
-        if self.is_item_older_than_n_days(item, 10):
-            self.debug_print("%s: is too old!" % title)
-            return False
-        if (
+    @staticmethod
+    def looks_like_football(title: str, description: str) -> bool:
+        return (
             title.find("NFL") != -1
             or re.search("[Ll]ive [Ss]tream", title) != None
             or re.search("[Ll]ive[Ss]tream", title) != None
             or re.search("[Ll]ive [Ss]tream", description) != None
-        ):
+        )
+
+    def item_is_interesting_for_headlines(
+        self, title: str, description: str, item: xml.etree.ElementTree.Element
+    ) -> bool:
+        if self.is_item_older_than_n_days(item, 10):
+            self.debug_print("%s: is too old!" % title)
+            return False
+        if bellevue_reporter_rss_renderer.looks_like_football(title, description):
             self.debug_print("%s: looks like it's about football." % title)
             return False
         return True
 
-    def item_is_interesting_for_article(self, title, description, item):
+    def item_is_interesting_for_article(
+        self, title: str, description: str, item: xml.etree.ElementTree.Element
+    ) -> bool:
         if self.is_item_older_than_n_days(item, 10):
             self.debug_print("%s: is too old!" % title)
             return False
-        if (
-            title.find(" NFL") != -1
-            or re.search("[Ll]ive [Ss]tream", title) != None
-            or re.search("[Ll]ive[Ss]tream", title) != None
-            or re.search("[Ll]ive [Ss]tream", description) != None
-        ):
+        if bellevue_reporter_rss_renderer.looks_like_football(title, description):
             self.debug_print("%s: looks like it's about football." % title)
             return False
         return True
@@ -76,7 +92,7 @@ class bellevue_reporter_rss_renderer(gnrss.generic_news_rss_renderer):
 # Wire Service
 # </DIV>"""
 # d = x.munge_description(d)
-# print d
+# print(d)
 # if x.fetch_news() == 0:
-#    print "Error fetching news, no items fetched."
+#    print("Error fetching news, no items fetched.")
 # x.shuffle_news()