Adding type annotations and fixing up formatting.

[kiosk.git] / wsj_rss_renderer.py

diff --git a/wsj_rss_renderer.py b/wsj_rss_renderer.py
index f9410186b5014fd000f692212de03dd2ee6afe37..587c5510132d4e02c3667cebb06acbf50ae55a8b 100644 (file)
--- a/wsj_rss_renderer.py
+++ b/wsj_rss_renderer.py
@@ -1,41 +1,54 @@
-import generic_news_rss_renderer
+#!/usr/bin/env python3
 
+import xml
+from typing import Dict, List
 
-class wsj_rss_renderer(generic_news_rss_renderer.generic_news_rss_renderer):
-    def __init__(self, name_to_timeout_dict, feed_site, feed_uris, page_title):
+import generic_news_rss_renderer as gnrssr
+
+
+class wsj_rss_renderer(gnrssr.generic_news_rss_renderer):
+    def __init__(
+        self,
+        name_to_timeout_dict: Dict[str, int],
+        feed_site: str,
+        feed_uris: List[str],
+        page_title: str,
+    ):
         super(wsj_rss_renderer, self).__init__(
             name_to_timeout_dict, feed_site, feed_uris, page_title
         )
-        self.debug = 1
+        self.debug = True
 
-    def debug_prefix(self):
-        return "wsj(%s)" % (self.page_title)
+    def debug_prefix(self) -> str:
+        return f"wsj({self.page_title})"
 
-    def get_headlines_page_prefix(self):
-        return "wsj-%s" % (self.page_title)
+    def get_headlines_page_prefix(self) -> str:
+        return f"wsj-{self.page_title}"
 
-    def get_details_page_prefix(self):
-        return "wsj-details-%s" % (self.page_title)
+    def get_details_page_prefix(self) -> str:
+        return f"wsj-details-{self.page_title}"
 
-    def find_image(self, item):
+    def find_image(self, item: xml.etree.ElementTree.Element) -> str:
         image = item.findtext("image")
         if image is not None:
             url = image.get("url")
             return url
         return None
 
-    def should_use_https(self):
+    def should_use_https(self) -> bool:
         return True
 
-    def item_is_interesting_for_headlines(self, title, description, item):
+    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, 7):
-            self.debug_print("%s: is too old!" % title)
             return False
         return "WSJ.com" not in title and "WSJ.com" not in description
 
-    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, 7):
-            self.debug_print("%s: is too old!" % title)
             return False
         return "WSJ.com" not in title and "WSJ.com" not in description