Update 0.1.16

New DLC search flag and fixed tests

Author: ScrappyCocco

README.md

@@ -107,12 +107,16 @@ Apparently in the default search DLCs don't appear (see: [#6](https://github.com
 
 ```python
 SearchModifiers.NONE
-SearchModifiers.INCLUDE_DLC
+SearchModifiers.INCLUDE_DLC # Probably unnecessary
 SearchModifiers.ISOLATE_DLC
+SearchModifiers.HIDE_DLC
 ```
 
 This optional parameter allow you to specify in the search if you want the default search (no DLCs), to INCLUDE DLCs along with games, or to ISOLATE DLCs (show only DLCs in the result).
 
+**Update January 2020**: Apparently HowLongToBeat re-added DLCs in the default search, so `SearchModifiers.INCLUDE_DLC` should no longer be necessary. It will remain for completeness and compatibility.
+A new option has been added instead: `SearchModifiers.HIDE_DLC`, that is basically the opposite of including DLCs.
+
 ### Results auto-filter
 To ignore games with a very different name, the standard search automatically filter results with a game name that has a similarity with the given name > than `0.4`, not adding the others to the result list.
 If you want all the results, or you want to change this value, you can put a parameter in the constructor:

howlongtobeatpy/howlongtobeatpy/HTMLRequests.py

@@ -12,8 +12,12 @@
 
 class SearchModifiers(Enum):
     NONE = ""
+    # INCLUDE_DLC is left, but should NO LONGER make a difference. HowLongToBeat re-added DLC in standard requests
     INCLUDE_DLC = "show_dlc"
+    # ISOLATE_DLC shows only DLC in the search result
     ISOLATE_DLC = "only_dlc"
+    # HIDE_DLC hide DLCs in the search result
+    HIDE_DLC = "hide_dlc"
 
 
 class HTMLRequests:

howlongtobeatpy/setup.py

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

howlongtobeatpy/tests/test_async_request.py

@@ -67,6 +67,11 @@ async def test_game_with_no_all_values(self):
     @async_test
     async def test_game_default_dlc_search(self):
         results = await HowLongToBeat().async_search("Hearts of Stone")
+        self.assertEqual(1, len(results))
+
+    @async_test
+    async def test_game_hide_dlc_search(self):
+        results = await HowLongToBeat().async_search("Hearts of Stone", search_modifiers=SearchModifiers.HIDE_DLC)
         self.assertEqual(0, len(results))
 
     @async_test

howlongtobeatpy/tests/test_normal_request.py

@@ -83,6 +83,10 @@ def test_game_with_no_all_values(self):
 
     def test_game_default_dlc_search(self):
         results = HowLongToBeat().search("Hearts of Stone")
+        self.assertEqual(1, len(results))
+
+    def test_game_hide_dlc_search(self):
+        results = HowLongToBeat().search("Hearts of Stone", search_modifiers=SearchModifiers.HIDE_DLC)
         self.assertEqual(0, len(results))
 
     def test_game_include_dlc_search(self):

sonar-project.properties

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