refactor: implement base interface wrappers and add Serper search engine

Makefile

@@ -8,4 +8,7 @@ lint:
 	python -m ruff check --select I,RUF022 --fix .
 
 check:
-	python -m ruff check .
+	python -m ruff check .
+
+run:
+	python app.py

app.py

@@ -1,27 +1,8 @@
-import gradio as gr
-
-from search_engines.duckduckgo import duckduckgo_interface
-from search_engines.searxng import searxng_interface
-from search_engines.serpapi import serpapi_interface
-from search_engines.tavily import tavily_interface
-
-app = gr.TabbedInterface(
-    interface_list=[
-        duckduckgo_interface,
-        tavily_interface,
-        searxng_interface,
-        serpapi_interface,
-    ],
-    tab_names=[
-        "DuckDuckGo Search",
-        "Tavily Search",
-        "SearxNG Search",
-        "SerpAPI Search",
-    ],
-)
-
+from app_wrapper import AppWrapper
+from register_interfaces import register_all_interfaces
 
 if __name__ == "__main__":
-    app.launch(
-        mcp_server=True,
-    )
+    wrapper = AppWrapper()
+    register_all_interfaces(wrapper)
+    wrapper.build_app()
+    wrapper.launch(mcp_server=True)

app_wrapper.py

@@ -0,0 +1,26 @@
+import gradio as gr
+
+
+class AppWrapper:
+    def __init__(self):
+        self._interfaces = []  # List of tuples: (interface_obj, tab_name)
+
+    def register_interface(self, interface_obj, tab_name):
+        """
+        Register an interface object with a corresponding tab name.
+        """
+        self._interfaces.append((interface_obj, tab_name))
+
+    def build_app(self):
+        """
+        Build the Gradio TabbedInterface from registered interfaces.
+        """
+        interface_list = [iface.interface for iface, _ in self._interfaces]
+        tab_names = [tab for _, tab in self._interfaces]
+        self.app = gr.TabbedInterface(
+            interface_list=interface_list,
+            tab_names=tab_names,
+        )
+
+    def launch(self, **kwargs):
+        self.app.launch(**kwargs)

register_interfaces.py

@@ -0,0 +1,16 @@
+from search_engines.duckduckgo import DuckDuckGoInterfaceWrapper
+from search_engines.searxng import SearxNGInterfaceWrapper
+from search_engines.serpapi import SerpAPIInterfaceWrapper
+from search_engines.serper import SerperInterfaceWrapper
+from search_engines.tavily import TavilyInterfaceWrapper
+
+
+def register_all_interfaces(wrapper):
+    """
+    Register all search engine interfaces with the provided AppWrapper instance.
+    """
+    wrapper.register_interface(DuckDuckGoInterfaceWrapper(), "DuckDuckGo Search")
+    wrapper.register_interface(TavilyInterfaceWrapper(), "Tavily Search")
+    wrapper.register_interface(SearxNGInterfaceWrapper(), "SearxNG Search")
+    wrapper.register_interface(SerpAPIInterfaceWrapper(), "SerpAPI Search")
+    wrapper.register_interface(SerperInterfaceWrapper(), "Serper Search")

requirements.txt

@@ -6,4 +6,5 @@ langchain-community==0.3.24
 duckduckgo-search==8.0.2
 pandas==2.2.3
 ruff==0.11.12
-langchain-tavily==0.2.1
+langchain-tavily==0.2.1
+wikipedia==1.4.0

search_engines/base.py

@@ -0,0 +1,21 @@
+import gradio as gr
+
+
+class BaseInterfaceWrapper:
+    def __init__(self, fn, inputs, outputs=None, title=None, description=None):
+        if outputs is None:
+            outputs = gr.Dataframe(
+                label="Search Results",
+                headers=["title", "body", "link"],
+                show_fullscreen_button=True,
+                show_row_numbers=True,
+                show_copy_button=True,
+                wrap=True,
+            )
+        self.interface = gr.Interface(
+            fn=fn,
+            inputs=inputs,
+            outputs=outputs,
+            title=title,
+            description=description,
+        )

search_engines/duckduckgo.py

@@ -4,6 +4,8 @@ from langchain_community.tools import DuckDuckGoSearchResults
 
 from utils.helpers import map_results
 
+from .base import BaseInterfaceWrapper
+
 
 async def duckduckgo_search(query: str, max_results: int = 5) -> pd.DataFrame:
     """
@@ -14,7 +16,9 @@ async def duckduckgo_search(query: str, max_results: int = 5) -> pd.DataFrame:
         max_results (int, optional): The number of maximum results to return. Defaults to 5.
 
     Returns:
-        str: The search results from DuckDuckGo Search Engine.
+        dict: The search results from DuckDuckGo Search Engine. Fields:
+            headers (list): The headers of the columns in the search results. Contains "title", "link", "body".
+            data (list): The data in the search results. Each row contains the title, link, and body of the search result.
     """
     ddg = DuckDuckGoSearchResults(
         output_format="list",
@@ -30,20 +34,16 @@ async def duckduckgo_search(query: str, max_results: int = 5) -> pd.DataFrame:
     return results
 
 
-duckduckgo_interface = gr.Interface(
-    fn=duckduckgo_search,
-    inputs=[
-        gr.Textbox(label="Search Query"),
-        gr.Slider(minimum=1, maximum=10, step=1, value=5, label="Number of Results"),
-    ],
-    outputs=gr.Dataframe(
-        label="Search Results",
-        headers=["title", "body", "link"],
-        show_fullscreen_button=True,
-        show_row_numbers=True,
-        show_copy_button=True,
-        wrap=True,
-    ),
-    title="DuckDuckGo Search",
-    description="Search the web using DuckDuckGo Search Engine.",
-)
+class DuckDuckGoInterfaceWrapper(BaseInterfaceWrapper):
+    def __init__(self):
+        super().__init__(
+            fn=duckduckgo_search,
+            inputs=[
+                gr.Textbox(label="Search Query"),
+                gr.Slider(
+                    minimum=1, maximum=10, step=1, value=5, label="Number of Results"
+                ),
+            ],
+            title="DuckDuckGo Search",
+            description="Search the web using DuckDuckGo Search Engine.",
+        )

search_engines/searxng.py

@@ -4,6 +4,8 @@ from langchain_community.utilities import SearxSearchWrapper
 
 from utils.helpers import map_results
 
+from .base import BaseInterfaceWrapper
+
 
 async def searxng_search(
     query: str, searxng_host: str, max_results: int = 5
@@ -18,7 +20,9 @@ async def searxng_search(
         max_results (int, optional): The number of maximum results to return. Defaults to 5.
 
     Returns:
-        str: The search results from SearxNG Search Engine.
+        dict: The search results from SearxNG Search Engine. Fields:
+            headers (list): The headers of the columns in the search results. Contains "title", "link", "body".
+            data (list): The data in the search results. Each row contains the title, link, and body of the search result.
     """
     searxng = SearxSearchWrapper(
         searx_host=searxng_host,
@@ -37,21 +41,16 @@ async def searxng_search(
     return results
 
 
-searxng_interface = gr.Interface(
-    fn=searxng_search,
-    inputs=[
-        gr.Textbox(label="Search Query"),
-        gr.Textbox(label="SearxNG Host URL"),
-        gr.Slider(minimum=1, maximum=10, step=1, value=5, label="Number of Results"),
-    ],
-    outputs=gr.Dataframe(
-        label="Search Results",
-        headers=["title", "body", "link"],
-        show_fullscreen_button=True,
-        show_row_numbers=True,
-        show_copy_button=True,
-        wrap=True,
-    ),
-    title="SearxNG Search",
-    description="Search the web using SearxNG Search Engine.",
-)
+class SearxNGInterfaceWrapper(BaseInterfaceWrapper):
+    def __init__(self):
+        super().__init__(
+            fn=searxng_search,
+            inputs=[
+                gr.Textbox(label="Search Query"),
+                gr.Slider(
+                    minimum=1, maximum=10, step=1, value=5, label="Number of Results"
+                ),
+            ],
+            title="SearxNG Search",
+            description="Search the web using SearxNG Search Engine.",
+        )

search_engines/serpapi.py

@@ -4,6 +4,8 @@ from langchain_community.utilities import SerpAPIWrapper
 
 from utils.helpers import map_results
 
+from .base import BaseInterfaceWrapper
+
 
 async def serpapi_search(
     query: str, api_key: str, max_results: int = 5
@@ -17,7 +19,9 @@ async def serpapi_search(
         max_results (int, optional): The number of maximum results to return. Defaults to 5.
 
     Returns:
-        str: The search results from SerpAPI Search Engine.
+        dict: The search results from SerpAPI Search Engine. Fields:
+            headers (list): The headers of the columns in the search results. Contains "title", "link", "body".
+            data (list): The data in the search results. Each row contains the title, link, and body of the search result.
     """
     serpapi = SerpAPIWrapper(
         serpapi_api_key=api_key,
@@ -34,21 +38,17 @@ async def serpapi_search(
     return results
 
 
-serpapi_interface = gr.Interface(
-    fn=serpapi_search,
-    inputs=[
-        gr.Textbox(label="Search Query"),
-        gr.Textbox(label="API Key", type="password"),
-        gr.Slider(minimum=1, maximum=10, step=1, value=5, label="Number of Results"),
-    ],
-    outputs=gr.Dataframe(
-        label="Search Results",
-        headers=["title", "body", "link"],
-        show_fullscreen_button=True,
-        show_row_numbers=True,
-        show_copy_button=True,
-        wrap=True,
-    ),
-    title="SerpAPI Search",
-    description="Search the web using SerpAPI Search Engine.",
-)
+class SerpAPIInterfaceWrapper(BaseInterfaceWrapper):
+    def __init__(self):
+        super().__init__(
+            fn=serpapi_search,
+            inputs=[
+                gr.Textbox(label="Search Query"),
+                gr.Textbox(label="API Key", type="password"),
+                gr.Slider(
+                    minimum=1, maximum=10, step=1, value=5, label="Number of Results"
+                ),
+            ],
+            title="SerpAPI Search",
+            description="Search the web using SerpAPI Search Engine.",
+        )

search_engines/serper.py

@@ -0,0 +1,52 @@
+import gradio as gr
+import pandas as pd
+from langchain_community.utilities import GoogleSerperAPIWrapper
+
+from utils.helpers import map_results
+
+from .base import BaseInterfaceWrapper
+
+
+async def serper_search(query: str, api_key: str, max_results: int = 5) -> pd.DataFrame:
+    """
+    Given a search query, returns the search results from Serper.
+
+    Args:
+        query (str): The search query.
+        api_key (str): The API key for Serper Search.
+        max_results (int, optional): The number of maximum results to return. Defaults to 5.
+
+    Returns:
+        dict: The search results from Serper Search Engine. Fields:
+            headers (list): The headers of the columns in the search results. Contains "title", "link", "body".
+            data (list): The data in the search results. Each row contains the title, link, and body of the search result.
+    """
+    serper = GoogleSerperAPIWrapper(
+        k=max_results,
+        serper_api_key=api_key,
+    )
+    results = await serper.aresults(query)
+    results = results["organic"]
+    mapping = {
+        "title": "title",
+        "link": "link",
+        "snippet": "body",
+    }
+    results = await map_results(results, mapping)
+    return results
+
+
+class SerperInterfaceWrapper(BaseInterfaceWrapper):
+    def __init__(self):
+        super().__init__(
+            fn=serper_search,
+            inputs=[
+                gr.Textbox(label="Search Query"),
+                gr.Textbox(label="API Key", type="password"),
+                gr.Slider(
+                    minimum=1, maximum=10, step=1, value=5, label="Number of Results"
+                ),
+            ],
+            title="Serper Search",
+            description="Search the web using Serper Search Engine.",
+        )

search_engines/tavily.py

@@ -4,6 +4,8 @@ from langchain_tavily import TavilySearch
 
 from utils.helpers import map_results
 
+from .base import BaseInterfaceWrapper
+
 
 async def tavily_search(query: str, api_key: str, max_results: int = 5) -> pd.DataFrame:
     """
@@ -15,7 +17,9 @@ async def tavily_search(query: str, api_key: str, max_results: int = 5) -> pd.Da
         max_results (int, optional): The number of maximum results to return. Defaults to 5.
 
     Returns:
-        str: The search results from Tavily Search Engine.
+        dict: The search results from Tavily Search Engine. Fields:
+            headers (list): The headers of the columns in the search results. Contains "title", "link", "body".
+            data (list): The data in the search results. Each row contains the title, link, and body of the search result.
     """
     tavily = TavilySearch(
         tavily_api_key=api_key,
@@ -31,21 +35,17 @@ async def tavily_search(query: str, api_key: str, max_results: int = 5) -> pd.Da
     return results
 
 
-tavily_interface = gr.Interface(
-    fn=tavily_search,
-    inputs=[
-        gr.Textbox(label="Search Query"),
-        gr.Textbox(label="API Key", type="password"),
-        gr.Slider(minimum=1, maximum=10, step=1, value=5, label="Number of Results"),
-    ],
-    outputs=gr.Dataframe(
-        label="Search Results",
-        headers=["title", "body", "link"],
-        show_fullscreen_button=True,
-        show_row_numbers=True,
-        show_copy_button=True,
-        wrap=True,
-    ),
-    title="Tavily Search",
-    description="Search the web using Tavily Search Engine.",
-)
+class TavilyInterfaceWrapper(BaseInterfaceWrapper):
+    def __init__(self):
+        super().__init__(
+            fn=tavily_search,
+            inputs=[
+                gr.Textbox(label="Search Query"),
+                gr.Textbox(label="API Key", type="password"),
+                gr.Slider(
+                    minimum=1, maximum=10, step=1, value=5, label="Number of Results"
+                ),
+            ],
+            title="Tavily Search",
+            description="Search the web using Tavily Search Engine.",
+        )