3.2.0: More typing hint support

Author: alissonlauffer

README.md

@@ -35,13 +35,13 @@ client = Client()
 results = client.search("Python Wikipedia")
 
 # Prints first result title
-print(results[0]["title"])
+print(results[0].title)
 
 # Prints first result URL
-print(results[0]["url"])
+print(results[0].url)
 
 # Prints first result description
-print(results[0]["description"])
+print(results[0].description)
 ```
 
 ### We also provide an asynchronous version inside the `AsyncClient` class
@@ -56,13 +56,13 @@ async def get_results():
   results = await client.search("Python Wikipedia")
 
   # Prints first result title
-  print(results[0]["title"])
+  print(results[0].title)
 
   # Prints first result URL
-  print(results[0]["url"])
+  print(results[0].url)
 
   # Prints first result description
-  print(results[0]["description"])
+  print(results[0].description)
 
 
 loop = asyncio.get_event_loop()

duckpy/__init__.py

@@ -1,6 +1,8 @@
 import asyncio
 import random
 import httpx
+from .types import ResultDict
+from typing import List
 from warnings import warn
 from typing import Union
 from bs4 import BeautifulSoup
@@ -19,7 +21,7 @@ def __init__(self, proxies: Union[list, str] = None, default_user_agents: Union[
 
 
 class Client(BaseClient):
-    def search(self, query: str, exact_match: bool = False, **kwargs):
+    def search(self, query: str, exact_match: bool = False, **kwargs) -> List[ResultDict]:
         if exact_match:
             query = '"%s"' % query
 
@@ -49,7 +51,7 @@ def __init__(self, proxies: Union[list, str] = None, default_user_agents: Union[
         self.loop = asyncio.get_event_loop()
         super().__init__(proxies=proxies, default_user_agents=default_user_agents, random_ua=random_ua)
 
-    async def search(self, query: str, exact_match: bool = False, **kwargs):
+    async def search(self, query: str, exact_match: bool = False, **kwargs) -> List[ResultDict]:
         if exact_match:
             query = '"%s"' % query
 
@@ -74,7 +76,7 @@ async def search(self, query: str, exact_match: bool = False, **kwargs):
             return await self.loop.run_in_executor(None, parse_page, data)
 
 
-def parse_page(html: Union[str, bytes]):
+def parse_page(html: Union[str, bytes]) -> List[ResultDict]:
     soup = BeautifulSoup(html, "html.parser")
     results = []
     for i in soup.find_all('div', {'class': 'links_main'}):
@@ -84,7 +86,7 @@ def parse_page(html: Union[str, bytes]):
             title = i.h2.a.text
             description = i.find('a', {'class': 'result__snippet'}).text
             url = i.find('a', {'class': 'result__url'}).get('href')
-            results.append(dict(title=title, description=description, url=url))
+            results.append(ResultDict(title=title, description=description, url=url))
         except AttributeError:
             pass
     return results

duckpy/types.py

@@ -0,0 +1,6 @@
+class ResultDict(dict):
+    def __init__(self, title: str, description: str, url: str):
+        self.title = title
+        self.description = description
+        self.url = url
+        super().__init__(title=title, description=description, url=url)

setup.py

@@ -5,7 +5,7 @@
 
 setup(
     name='duckpy',
-    version='3.1.0',
+    version='3.2.0-dev',
 
     packages=['duckpy', 'duckpy.aio'],
     install_requires=['beautifulsoup4>=4.9.1', 'httpx[http2]==0.14.*'],