closes #8 - version 0.1.18

This version add the game title suffix

For more informations see #8

Author: ScrappyCocco

howlongtobeatpy/howlongtobeatpy/HTMLResultParser.py

@@ -29,6 +29,7 @@ def __init__(self, input_game_name: str, input_game_url: str,
         self.current_entry = None
         self.li_encountered = False
         self.inside_a_div = False
+        self.inside_a_strong = False
         self.inside_a_title_link = False
         self.currently_reading = None
         self.game_name = None
@@ -51,6 +52,8 @@ def handle_starttag(self, tag, attrs):
                 self.current_entry = HowLongToBeatEntry()
 
         if self.li_encountered:  # If i already read the <li> tag i'm inside a game entry
+            if tag == "strong":
+                self.inside_a_strong = True
             if tag == "a":  # The <a> tag contain the game title and the game page id
                 for att in attrs:
                     if att[0] == "title":  # Read the current game title
@@ -72,6 +75,8 @@ def handle_starttag(self, tag, attrs):
     def handle_endtag(self, tag):
         if tag == "a" and self.inside_a_title_link:  # No longer in the <a> link with the game name
             self.inside_a_title_link = False
+        if tag == "strong" and self.inside_a_strong:
+            self.inside_a_strong = False
         if tag == "div":  # I save that i'm no longer inside a <div> element
             self.inside_a_div = False
         if tag == "li" and self.li_encountered:  # I finished reading the game entry
@@ -97,7 +102,9 @@ def handle_endtag(self, tag):
     # OVERRIDE from HTMLParser
     def handle_data(self, data):
         if self.inside_a_title_link and len(data.strip()) > 0:
-            self.current_entry.game_name = data.strip()
+            self.current_entry.game_name = data.strip()  # Save the title of the game
+        if self.inside_a_strong and len(data.strip()) > 0:
+            self.current_entry.game_name_suffix = data.strip()  # Save the suffix of the game
         if self.inside_a_div:
             # If i'm inside a <div> i must analyze all the possible times, saving title and then his value
             if data.lower().strip() == "main story" \

howlongtobeatpy/howlongtobeatpy/HowLongToBeatEntry.py

@@ -11,6 +11,7 @@ def __init__(self):
         # Base Game Details
         self.game_id = -1
         self.game_name = None
+        self.game_name_suffix = None
         self.game_image_url = None
         self.game_web_link = None
         # Gameplay Main

howlongtobeatpy/setup.py

@@ -4,7 +4,7 @@
     long_description = fh.read()
 
 setup(name='howlongtobeatpy',
-      version='0.1.17',
+      version='0.1.18',
       packages=find_packages(exclude=['tests']),
       description='A Python API for How Long to Beat',
       long_description=long_description,

howlongtobeatpy/tests/test_async_request.py

@@ -108,6 +108,24 @@ async def test_game_case_sensitive(self):
         self.assertTrue(best_element_standard.similarity <= best_element_not_case.similarity,
                         "Wrong similarity results")
 
+    @async_test
+    async def test_game_suffix_present(self):
+        results = await HowLongToBeat(0).async_search("God Of War")
+        self.assertNotEqual(None, results, "Search Results are None")
+        self.assertNotEqual(0, len(results))
+        best_element = max(results, key=lambda element: element.similarity)
+        self.assertEqual("God of War".lower(), best_element.game_name.lower())
+        self.assertNotEqual(None, best_element.game_name_suffix, "The suffix is still None, it should not be")
+        self.assertEqual(best_element.game_name_suffix, "(2018)")
+
+    @async_test
+    async def test_game_suffix_not_present(self):
+        results = await HowLongToBeat(0).async_search("The Witcher 3: Wild Hunt")
+        self.assertNotEqual(None, results, "Search Results are None")
+        self.assertNotEqual(0, len(results))
+        best_element = max(results, key=lambda element: element.similarity)
+        self.assertEqual(None, best_element.game_name_suffix, "The suffix is not None, it should be")
+
     @async_test
     async def test_no_real_game(self):
         results = await HowLongToBeat().async_search("asfjklagls")

howlongtobeatpy/tests/test_normal_request.py

@@ -119,6 +119,22 @@ def test_game_case_sensitive(self):
         self.assertTrue(best_element_standard.similarity <= best_element_not_case.similarity,
                         "Wrong similarity results")
 
+    def test_game_suffix_present(self):
+        results = HowLongToBeat(0).search("God Of War")
+        self.assertNotEqual(None, results, "Search Results are None")
+        self.assertNotEqual(0, len(results))
+        best_element = max(results, key=lambda element: element.similarity)
+        self.assertEqual("God of War".lower(), best_element.game_name.lower())
+        self.assertNotEqual(None, best_element.game_name_suffix, "The suffix is still None, it should not be")
+        self.assertEqual(best_element.game_name_suffix, "(2018)")
+
+    def test_game_suffix_not_present(self):
+        results = HowLongToBeat(0).search("The Witcher 3: Wild Hunt")
+        self.assertNotEqual(None, results, "Search Results are None")
+        self.assertNotEqual(0, len(results))
+        best_element = max(results, key=lambda element: element.similarity)
+        self.assertEqual(None, best_element.game_name_suffix, "The suffix is not None, it should be")
+
     def test_no_real_game(self):
         results = HowLongToBeat().search("asfjklagls")
         self.assertEqual(0, len(results))

sonar-project.properties

@@ -2,7 +2,7 @@ sonar.organization=scrappycocco-github
 sonar.projectKey=ScrappyCocco_HowLongToBeat-PythonAPI
 
 sonar.projectName=HowLongToBeat-PythonAPI
-sonar.projectVersion=0.1.17
+sonar.projectVersion=0.1.18
 
 # Path is relative to the sonar-project.properties file. Replace "\" by "/" on Windows.
 # This property is optional if sonar.modules is set.