feat: serpapi toolkit

[JINO-ROHIT]

adds serpapi search toolkit , theres a lot more modules, would you like me to add anymore before i add an example and testcase for this?

reference - https://serpapi.com/search-api

fixes #3476

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch serpapi

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[LIHUA919]

Hi @JINO-ROHIT, It seems the unit tests are missing.

[JINO-ROHIT]

adds serpapi search toolkit , theres a lot more modules, would you like me to add anymore before i add an example and testcase for this?

reference - https://serpapi.com/search-api

fixes #3476

right i was hoping if something else needs to be added before i add test cases + example

[fengju0213]

hi！@JINO-ROHIT thanks for this pr！i think the advantage of serpapi lies in their integration with various search engines, allowing them to be invoked using a unified key.so maybe we can add a parameter，let user can use any search engines they want via this parameter，we can start by supporting some commonly used modules，like：GoogleSearch、Yahoo、Yandex、GoogleScholarSearch and YouTube

[JINO-ROHIT]

hi @fengju0213 yeah i think the engine param is already in the PR unless im misunderstanding something, if this looks good then ill proceed to examples and test cases

[fengju0213]

hi @fengju0213 yeah i think the engine param is already in the PR unless im misunderstanding something, if this looks good then ill proceed to examples and test cases

yeah I noticed you've already added this parameter, but in the proxy logic, we currently only support Google?

[JINO-ROHIT]

@fengju0213 sorry for not understanding this well, can you explain what you are referring to as proxy

[fengju0213]

@fengju0213 sorry for not understanding this well, can you explain what you are referring to as proxy

I mean, although the function parameters support custom configurations, in the implementation logic we currently only support Google, right? Because I see that we only import Google — which means even if users want to configure another engine, they wouldn’t be able to use it?

[JINO-ROHIT]

hi @fengju0213 ah i see what you mean, i think the import is simply poorly named by serpapi, if you change the engine to 'duckduckgo' like this, the results will be from duckduckgo

from serpapi import GoogleSearch
import os

engine = 'duckduckgo'
query = 'whatsup?'

SERPAPI_KEY = os.getenv("SERPAPI_KEY")
params = {
    "engine": engine,
    "q": query,
    "api_key": SERPAPI_KEY,
}

search = GoogleSearch(params)
results = search.get_dict()

[fengju0213]

hi @fengju0213 ah i see what you mean, i think the import is simply poorly named by serpapi, if you change the engine to 'duckduckgo' like this, the results will be from duckduckgo

from serpapi import GoogleSearch
import os

engine = 'duckduckgo'
query = 'whatsup?'

SERPAPI_KEY = os.getenv("SERPAPI_KEY")
params = {
    "engine": engine,
    "q": query,
    "api_key": SERPAPI_KEY,
}

search = GoogleSearch(params)
results = search.get_dict()

ah i see, i read the source code of the serpapi，these search engines have been repackaged. for clarity in naming, perhaps we can use SerpApiClient?

[fengju0213]

hi @fengju0213 ah i see what you mean, i think the import is simply poorly named by serpapi, if you change the engine to 'duckduckgo' like this, the results will be from duckduckgo

from serpapi import GoogleSearch
import os

engine = 'duckduckgo'
query = 'whatsup?'

SERPAPI_KEY = os.getenv("SERPAPI_KEY")
params = {
    "engine": engine,
    "q": query,
    "api_key": SERPAPI_KEY,
}

search = GoogleSearch(params)
results = search.get_dict()

ah i see, i read the source code of the serpapi，these search engines have been repackaged. for clarity in naming, perhaps we can use SerpApiClient?

All the search engines inherit from this class.

[JINO-ROHIT]

done! is it okay to suprres the stub warnings by doing this? disable_error_code , serpapi didnt have stubs and i tried adding to the overrides module but it didnt work

[fengju0213]

done! is it okay to suprres the stub warnings by doing this? disable_error_code , serpapi didnt have stubs and i tried adding to the overrides module but it didnt work

no warries，i will help solve this

[fengju0213]

@JINO-ROHIT everything looks good，lets add some examples ,then we can merge it

[JINO-ROHIT]

@fengju0213 done! is this a new pre-commit that keeps failing?

[fengju0213]

@fengju0213 done! is this a new pre-commit that keeps failing?

This is not related to your PR — I’ll fix it.

[JINO-ROHIT]

thanks!

[LuoPengcheng12138]

LGTM

[a7m-1st]

Thanks @JINO-ROHIT for the PR, regarding the dependencies, perhaps its better to use the decorator as above. I have added the enhancement here:
#3558