Merge pull request #89 from NamamiShanker/namami

GouravSardana · web-flow · commit 41f7ea3ef5cf · 2021-04-23T23:55:16.000+05:30
Create navigation enabled question panel #81
diff --git a/requirements.txt b/requirements.txt
@@ -11,4 +11,5 @@ colorama==0.4.4
 configparser==5.0.2
 crayons==0.4.0
 selenium==3.141.0
-webdriver-manager==3.3.0
+webdriver-manager==3.3.0
+simple-term-menu==1.0.1
diff --git a/src/arguments/markdown.py b/src/arguments/markdown.py
@@ -33,6 +33,3 @@ def __len__(self):
 
     def __str__(self):
         return str(self.render)
-
-    def __repr__(self):
-        return str(self.render)
diff --git a/src/arguments/search.py b/src/arguments/search.py
@@ -54,7 +54,7 @@ def search_for_results(self, save=False):
         queries = ["What do you want to search", "Tags"]
         query_solutions = []
 
-        # ask quesiton
+        # ask question
         for each_query in queries:
             # Be careful if there are
             # KeyBoard Interrupts or EOErrors
diff --git a/src/arguments/utility.py b/src/arguments/utility.py
@@ -1,10 +1,15 @@
 from termcolor import colored
 import requests
 from rich.console import Console
+from rich.markdown import Markdown
 import sys as sys
+
+# Required for Questions Panel
 import os
 import time
 from collections import defaultdict
+from simple_term_menu import TerminalMenu
+import webbrowser
 
 from .error import SearchError
 from .save import SaveSearchResults
@@ -28,6 +33,95 @@
 
 console = Console()
 
+class QuestionsPanelStackoverflow():
+    def __init__(self):
+        self.questions_data = []                        # list(  list( question_title, question_id, question_link )...  )
+        self.answer_data = defaultdict(lambda: False)   # dict( question_id:list( body, link )) corresponding to self.questions_data
+        self.line_color = "bold red"
+        self.heading_color = "bold blue"
+        self.utility = Utility()
+
+    def populate_question_data(self, questions_list):
+        """
+        Function to populate question data property
+        Creates batch request to stackexchange API and to get question details of
+        questions with id in the list. Stores the returned data data in the following format:
+            list(  list( question_title, question_link, question_id )  )
+        """
+        with console.status("Getting the questions..."):
+            try:
+                resp = requests.get(
+                    self.utility.get_batch_ques_url(questions_list)
+                )
+            except:
+                SearchError("Search Failed", "Try connecting to the internet")
+                sys.exit()
+        json_ques_data = resp.json()
+        self.questions_data = [[item['title'].replace('|',''), item['question_id'], item['link']] for item in json_ques_data["items"]]
+
+    def populate_answer_data(self, questions_list):
+        """
+        Function to populate answer data property
+        Creates batch request to stackexchange API to get ans of questions with
+        question id in the list. Stores the returned data data in the following format:
+            dict( question_id:list( body, link ) )
+        """
+        with console.status("Searching answers..."):
+            try:
+                resp = requests.get(
+                    self.utility.get_batch_ans_url(questions_list)
+                )
+            except:
+                SearchError("Search Failed", "Try connecting to the internet")
+                sys.exit()
+            json_ans_data = resp.json()
+            for item in json_ans_data["items"]:
+                if not(self.answer_data[item['question_id']]):
+                    self.answer_data[item['question_id']] = item['body_markdown']
+        # Sometimes the StackExchange API fails to deliver some answers. The below code is to fetch them
+        failed_ques_id = [question[1] for question in self.questions_data if not(self.answer_data[question[1]])]
+        if not(len(failed_ques_id) == 0):
+            self.populate_answer_data(failed_ques_id)
+
+    def return_formatted_ans(self, ques_id):
+        # This function uses pygments lexers ad formatters to format the content in the preview screen
+        body_markdown = self.answer_data[int(ques_id)]
+        body_markdown = str(body_markdown)
+        xml_markup_replacement = [("&amp;", "&"), ("&lt;", "<"), ("&gt;", ">"), ("&quot;", "\""), ("&apos;", "\'"), ("&#39;", "\'")]
+        for convert_from, convert_to in xml_markup_replacement:
+            body_markdown = body_markdown.replace(convert_from, convert_to)
+        width = os.get_terminal_size().columns
+        console = Console(width=width-4)
+        markdown = Markdown(body_markdown, hyperlinks=False)
+        with console.capture() as capture:
+            console.print(markdown)
+        highlighted = capture.get()
+        box_replacement = [("─", "-"), ("═","="), ("║","|"), ("│", "|"), ('┌', '+'), ("└", "+"), ("┐", "+"), ("┘", "+"), ("╔", "+"), ("╚", "+"), ("╗","+"), ("╝", "+"), ("•","*")]
+        for convert_from, convert_to in box_replacement:
+            highlighted = highlighted.replace(convert_from, convert_to)
+        return highlighted
+
+    def navigate_questions_panel(self):
+        # Code for navigating through the question panel
+        console.rule('[bold blue] Relevant Questions', style="bold red")
+        console.print("[yellow] Use arrow keys to navigate. 'q' or 'Esc' to quit. 'Enter' to open in a browser")
+        console.print()
+        options = ["|".join(map(str, question)) for question in self.questions_data]
+        question_menu = TerminalMenu(options, preview_command=self.return_formatted_ans, preview_size=0.75, )
+        quitting = False
+        while not(quitting):
+            options_index = question_menu.show()
+            try:
+                question_link = self.questions_data[options_index][2]
+            except Exception:
+                return
+            else:
+                webbrowser.open(question_link)
+
+    def display_panel(self, questions_list):
+        self.populate_question_data(questions_list)
+        self.populate_answer_data(questions_list)
+        self.navigate_questions_panel()
 
 class Utility():
     def __init__(self):
@@ -42,6 +136,22 @@ def __get_search_url(self, question, tags):
         """
         return f"{self.search_content_url}/2.2/search/advanced?order=desc&sort=relevance&tagged={tags}&title={question}&site=stackoverflow"
 
+    def get_batch_ques_url(self, ques_id_list):
+        """
+        Returns URL which contains ques_ids which can be use to get
+        get the details of all the corresponding questions
+        """
+        batch_ques_id = ""
+        for question_id in ques_id_list:
+            batch_ques_id += str(question_id) + ";"
+        return f"{self.search_content_url}/2.2/questions/{batch_ques_id[:-1]}?order=desc&sort=votes&site=stackoverflow&filter=!--1nZwsgqvRX"
+
+    def get_batch_ans_url(self, ques_id_list):
+        batch_ques_id = ""
+        for question_id in ques_id_list:
+            batch_ques_id += str(question_id) + ";"
+        return f"{self.search_content_url}/2.2/questions/{batch_ques_id[:-1]}/answers?order=desc&sort=votes&site=stackoverflow&filter=!--1nZwsgqvRX"
+
     def make_request(self, que, tag: str):
         """
         This function uses the requests library to make the rest api call to the stackexchange server.
@@ -52,12 +162,12 @@ def make_request(self, que, tag: str):
         :return: Json response from the api call.
         :rtype: Json format data
         """
-        print("\U0001F50E Searching for the answer")
-        try:
-            resp = requests.get(self.__get_search_url(que, tag))
-        except:
-            SearchError("\U0001F613 Search Failed", "\U0001F4BB Try connecting to the internet")
-            sys.exit()
+        with console.status("Searching..."):
+            try:
+                resp = requests.get(self.__get_search_url(que, tag))
+            except:
+                SearchError("\U0001F613 Search Failed", "\U0001F4BB Try connecting to the internet")
+                sys.exit()
         return resp.json()
 
     def get_que(self, json_data):
@@ -74,105 +184,12 @@ def get_que(self, json_data):
 
     def get_ans(self, questions_list):
         """
-        This function prints the answer to the queries
-        (question and tags) provided by the user. It does so
-        in the following manner :
-        1) Gets the details of all the relevant question and stores their title, link and id in "question_data" list.
-        2) I have introduced the concept of active question, i.e. , the question whose answer is currently being displayed.
-        3) The index of the active question in "question_data" array is stored in "question_posx"
-        2) By Default, shows the answer to the first question. Creates an breakable infinite loop asking the user answer to which question he wants to see.
-        4) The value of "question_posx" changes according to user input, displaying answer to different questions in "questions_data" list.
-        3) The answers to the questions requested by the user are stored in cache for faster access time during subsequent calls.
-        """
-        # Create batch request to get details of all the questions
-        batch_ques_id = ""
-        for question_id in questions_list:
-            batch_ques_id += str(question_id) + ";"
-        try:
-            resp = requests.get(
-                f"{self.search_content_url}/2.2/questions/{batch_ques_id[:-1]}?order=desc&sort=votes&site=stackoverflow&filter=!--1nZwsgqvRX"
-            )
-        except:
-            SearchError("Search Failed", "Try connecting to the internet")
-            sys.exit()
-        json_ques_data = resp.json()
-        """
-        Store the received questions data into the following data format:
-        list(  list( question_title, question_link, question_id )  )
+        This Function creates QuestionsPanel_stackoverflow class which supports
+        Rendering, navigation, searching and redirecting capabilities
         """
-        questions_data = [[item['title'], item['link'], item['question_id']] for item in json_ques_data["items"] ]
-        # Clear terminal
-        os.system('cls' if os.name == 'nt' else 'clear')
-
-        # cache array to store the requested answers. Format of storage { question_id:[answer_body, answer_link] }
-        downloaded_questions_cache = defaultdict(lambda: False)
-
-        # Stores the currently showing question index in questions_data
-        question_posx = 0
-
-        while True:
-            os.system('cls' if os.name == 'nt' else 'clear')
-            # Printing all the questions. The active question is printed GREEN.
-            console.rule('[bold blue] Relevant Questions', style="bold red")
-            for idx, question_data in enumerate(questions_data):
-                if question_posx == idx:
-                    console.print("[green]{}. {}  |  {}".format(idx+1, question_data[0], question_data[1]))
-                else:
-                    console.print("{}. {}  |  {}".format(idx+1, question_data[0], question_data[1]))
-            console.rule("[bold blue] Answer of question {}".format(question_posx+1), style="bold red")
-
-            # Gets the question_id of active question
-            current_question_id = questions_data[question_posx][2]
-
-            # Searches for the id in cache. If present then prints it
-            if(downloaded_questions_cache[current_question_id]):
-                output_content = downloaded_questions_cache[current_question_id]
-                for output_index, output_text in enumerate(output_content):
-                    """
-                    Loop through the output_text and print the element
-                    if it is the last one, the text[0] is printed
-                    along with text[-1]
-
-                    if text is markdown , render the markdown
-                    """
-                    if output_index == len(output_content) - 1:
-                        console.print("Link to the answer: " + output_text)
-                        break
-
-                    if output_index == len(output_content) - 2:
-                        MarkdownRenderer(output_text)
-                        continue
-
-                    console.print(output_text)
-            # If the cache has no entry for the said question id, then downloads the answer
-            # and makes an for it entry in the cache array in the said format and restarts the loop.
-            else:
-                try:
-                    resp = requests.get(
-                        f"{self.search_content_url}/2.2/questions/{current_question_id}/answers?order=desc&sort=votes&site=stackoverflow&filter=!--1nZwsgqvRX"
-                    )
-                except:
-                    SearchError("Search Failed", "Try connecting to the internet")
-                    sys.exit()
-                json_ans_data = resp.json()
-                print(json_ans_data["items"])
-                most_upvoted = json_ans_data["items"][0]
-                downloaded_questions_cache[current_question_id] = [most_upvoted["body_markdown"], most_upvoted['link']]
-                del most_upvoted
-                continue
-
-            console.rule("[bold blue]", style="bold red", align="right")
-            # Asks the user for next question number. Makes it the active question and the loop restarts
-            while True:
-                posx = int(input("Enter the question number you want to view (Press 0 to quit): ")) - 1
-                if (posx == -1):
-                    return
-                elif (0<=posx<len(questions_data)):
-                    question_posx = posx
-                    break
-                else:
-                    console.print("Please enter a valid question number")
-                    continue
+        stackoverflow_panel = QuestionsPanelStackoverflow()
+        stackoverflow_panel.display_panel(questions_list)
+        # Support for reddit searching can also be implemented from here
 
     # Get an access token and extract to a JSON file "access_token.json"
     @classmethod
