Adding type annotations and fixing up formatting.

[kiosk.git] / cnn_rss_renderer.py

diff --git a/cnn_rss_renderer.py b/cnn_rss_renderer.py
index c1ae7fdacbb49fccf0ab55233462508e48abfe70..ae00dc54f879ac63a81fb600e32528a1cd0078ab 100644 (file)
--- a/cnn_rss_renderer.py
+++ b/cnn_rss_renderer.py
@@ -1,47 +1,59 @@
+#!/usr/bin/env python3
+
 import generic_news_rss_renderer
 import re
+from typing import Dict, List
+import xml
 
 
 class cnn_rss_renderer(generic_news_rss_renderer.generic_news_rss_renderer):
-    def __init__(self, name_to_timeout_dict, feed_site, feed_uris, page_title):
+    def __init__(
+        self,
+        name_to_timeout_dict: Dict[str, int],
+        feed_site: str,
+        feed_uris: List[str],
+        page_title: str,
+    ):
         super(cnn_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 "cnn(%s)" % (self.page_title)
+    def debug_prefix(self) -> str:
+        return f"cnn({self.page_title})"
 
-    def get_headlines_page_prefix(self):
-        return "cnn-%s" % (self.page_title)
+    def get_headlines_page_prefix(self) -> str:
+        return f"cnn-{self.page_title}"
 
-    def get_details_page_prefix(self):
-        return "cnn-details-%s" % (self.page_title)
+    def get_details_page_prefix(self) -> str:
+        return f"cnn-details-{self.page_title}"
 
-    def munge_description(self, description):
+    def munge_description(self, description: str) -> str:
         description = re.sub("[Rr]ead full story for latest details.", "", description)
         description = re.sub("<[^>]+>", "", description)
         return description
 
-    def find_image(self, item):
+    def find_image(self, item: xml.etree.ElementTree.Element) -> str:
         image = item.findtext("media:thumbnail")
         if image is not None:
             image_url = image.get("url")
             return image_url
         return None
 
-    def should_use_https(self):
+    def should_use_https(self) -> bool:
         return False
 
-    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, 14):
-            self.debug_print("%s: is too old!" % title)
             return False
         return re.search(r"[Cc][Nn][Nn][A-Za-z]*\.com", title) is None
 
-    def item_is_interesting_for_article(self, title, description, item):
+    def item_is_interesting_for_article(
+        self, title, description, item: xml.etree.ElementTree.Element
+    ):
         if self.is_item_older_than_n_days(item, 7):
-            self.debug_print("%s: is too old!" % title)
             return False
         return (
             re.search(r"[Cc][Nn][Nn][A-Za-z]*\.com", title) is None