Improve error handling when contacting quiz API

Author: davidindub

create_gform.py

@@ -133,7 +133,7 @@ def create_google_form(game_obj):
 
     while ask_form_owner:
         email = input("\nPlease enter the e-mail address of your Google "
-                      "Account or enter Q to quit:\n")
+                      "Account or enter Q to quit:\n\n")
         email = email.lower()
 
         # Quit to main menu if user types Q or quit

create_gform_items.py

@@ -120,10 +120,6 @@ def create_gform_round(round_obj):
     for question in questions:
         form_items.insert(0, create_gform_question(question))
 
-        f = open("test.txt", "a")
-        f.write(question.get_question() + "\n")
-        f.close()
-
     form_items.append(create_gform_page_break(round_num, category))
 
     return form_items

create_quiz.py

@@ -1,16 +1,19 @@
 from helpers import ask_any_key, ask_yes_no, clear, is_quit
 import requests
 import json
-import random
 import urllib.parse
 from termcolor import cprint
 from time import sleep
 
-CATEGORIES_DATA = json.loads(requests.get(
-    "https://opentdb.com/api_category.php").text)["trivia_categories"]
 
-SESSION_TOKEN = json.loads(requests.get(
-    "https://opentdb.com/api_token.php?command=request").text)["token"]
+def get_category_data():
+    """
+    Makes a call the the Quiz API and returns the list of available categories
+    """
+    result = json.loads(requests.get(
+        "https://opentdb.com/api_category.php").text)["trivia_categories"]
+
+    return result
 
 
 def create_categories_dict(categories_data):
@@ -30,7 +33,26 @@ def create_categories_dict(categories_data):
     return cats_dict
 
 
-QUIZ_CATEGORIES = create_categories_dict(CATEGORIES_DATA)
+def get_session_token():
+    """
+    Makes a call to the Quiz API for a Session token which keeps track of the
+    questions so the user doesn't receive the same question twice.
+    """
+    result = json.loads(requests.get(
+        "https://opentdb.com/api_token.php?command=request").text)["token"]
+
+    return result
+
+# Quiz API Setup
+try:
+    CATEGORIES_DATA = get_category_data()
+    QUIZ_CATEGORIES = create_categories_dict(CATEGORIES_DATA)
+    SESSION_TOKEN = get_session_token()
+except Exception:
+    cprint("🚫 The Quiz API could not be reached!\n", "red")
+    print("See https://opentdb.com/ \n")
+    print("Please try again later.")
+    quit()
 
 
 def get_quiz_questions(num_qs, cat, diff):
@@ -40,9 +62,11 @@ def get_quiz_questions(num_qs, cat, diff):
     question, correct_answer and incorrect_answers
     """
 
-    return json.loads(requests.get(
+    result = json.loads(requests.get(
         f"https://opentdb.com/api.php?amount={num_qs}&category={cat}&difficulty={diff}&type=multiple&token={SESSION_TOKEN}&encode=url3986").text)["results"]  # noqa
 
+    return result
+
 
 class Game:
     """

gdrive_utility.py

@@ -14,6 +14,9 @@
 
 DRIVE_SERVICE = discovery.build("drive", "v3", credentials=SCOPED_CREDENTIALS)
 
+# Functions adapted from code in the Google Drive API Docs Quickstart Guide:
+# https://developers.google.com/drive/api/quickstart/python
+
 
 def delete_file(file_id):
     """Permanently delete a Google Drive file, skipping the trash.
@@ -89,7 +92,7 @@ def insert_permission(service, file_id, value, role):
         return service.permissions().create(
             fileId=file_id, body=new_permission).execute()
     except errors.HttpError as error:
-        print(f"An error occurred: {error}")
+        print(f"🚫 An error occurred: {error}")
         return
 
 
@@ -137,4 +140,4 @@ def run():
                 delete_all_files()
                 continue
             else:
-                continue
+                continue

helpers.py

@@ -1,6 +1,7 @@
 from os import system, name
 from time import sleep
 from datetime import datetime
+from termcolor import cprint
 
 now = datetime.now()
 current_hour = int(now.strftime("%H"))
@@ -17,7 +18,8 @@ def ask_yes_no(question):
     yes = ["yes", "y"]
     no = ["no", "n"]
 
-    print(f"\n{question} \n\ny/n\n")
+    print(f"\n{question}")
+    print(f"\n[Y/n]\n")
     while True:
         choice = input().lower()
         if choice in yes:
@@ -37,7 +39,7 @@ def is_quit(response):
     otherwise returns False.
     """
     if response.lower() in ["q", "quit"]:
-        if ask_yes_no("Would you like to return to the Main Menu?"):
+        if ask_yes_no("Would you like to return to the Main Menu?\n"):
             return True
         else:
             return False
@@ -49,7 +51,8 @@ def ask_any_key():
     """
     Ask the user to press any key to return to main menu
     """
-    input("Press any key to return to Main Menu.")
+    cprint("Press any key to return to Main Menu.", "white", "on_blue")
+    input()
     return
 
 

run.py

@@ -11,6 +11,7 @@
 if os.path.exists("env.py"):
     import env  # noqa
 
+# Password for Secret Google Drive Utility
 SECRET = os.environ.get("ADMIN")
 
 
@@ -69,7 +70,7 @@ def main():
     submit their answers!
 
     Enter "Quit" or "Q" at any time to return to the Main Menu.
-    
+
     See this project on GitHub at https://github.com/davidindub/quiz-master
     Quiz Master 2022 © David Kelly.
     """]
@@ -85,7 +86,7 @@ def main():
         clear()
 
         # Main Menu:
-        print("Main Menu")
+        cprint("Main Menu", "white", "on_blue")
         print("_________\n")
 
         try:
@@ -126,14 +127,19 @@ def main():
 
             google_quiz = setup_new_quiz()
 
-            create_google_form(google_quiz)
+            try:
+                create_google_form(google_quiz)
+            except Exception:
+                cprint("There was an error with the Google Form API\n\n", "red")
+                print("Please try again later.")
 
             continue
         if response == 4:
             clear()
             tprint("HELP", font="o8")
             print(help_text[0])
-            input("Press any key to read more.\n")
+            cprint("Press any key to read more.", "white", "on_blue")
+            input()
             clear()
             print(help_text[1])
             ask_any_key()