2021-09-01 @ 2.4.1

 - raise SerpApiClientException instead of raw string in order to follow Python guideline 3.5+ - add more unit error tests for serp_api_clien

Author: jvmvik

Makefile

@@ -19,7 +19,8 @@ install:
 test:
 pytest
 
-# run example only
+# run example only 
+# and display output (-s)
 example:
 pytest -s "tests/test_example.py::TestExample::test_async"
 

README.md

@@ -84,6 +84,7 @@ See the [playground to generate your code.](https://serpapi.com/playground)
  - [Batch Asynchronous Searches](#batch-asynchronous-searches)
  - [Python object as a result](#python-object-as-a-result)
  - [Python paginate using iterator](#pagination-using-iterator)
+ - [Error management](#error-management)
  - [Change log](#change-log)
  - [Conclusion](#conclusion)
 
@@ -191,6 +192,7 @@ The previous search can be retrieve from the the cache for free.
 from serpapi import GoogleSearch
 search = GoogleSearch({"q": "Coffee", "location": "Austin,Texas"})
 search_result = search.get_dictionary()
+assert search_result.get("error") == None
 search_id = search_result.get("search_metadata").get("id")
 print(search_id)
 ```
@@ -526,7 +528,27 @@ if len(urls) == len(set(urls)):
 
 Examples to fetch links with pagination: [test file](https://github.com/serpapi/google-search-results-python/blob/master/tests/test_example_paginate.py), [online IDE](https://replit.com/@DimitryZub1/Scrape-Google-News-with-Pagination-python-serpapi)
 
+### Error management
+
+SerpAPI keeps error mangement very basic.
+ - backend service error or search fail
+ - client error
+
+If it's a backend error, a simple message error is returned as string in the server response.
+```python
+from serpapi import GoogleSearch
+search = GoogleSearch({"q": "Coffee", "location": "Austin,Texas", "api_key": "<secret_key>"})
+data = search.get_json()
+assert data["error"] == None
+```
+In some case, there is more details availabel in the data object.
+
+If it's client error, then a SerpApiClientException is raised.
+
 ## Change log
+2021-09-01 @ 2.4.1
+ - raise SerpApiClientException instead of raw string in order to follow Python guideline 3.5+
+ - add more unit error tests for serp_api_client
 2021-07-26 @ 2.4.0
  - add page size support using num parameter
  - add youtube search engine

serpapi/baidu_search.py

@@ -1,4 +1,5 @@
 from serpapi.serp_api_client import *
+from serpapi.serp_api_client_exception import SerpApiClientException
 
 class BaiduSearch(SerpApiClient):
  """BaiduSearch enables to search baidu and parse the result.
@@ -15,4 +16,4 @@ def __init__(self, params_dict):
  super(BaiduSearch, self).__init__(params_dict, BAIDU_ENGINE)
 
  def get_location(self, q, limit = 5):
- raise "location is not supported by Baidu search engine at this time"
+ raise SerpApiClientException("location is not supported by Baidu search engine at this time")

serpapi/ebay_search.py

@@ -1,4 +1,5 @@
 from serpapi.serp_api_client import *
+from serpapi.serp_api_client_exception import SerpApiClientException
 
 class EbaySearch(SerpApiClient):
  """EbaySearch enables to search ebay and parse the result.
@@ -15,4 +16,4 @@ def __init__(self, params_dict):
  super(EbaySearch, self).__init__(params_dict, EBAY_ENGINE)
 
  def get_location(self, q, limit = 5):
- raise "location is not supported by Ebay search engine at this time"
+ raise SerpApiClientException("location is not supported by Ebay search engine at this time")

serpapi/google_scholar_search.py

@@ -1,4 +1,5 @@
 from serpapi.serp_api_client import *
+from serpapi.serp_api_client_exception import SerpApiClientException
 
 class GoogleScholarSearch(SerpApiClient):
  """GoogleScholarSearch enables to search google scholar and parse the result.
@@ -15,4 +16,4 @@ def __init__(self, params_dict):
  super(GoogleScholarSearch, self).__init__(params_dict, GOOGLE_SCHOLAR_ENGINE)
 
  def get_location(self, q, limit = 5):
- raise "location is not supported by Google scholar search engine"
+ raise SerpApiClientException("location is not supported by Google scholar search engine")

serpapi/home_depot_search.py

@@ -1,4 +1,5 @@
 from serpapi.serp_api_client import *
+from serpapi.serp_api_client_exception import SerpApiClientException
 
 class HomeDepotSearch(SerpApiClient):
  """HomeDepotSearch enables to search home depot and parse the result.
@@ -15,4 +16,4 @@ def __init__(self, params_dict):
  super(HomeDepotSearch, self).__init__(params_dict, HOME_DEPOT_ENGINE)
 
  def get_location(self, q, limit = 5):
- raise "location is not supported by Home Depot search engine"
+ raise SerpApiClientException("location is not supported by Home Depot search engine")

serpapi/pagination.py

@@ -1,4 +1,4 @@
-import pprint
+from serpapi.serp_api_client_exception import SerpApiClientException
 
 DEFAULT_START = 0 
 DEFAULT_END = 1000000000
@@ -28,9 +28,9 @@ def __init__(self, client, start = DEFAULT_START, end = DEFAULT_END, num = DEFAU
 
  # basic check
  if self.start > self.end:
- raise "start: {} must be less than end: {}".format(self.start, self.end)
+ raise SerpApiClientException("start: {} must be less than end: {}".format(self.start, self.end))
  if(self.start + self.num) > self.end:
- raise "start + num: {} + {} must be less than end: {}".format(self.start, self.num, self.end)
+ raise SerpApiClientException("start + num: {} + {} must be less than end: {}".format(self.start, self.num, self.end))
 
  def __iter__(self):
  self.update()

serpapi/serp_api_client.py

@@ -1,6 +1,7 @@
 import requests
 import json
 from serpapi.pagination import Pagination
+from serpapi.serp_api_client_exception import SerpApiClientException
 
 GOOGLE_ENGINE = 'google'
 BING_ENGINE = 'bing'
@@ -28,7 +29,8 @@ class SerpApiClient(object):
  https://serpapi.com/search-api
  """
 
- BACKEND = "https://serpapi.com"
+ #BACKEND = "https://serpapi.com"
+ BACKEND = "http://localhost:3000"
  SERP_API_KEY = None
 
  def __init__(self, params_dict, engine = None, timeout = 60000):
@@ -44,8 +46,7 @@ def construct_url(self, path = "/search"):
  if not 'engine' in self.params_dict:
  self.params_dict['engine'] = self.engine
  if not 'engine' in self.params_dict:
- raise "engine must be defined in params_dict or engine"
-
+ raise SerpApiClientException("engine must be defined in params_dict or engine")
  return self.BACKEND + path, self.params_dict
 
  def get_response(self, path = '/search'):

serpapi/serp_api_client_exception.py

@@ -0,0 +1,2 @@
+class SerpApiClientException(Exception):
+ pass

serpapi/yahoo_search.py

@@ -1,4 +1,5 @@
 from serpapi.serp_api_client import *
+from serpapi.serp_api_client_exception import SerpApiClientException
 
 class YahooSearch(SerpApiClient):
  """YahooSearch enables to search yahoo and parse the result.
@@ -15,4 +16,4 @@ def __init__(self, params_dict):
  super(YahooSearch, self).__init__(params_dict, YAHOO_ENGINE)
 
  def get_location(self, q, limit = 5):
- raise "location is not supported by Yahoo search engine at this time"
+ raise SerpApiClientException("location is not supported by Yahoo search engine at this time")