Merge pull request #218 from DarkOutcast6/master

Adding html_description attribute to the Cache object

Author: FriedrichFroebel

pycaching/cache.py

@@ -154,7 +154,9 @@ def _from_print_page(cls, geocaching, guid, soup):
         if "attribute" in cache_info["attributes"]:  # 'blank' attribute
             del cache_info["attributes"]["attribute"]
         cache_info["summary"] = content.find("h2", string="Short Description").find_next("div").text
-        cache_info["description"] = content.find("h2", string="Long Description").find_next("div").text
+        raw_description = content.find("h2", string="Long Description").find_next("div")
+        cache_info["description"] = raw_description.text
+        cache_info["description_html"] = str(raw_description)
         hint = content.find(id="uxEncryptedHint")
         cache_info["hint"] = hint.get_text(separator="\n") if hint else None
         cache_info["waypoints"] = Waypoint.from_html(content, table_id="Waypoints")
@@ -222,6 +224,7 @@ def __init__(self, geocaching, wp, **kwargs):
             "attributes",
             "summary",
             "description",
+            "description_html",
             "hint",
             "favorites",
             "pm_only",
@@ -613,6 +616,20 @@ def description(self, description):
         description = str(description).strip()
         self._description = description
 
+    @property
+    @lazy_loaded
+    def description_html(self):
+        """The cache long description in raw HTML.
+
+        :type: :class:`str`
+        """
+        return self._description_html
+
+    @description_html.setter
+    def description_html(self, description):
+        description = str(description).strip()
+        self._description_html = description
+
     @property
     @lazy_loaded
     def hint(self):
@@ -811,7 +828,9 @@ def load(self):
         }
 
         self.summary = root.find(id="ctl00_ContentBody_ShortDescription").text
-        self.description = root.find(id="ctl00_ContentBody_LongDescription").text
+        raw_description = root.find(id="ctl00_ContentBody_LongDescription")
+        self.description = raw_description.text
+        self.description_html = str(raw_description)
 
         self.hint = rot13(root.find(id="div_hint").get_text(separator="\n"))
 
@@ -935,7 +954,9 @@ def load_by_guid(self):
 
         self.summary = content.find("h2", string="Short Description").find_next("div").text
 
-        self.description = content.find("h2", string="Long Description").find_next("div").text
+        raw_description = content.find("h2", string="Long Description").find_next("div")
+        self.description = raw_description.text
+        self.description_html = str(raw_description)
 
         self.hint = content.find(id="uxEncryptedHint").get_text(separator="\n")
 
@@ -1078,7 +1099,6 @@ def load_logbook(self, limit=float("inf")):
                 return
 
             for log_data in logbook_page:
-
                 limit -= 1  # handle limit
                 if limit < 0:
                     return
@@ -1120,7 +1140,6 @@ def load_trackables(self, limit=float("inf")):
         names = [re.split(r"[\<\>]", str(link))[2] for link in links if "track" in link.get("href")]
 
         for name, url in zip(names, urls):
-
             limit -= 1  # handle limit
             if limit < 0:
                 return

test/test_cache.py

@@ -33,7 +33,8 @@ def setUp(self):
             hidden=date(2000, 1, 1),
             attributes={"onehour": True, "kids": False, "available": True},
             summary="text",
-            description="long text",
+            description="Luftballon",
+            description_html="<b>Luftballon</b>",
             hint="rot13",
             favorites=0,
             pm_only=False,
@@ -164,7 +165,6 @@ def test_hidden(self):
                 self.c.hidden = None
 
     def test_visited(self):
-
         with self.subTest("automatic str conversion"):
             self.c.visited = "1/30/2000"
             self.assertEqual(self.c.visited, date(2000, 1, 30))
@@ -188,7 +188,10 @@ def test_summary(self):
         self.assertEqual(self.c.summary, "text")
 
     def test_description(self):
-        self.assertEqual(self.c.description, "long text")
+        self.assertEqual(self.c.description, "Luftballon")
+
+    def test_description_html(self):
+        self.assertEqual(self.c.description_html, "<b>Luftballon</b>")
 
     def test_hint(self):
         self.assertEqual(self.c.hint, "rot13")
@@ -237,6 +240,18 @@ def test_load(self):
                     cache = Cache(self.gc, "GC123456")
                     cache.load()
 
+        with self.subTest("description"):
+            with self.recorder.use_cassette("cache_normal_normal"):
+                cache = Cache(self.gc, "GC4808G")
+                self.assertIn("Tuhle zprávu ti nepíšu proto, abych ti řekl, že ", cache.description)
+                self.assertIn(
+                    (
+                        ';background-color:black;border:1px solid black;padding:20px;">'
+                        "Tuhle zprávu ti nepíšu proto, abych ti řekl, že "
+                    ),
+                    cache.description_html,
+                )
+
     def test_load_quick(self):
         with self.subTest("normal"):
             with self.recorder.use_cassette("cache_quick_normal"):
@@ -279,7 +294,17 @@ def test_load_by_guid(self, mock_load_quick, mock_load):
                 },
             )
             self.assertEqual(cache.summary, "Gibt es das Luftschloss wirklich?")
-            self.assertIn("Seit dem 16.", cache.description)
+            self.assertIn(
+                " funktioniert, der kann gerne eine Mail schreiben.\r\nSeit dem 16. Jahrhundert steht die ",
+                cache.description,
+            )
+            self.assertIn(
+                (
+                    " funktioniert, der kann gerne eine Mail schreiben.</b></p>\r\n"
+                    "Seit dem 16. Jahrhundert steht die "
+                ),
+                cache.description_html,
+            )
             self.assertEqual(cache.hint, "Das ist nicht nötig")
             self.assertGreater(cache.favorites, 350)
             self.assertEqual(len(cache.waypoints), 2)