typing for when gazpacho 1.x.x is released

Author: maxhumber

.gitignore

@@ -1,5 +1,7 @@
 # custom
 sandbox.py
+*.sqlite3
+out
 
 # Byte-compiled / optimized / DLL files
 __pycache__/

quote/cli.py

@@ -2,20 +2,20 @@
 import itertools
 import random
 import threading
+from textwrap import shorten, wrap
 import time
 
 from .quote import quote
 from .spinner import Spinner
 
-from textwrap import shorten, wrap
-
 
-def random_search(search):
-    """Return one random quote result from a search
+def random_search(search: str) -> str:
+    """\
+    Return one random quote result from a search
 
     Params:
 
-    - search (str): Search term
+    - search: term
     """
     results = quote(search)
     random_quote = random.choice(results)["quote"]
@@ -25,14 +25,17 @@ def random_search(search):
     return wrapped_quote
 
 
-def colour(string):
-    """Paint it green!"""
+def colour(string: str) -> str:
+    """\
+    Paint it green!
+    """
     string = f"\033[32m{string}\033[0m"
     return string
 
 
-def cli():
-    """Retrieve a random quote from Goodreads
+def cli() -> str:
+    """\
+    Retrieve a random quote from Goodreads
 
     Examples:
 

quote/py.typed

@@ -1,41 +1,47 @@
 import re
-from gazpacho import get, Soup
+from typing import Dict, List
+
+from gazpacho import Soup
+
 
 URL = "https://www.goodreads.com/quotes/search"
 
 
-def _make_soup(query, page=1):
+def _make_soup(query: str, page: int = 1) -> Soup:
     params = {"q": query, "commit": "Search", "page": page}
-    html = get(URL, params)
-    soup = Soup(html)
+    soup = Soup.get(URL, params)
     return soup
 
 
-def _parse_quote(quote_text):
-    try:
-        book = quote_text.find("a", {"class": "authorOrTitle"}).text
-    except AttributeError:
-        book = None
-    author = quote_text.find("span", {"class": "authorOrTitle"}).text.replace(",", "")
-    quote = re.search("(?<=“)(.*?)(?=”)", quote_text.strip()).group(0)
-    return {"author": author, "book": book, "quote": quote}
+def _parse_quote(quote_text: Soup) -> Dict[str, str]:
+    b = quote_text.find("a", {"class": "authorOrTitle"}, mode="first")
+    a = quote_text.find("span", {"class": "authorOrTitle"}, mode="first")
+    q = re.search("(?<=“)(.*?)(?=”)", quote_text.strip())
+    return {
+        "author": "" if not isinstance(a, Soup) else a.text.replace(",", ""),
+        "book": "" if not isinstance(b, Soup) else b.text,
+        "quote": "" if not q else q.group(0),
+    }
 
 
-def _get_page_quotes(soup):
+def _get_page_quotes(soup: Soup) -> List[Dict[str, str]]:
     quotes = []
-    for quote_text in soup.find("div", {"class": "quoteText"}):
+    quote_texts = soup.find("div", {"class": "quoteText"}, mode="all")
+    assert isinstance(quote_texts, list)
+    for quote_text in quote_texts:
         quote = _parse_quote(quote_text)
         quotes.append(quote)
     return quotes
 
 
-def quote(search, limit=20):
-    """Retrieve quotes from Goodreads based on a search term
+def quote(search: str, limit: int = 20) -> List[Dict[str, str]]:
+    """\
+    Retrieve quotes from Goodreads
 
     Params:
 
-    - search (str): Author or book to search for
-    - limit (int, default=20): Number of quotes to return
+    - search: Author and/or book
+    - limit: Number of quotes to return
 
     Example:
 
@@ -52,7 +58,7 @@ def quote(search, limit=20):
     ```
     """
     page = 1
-    quotes = []
+    quotes: List[Dict[str, str]] = []
     while True:
         if len(quotes) > limit:
             break

quote/quote.py

@@ -2,25 +2,26 @@
 import sys
 from threading import Event, Thread
 from time import sleep
+from typing import Any
 
 
 class Spinner:
-    phases = cycle(["⣾", "⣷", "⣯", "⣟", "⡿", "⢿", "⣻", "⣽"])
+    phases: Any = cycle(["⣾", "⣷", "⣯", "⣟", "⡿", "⢿", "⣻", "⣽"])
 
-    def __init__(self):
-        self.stop_running = Event()
-        self.spin_thread = Thread(target=self.init_spin)
+    def __init__(self) -> None:
+        self.stop_running: Any = Event()
+        self.spin_thread: Any = Thread(target=self.init_spin)
 
-    def start(self):
+    def start(self) -> None:
         sys.stdout.write("\033[32m")
         self.spin_thread.start()
 
-    def stop(self):
+    def stop(self) -> None:
         self.stop_running.set()
         self.spin_thread.join()
         sys.stdout.write("\033[0m")
 
-    def init_spin(self):
+    def init_spin(self) -> None:
         while not self.stop_running.is_set():
             sys.stdout.write(next(self.phases))
             sys.stdout.flush()

quote/spinner.py

@@ -5,14 +5,15 @@
 
 setup(
     name="quote",
-    version="2.0.2",
+    version="2.0.3",
     author="Max Humber",
     author_email="max.humber@gmail.com",
-    description="quote is a wrapper for the Goodreads Quote API",
+    description="A wrapper for the Goodreads Quote API",
     long_description=long_description,
     long_description_content_type="text/markdown",
     url="https://github.com/maxhumber/quote",
     packages=find_packages(),
+    package_data={"quote": ["py.typed"]},
     install_requires=["gazpacho>=1.0"],
     classifiers=[
         "Development Status :: 5 - Production/Stable",
@@ -24,4 +25,5 @@
     entry_points={"console_scripts": ["quote=quote.cli:cli"]},
     python_requires=">=3.7",
     setup_requires=["setuptools>=38.6.0"],
+    zip_safe=False,
 )