Merge pull request #56 from pranavbaburaj/master

Added a feature #56

Author: GouravSardana

main.py

@@ -5,25 +5,31 @@
 
 version = "0.1"
 
-PARSER = argparse.ArgumentParser()
-PARSER.add_argument("-s",
+parser = argparse.ArgumentParser()
+parser.add_argument("-s",
                     "--search",
                     help="enable debug mode",
                     action="store_true")
 
-PARSER.add_argument("-V",
+parser.add_argument("-V",
                     "--version",
                     version=f"Dynamic-CLI version {version}",
                     action='version')
 
-PARSER.add_argument("-n",
-                    "--new",
-                    help="Opens browser to create new Stack Overflow question.",
-                    const=True,
-                    metavar="title (optional)",
-                    nargs="?")
+parser.add_argument(
+    "-n",
+    "--new",
+    help="Opens browser to create new Stack Overflow question.",
+    const=True,
+    metavar="title (optional)",
+    nargs="?")
+
+parser.add_argument("-file",
+                    "--file",
+                    help="Save answer to a file",
+                    action="store_true")
 
-ARGV = PARSER.parse_args()
+ARGV = parser.parse_args()
 
 search_flag = Search(ARGV)
 

src/arguments/error.py

@@ -0,0 +1,20 @@
+from termcolor import colored
+
+
+class SearchError():
+    def __init__(self, error_statement, suggestion="Try again"):
+        # the error statement
+        self.error_statement = error_statement
+
+        # the suggestion statement
+        self.suggestion = suggestion
+
+        self.evoke_search_error(self.error_statement)
+
+    def evoke_search_error(self, error_statement):
+        print_text = [
+            colored(error_statement, 'red'),
+            colored(self.suggestion, 'green')
+        ]
+        for text_to_print in print_text:
+            print(text_to_print)

src/arguments/markdown.py

@@ -0,0 +1,38 @@
+from rich.markdown import Markdown
+from rich.console import Console
+import html as html
+
+
+class MarkdownRenderer(object):
+    def __init__(self, markdown_text, console_print=True):
+        assert isinstance(markdown_text, str), "Expected a string"
+
+        markdown_text = html.unescape(markdown_text)
+        self.markdown_text = markdown_text
+        self.do_console_print = bool(console_print)
+
+        self.console = Console()  # rich console
+
+        self.render = self.print_mark_down_text()
+
+    def print_mark_down_text(self):
+        rendered_markdown = Markdown(self.markdown_text)
+
+        if self.do_console_print:
+            self.console.print(rendered_markdown)
+
+        return rendered_markdown
+
+    def __repr__(self):
+        return str(self.render)
+
+    def __len__(self):
+        if isinstance(self.render, str):
+            return len(self.render)
+        return -1
+
+    def __str__(self):
+        return str(self.render)
+
+    def __repr__(self):
+        return str(self.render)

src/arguments/save.py

@@ -0,0 +1,33 @@
+import os as os
+import json as json
+import uuid as uuid
+
+
+class SaveSearchResults(object):
+    def __init__(self, result_json):
+        self.result_json = self.__get_as_dict(result_json[0])
+        self.save_results_filename = self.generate_file_name(os.getcwd())
+
+        self.save_data_to_file(self.result_json, self.save_results_filename)
+
+    def save_data_to_file(self, data, filename):
+        with open(os.path.join(os.getcwd(), f"{filename}.json"),
+                  "w") as result_writer:
+            json.dump(data, result_writer, indent=6)
+
+    def __get_as_dict(self, json_array):
+        result_dict = {}
+        for index, element in enumerate(json_array):
+            result_dict[index] = json_array[index]
+        return dict(result_dict)
+
+    def generate_file_name(self, directory):
+        file_list = os.listdir(directory)
+        filename = str(uuid.uuid4()).replace("-", "_")[:4]
+        while filename in file_list:
+            filename = str(uuid.uuid4()).replace("-", "_")[:4]
+
+        return filename
+
+    def __repr__(self):
+        return str(self.save_results_filename)

src/arguments/search.py

@@ -2,9 +2,12 @@
 import argparse
 import webbrowser
 from termcolor import colored
-from .utility import Utility, SearchError
 import sys as sys
 
+from .error import SearchError
+from .utility import Utility
+from .save import SaveSearchResults
+
 
 class Prompt():
     def __init__(self, message):
@@ -24,33 +27,42 @@ def __init__(self, arguments):
 
     def search_args(self):
         if self.arguments.search:
-            queries = ["What do you want to search", "Tags"]
-            query_solutions = []
-
-            # ask quesiton
-            for each_query in queries:
-                # Be careful if there are
-                # KeyBpard Interupts or EOErrors
-                try:
-                    prompt = Prompt(str(each_query)).prompt()
-                except:
-                    sys.exit()
-
-                query_solutions.append(prompt)
-
-            question, tags = query_solutions[0], query_solutions[1]
-            json_output = self.utility_object.make_request(question, tags)
-            questions = self.utility_object.get_que(json_output)
-            if questions == []:
-                # evoke an error
-                search_error = SearchError("No answer found",
-                                           "Please try reddit")
-            else:
-                self.utility_object.get_ans(questions)
-
+            self.search_for_results()
+        elif self.arguments.file:
+            self.search_for_results(True)
         elif self.arguments.new:
             url = "https://stackoverflow.com/questions/ask"
             if type(self.arguments.new) == str:
                 webbrowser.open(f"{url}?title={self.arguments.new}")
             else:
                 webbrowser.open(url)
+
+    def search_for_results(self, save=False):
+        queries = ["What do you want to search", "Tags"]
+        query_solutions = []
+
+        # ask quesiton
+        for each_query in queries:
+            # Be careful if there are
+            # KeyBpard Interupts or EOErrors
+            try:
+                prompt = Prompt(str(each_query)).prompt()
+            except:
+                sys.exit()
+
+            query_solutions.append(prompt)
+
+        question, tags = query_solutions[0], query_solutions[1]
+        json_output = self.utility_object.make_request(question, tags)
+        questions = self.utility_object.get_que(json_output)
+        if questions == []:
+            # evoke an error
+            search_error = SearchError("No answer found", "Please try reddit")
+        else:
+            data = self.utility_object.get_ans(questions)
+
+            if save:
+                filename = SaveSearchResults(data)
+                print(
+                    colored(f"Answers successfully saved into {filename}",
+                            "green"))

src/arguments/utility.py

@@ -1,60 +1,13 @@
-import requests
-import html
 from termcolor import colored
+import requests
 from rich.console import Console
-from rich.markdown import Markdown
 import sys as sys
 
-# the rich console
-console = Console()
-
-# render markdown text in the terminal
-# def print_markdown(markdown):
-#     md = Markdown(markdown)
-#     console.print(md)
-
-
-class MarkdownRenderer(object):
-    def __init__(self, markdown_text, console_print=True):
-        assert isinstance(markdown_text, str), "Expected a string"
-
-        markdown_text = html.unescape(markdown_text)
-        self.markdown_text = markdown_text
-        self.do_console_print = bool(console_print)
-
-        self.console = Console()  # rich console
-
-        self.render = self.print_mark_down_text()
+from .error import SearchError
+from .save import SaveSearchResults
+from .markdown import MarkdownRenderer
 
-    def print_mark_down_text(self):
-        rendered_markdown = Markdown(self.markdown_text)
-
-        if self.do_console_print:
-            self.console.print(rendered_markdown)
-
-        return rendered_markdown
-
-    def __repr__(self):
-        return str(self.render)
-
-
-class SearchError():
-    def __init__(self, error_statement, suggestion="Try again"):
-        # the error statement
-        self.error_statement = error_statement
-
-        # the suggestion statement
-        self.suggestion = suggestion
-
-        self.evoke_search_error(self.error_statement)
-
-    def evoke_search_error(self, error_statement):
-        print_text = [
-            colored(error_statement, 'red'),
-            colored(self.suggestion, 'green')
-        ]
-        for text_to_print in print_text:
-            print(text_to_print)
+console = Console()
 
 
 class Utility():
@@ -92,7 +45,7 @@ def get_que(self, json_data):
         return que_id
 
     def get_ans(self, questions_list):
-        # ans = []
+        ans = []
         for questions in range(1):
             try:
                 resp = requests.get(
@@ -131,3 +84,5 @@ def get_ans(self, questions_list):
                         continue
 
                     console.print(output_text)
+            ans.append(json_ans_data["items"])
+        return ans