remove decoder object

Author: jvmvik

serpapi/serpapi.py

@@ -8,7 +8,7 @@ class HttpClient:
     """Simple HTTP client wrapper around urllib3"""
 
     BACKEND = 'https://serpapi.com'
-    SUPPORTED_DECODER = ['json', 'html', 'object']
+    SUPPORTED_DECODER = ['json', 'html']
 
     def __init__(self, parameter: dict = None):
         """Initialize a SerpApi Client with the default parameters provided.
@@ -45,7 +45,6 @@ def start(self, path: str, parameter: dict = None, decoder: str = 'json'):
          The response is decoded using the selected decoder:
           - html: raw HTML response
           - json: deep dict contains search results
-          - object: containing search results as a dynamic object
 
         Parameters:
         ---
@@ -60,16 +59,11 @@ def start(self, path: str, parameter: dict = None, decoder: str = 'json'):
 
         Returns:
         ---
-        dict|str|object
+        dict|str
         decoded HTTP response"""
         # track client language
         self.parameter['source'] = 'serpapi-python:' + __version__
-
-        # set output type
-        if decoder == 'object':
-            self.parameter['output'] = 'json'
-        else:
-            self.parameter['output'] = decoder
+        self.parameter['output'] = decoder
 
         # merge parameter defaults and overrides
         fields = self.parameter.copy()
@@ -106,7 +100,7 @@ def decode(self, response: any, decoder: str):
             return payload
 
         raise SerpApiException("Invalid decoder: " +
-                               decoder + ", available: json, html, object")
+                               decoder + ", available: json, html")
 
 
 class Client(HttpClient):
@@ -130,7 +124,7 @@ def __init__(self, parameter: dict = None):
     def search(self, parameter: dict = None, decoder: str = 'json'):
         """
         make search then decode the output
-         decoder supported 'json', 'html', 'object'
+         decoder supported 'json', 'html'
 
         Parameters
         ----------
@@ -145,7 +139,6 @@ def search(self, parameter: dict = None, decoder: str = 'json'):
             search results returns as :
              dict if decoder = 'json'
              str if decoder = 'html'
-             object if decoder = 'object'
         """
         return self.start(path='/search', parameter=parameter, decoder=decoder)
 
@@ -194,12 +187,9 @@ def search_archive(self, search_id: str, decoder: str = 'json'):
         """
         path = "/searches/" + str(search_id) + "."
         if decoder in self.SUPPORTED_DECODER:
-            if decoder == "object":
-                path += "json"
-            else:
-                path += decoder
+            path += decoder
         else:
-            raise SerpApiException('Decoder must be json or html or object')
+            raise SerpApiException('Decoder must be json or html')
         return self.start(path, {}, decoder)
 
     def account(self, api_key: str = None):

tests/test_search_archive.py

@@ -1,14 +1,8 @@
 import unittest
 import os
-import pprint
 import serpapi
 import pytest
 
-# This test shows how to extends serpapi.Client
-#  without using client engine wrapper.
-#
-
-
 class TestSearchArchive(unittest.TestCase):
 
     @unittest.skipIf((os.getenv("API_KEY") == None), "no api_key provided")
@@ -23,11 +17,13 @@ def test_search_archive(self):
       })
       self.assertEqual(data.get("error"), None)
       self.assertIsNotNone(data["organic_results"][0]["title"])
+      # search unique search identifier
       search_id = data['search_metadata']['id']
+      # fetch results from the archive (free of charge)
       data_archive = client.search_archive(search_id)
       self.assertEqual(data_archive['organic_results'][0], data["organic_results"][0])
 
-      # code coverage
+      # fetch results from the archive again (code coverage)
       object_archive = client.search_archive(search_id, 'object')
       self.assertIsNotNone(object_archive)
       self.assertEqual(object_archive.organic_results[0].title, data["organic_results"][0]["title"])