Update app.py

app.py

@@ -1,16 +1,15 @@
 #!/usr/bin/env python
 # coding: utf-8
+
+# Imports
 import json
 import os
-import re
 import time
-from random import random
-import socket
-
-from threading import Thread
-from time import sleep
+import gradio as gr
+import tweepy
 
-test_html = '''
+# The HTML body used for the WatchTower page
+html_body = '''
 <!-- Header -->
 <header class="w3-display-container w3-content w3-wide" style="max-width:1500px;" id="home">
   <img class="w3-image" src="https://cdn.pixabay.com/photo/2018/12/10/16/22/city-3867295_960_720.png" alt="Architecture" width="1500" height="800">
@@ -68,7 +67,7 @@ test_html = '''
     <p id="caption" class="w3-opacity w3-large"></p>
   </div>
 </div>
- 
+
 <script>
 // Modal Image Gallery
 function onClick(element) {
@@ -101,24 +100,26 @@ function toggleFunction() {
 </html>
 '''
 
-import gradio as gr
-import tweepy
-from fastapi import FastAPI, Request
-
+# Twitter keys
 consumer_token = os.getenv('CONSUMER_TOKEN')
 consumer_secret = os.getenv('CONSUMER_SECRET')
 my_access_token = os.getenv('ACCESS_TOKEN')
 my_access_secret = os.getenv('ACCESS_SECRET')
 bearer = os.getenv('BEARER')
 
-global_oauth1_user_handler = None
-
+# Setup the gradio block and add some generic CSS
 block = gr.Blocks(css=".container { max-width: 800px; margin: auto; }", title="WatchTower")
 
+# Chat history variable used for the chatbot prompt on the 'getting started' page.
 chat_history = []
 
-
 def get_client_from_tokens(oauth_verifier, oauth_token):
+    '''
+    This function is used for generating a Tweepy client object based on Oauth verifier and token paramiters
+    :param oauth_verifier:
+    :param oauth_token:
+    :return: A Tweepy client object
+    '''
     new_oauth1_user_handler = tweepy.OAuth1UserHandler(
         consumer_token, consumer_secret,
         callback="https://hf.space/embed/User1342/WatchTower/"
@@ -140,12 +141,22 @@ def get_client_from_tokens(oauth_verifier, oauth_token):
         access_token_secret=access_token_secret
     )
 
+    # TODO: The below is not necessary and can be removed.
     global client
     client = their_client
 
     return their_client
 
+
 def block_users(client, threshold, dataset):
+    '''
+    Used for blocking a series of users based on the threshold and datasets provided. Here the users folder is used.
+    TODO: Datasets not implemented.
+    :param client:
+    :param threshold:
+    :param dataset:
+    :return: The number of blocked users.
+    '''
     num_users_blocked = 0
 
     for filename in os.listdir("users"):
@@ -176,11 +187,15 @@ def block_users(client, threshold, dataset):
     return num_users_blocked
 
 
+def chat(selected_option=None, radio_score=None, url_params=None):
+    '''
+    This function is used to initialise blocking users once the user has authenticated with Twitter.
+    :param selected_option:
+    :param radio_score:
+    :param url_params:
+    :return: the chatbot history is returned (including information on blocked accounts).
+    '''
 
-username_populated = False
-
-
-def chat(selected_option=None,radio_score=None, url_params = None):
     global client
     global chat_history
     history = []
@@ -207,7 +222,6 @@ def chat(selected_option=None,radio_score=None, url_params = None):
     return history
 
 
-
 def infer(prompt):
     pass
 
@@ -216,12 +230,20 @@ have_initialised = False
 client = None
 name = None
 
-def predict(slider_value, url_params):
-    print(url_params)
-    return [None,chat(radio.value, slider_value, url_params)]
 
+def button_pressed(slider_value, url_params):
+    #print(url_params)
+    return [None, chat(radio.value, slider_value, url_params)]
+
+# The website that the user will visit to authenticate WatchTower.
 target_website = None
-def changed_tab():
+
+def update_target_website():
+    '''
+    Updates the URL used to authenticate WatchTower with Twitter.
+    #TODO this function is full of old code and can be optimised.
+    :return:
+    '''
     global have_initialised
     global chatbot
     global chat_history
@@ -233,18 +255,20 @@ def changed_tab():
     chat_history = [
         ["Welcome to Watchtower.".format(name), "Log in via Twitter and configure your blocking options above."]]
 
-
     chatbot.value = chat_history
     chatbot.update(value=chat_history)
 
     twitter_auth_button.value = '<a href={}><img src="https://cdn.cms-twdigitalassets.com/content/dam/developer-twitter/auth-docs/sign-in-with-twitter-gray.png.twimg.1920.png" alt="Log In With Twitter"></a><br>'.format(
-                                get_target_website())
-    twitter_auth_button.update(value= '<a href={}><img src="https://cdn.cms-twdigitalassets.com/content/dam/developer-twitter/auth-docs/sign-in-with-twitter-gray.png.twimg.1920.png" alt="Log In With Twitter"></a><br>'.format(
-                                get_target_website()))
-    
+        get_target_website())
+    twitter_auth_button.update(
+        value='<a href={}><img src="https://cdn.cms-twdigitalassets.com/content/dam/developer-twitter/auth-docs/sign-in-with-twitter-gray.png.twimg.1920.png" alt="Log In With Twitter"></a><br>'.format(
+            get_target_website()))
+
     return '<a href={}><img src="https://cdn.cms-twdigitalassets.com/content/dam/developer-twitter/auth-docs/sign-in-with-twitter-gray.png.twimg.1920.png" alt="Log In With Twitter"></a><br>'.format(
-                                get_target_website())
+        get_target_website())
 
+# The below is a JS blob used to retrieve the URL params. 
+# Thanks to here: https://discuss.huggingface.co/t/hugging-face-and-gradio-url-paramiters/21110/2
 get_window_url_params = """
     function(text_input, url_params) {
         console.log(text_input, url_params);
@@ -255,6 +279,10 @@ get_window_url_params = """
     """
 
 def get_target_website():
+    '''
+    A wrapper function used for retrieving the URL a user will use to authenticate WatchTower with Twitter.
+    :return: 
+    '''
     oauth1_user_handler = tweepy.OAuth1UserHandler(
         consumer_token, consumer_secret,
         callback="https://hf.space/embed/User1342/WatchTower/"
@@ -263,14 +291,14 @@ def get_target_website():
 
     return target_website
 
-
+# The Gradio HTML component used for the 'sign in with Twitter' button
 twitter_auth_button = gr.HTML(
-                            value='<a href={}><img src="https://cdn.cms-twdigitalassets.com/content/dam/developer-twitter/auth-docs/sign-in-with-twitter-gray.png.twimg.1920.png" alt="Log In With Twitter"></a><br>'.format(
-                                get_target_website()))
+    value='<a href={}><img src="https://cdn.cms-twdigitalassets.com/content/dam/developer-twitter/auth-docs/sign-in-with-twitter-gray.png.twimg.1920.png" alt="Log In With Twitter"></a><br>'.format(
+        get_target_website()))
 
+# The main chunk of code that uses Gradio blocks to create the UI
 with block:
     gr.HTML('''
-
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <link rel="stylesheet" href="https://www.w3schools.com/w3css/4/w3.css">
     <!-- Navbar (sit on top) -->
@@ -291,7 +319,7 @@ with block:
     with tabs:
         intro_tab = gr.TabItem("Introduction")
         with intro_tab:
-            gr.HTML(test_html)
+            gr.HTML(html_body)
 
         prediction_tab = gr.TabItem("Getting Started")
         with prediction_tab:
@@ -314,13 +342,13 @@ with block:
                         radio = gr.CheckboxGroup(value="Violent", choices=["Violent", "Hate Speech", "Misinformation"],
                                                  interactive=False, label="Behaviour To Block")
 
-                        slider = gr.Slider(value=20,interactive=True, label="Threshold Certainty Tolerance")
+                        slider = gr.Slider(value=20, interactive=True, label="Threshold Certainty Tolerance")
 
                     chatbot = gr.Chatbot(value=chat_history, label="Watchtower Output").style()
                     btn = gr.Button("Run WatchTower").style(full_width=True)
-        btn.click(fn=predict, inputs=[slider, url_params],
+        btn.click(fn=button_pressed, inputs=[slider, url_params],
                   outputs=[text_output, chatbot], _js=get_window_url_params)
-        tabs.change(fn=changed_tab, inputs=None, outputs=None)
+        tabs.change(fn=update_target_website, inputs=None, outputs=None)
     gr.Markdown(
         """___
    <p style='text-align: center'>
@@ -332,7 +360,7 @@ with block:
 
 block.__enter__()
 block.set_event_trigger(
-                event_name="load", fn=changed_tab, inputs=None, outputs=[html_button], no_target=True
-            )
+    event_name="load", fn=update_target_website, inputs=None, outputs=[html_button], no_target=True
+)
 
 block.launch(enable_queue=False)