docs and tweaks

Author: Coderbeep

leetcode/configuration.py

@@ -24,14 +24,14 @@ def dump_key(self, key, value):
         with open(self.path, 'w') as yaml_file:
             yaml.dump(self.data, yaml_file, default_flow_style=False)
 
-    def execute(self, args):
+    def _execute(self, args):
         if args.config_key not in self.data['user_data']:
             print(f"Invalid key: {args.config_key}")
             return
         else:
             if getattr(args, 'config_key') and getattr(args, 'config_value'):
                 self.dump_key(args.config_key, args.config_value)
-                print('Configuration updated successfully.')
+                print('[green]Configuration updated successfully.')
 
 def check_session_response(session_id: str) -> bool:
     QUERY = """ query
@@ -76,8 +76,6 @@ def check_session_validity(path = CONFIG_PATH) -> bool:
     The default session_id is taken from the configuration file. """
 
 class Configuration():
-    session_checked =  False
-    
     def __init__(self, session_id: str = ''):
         self.host = 'https://leetcode.com'
         self.user_config = UserConfig()
@@ -92,10 +90,8 @@ def __init__(self, session_id: str = ''):
                                'Referer': self.host}
         self._cookies: dict = {'csrftoken': self._csrf_cookie,
                                'LEETCODE_SESSION': self.session_id}  
-        if not Configuration.session_checked:
-            self.__check_session_validity() 
 
-    def __check_session_validity(self):
+    def check_session_validity(self):
         QUERY = """ query
                 {
                     user {

leetcode/main.py

@@ -1,7 +1,7 @@
 import argparse
 
 # from leetcode.models import *
-from leetcode.configuration import UserConfig, check_session_validity
+from leetcode.configuration import UserConfig
 from leetcode.models.graphql_problemset_question_list import \
     ProblemsetQuestionList
 from leetcode.models.graphql_question_of_today import QuestionOfToday
@@ -17,6 +17,7 @@
 # TODO: problem with import in synced code or code to submit
 # TODO: random problem selector (from not accepted problems)
 # TODO: check the changes in question_content and apply them to the code in other files
+# TODO: use config without having to have a session
 
 def positive_integer(value):
     try:
@@ -87,5 +88,4 @@ def main():
 
 
 if __name__ == '__main__':
-    if check_session_validity():
-        main()
+    main()

leetcode/models/graphql_problemset_question_list.py

@@ -78,7 +78,7 @@ def __init__(self, filters={}, limit=None, skip=0):
 
         self.data = None
 
-    def fetch_data(self, parameters: Dict = None) -> QueryResult:
+    def fetch_data(self, parameters: Dict) -> QueryResult:
         """ Fetches the data from the LeetCode API. 
             Updates the state of the object.
 

leetcode/models/graphql_question_content.py

@@ -19,7 +19,7 @@ def __init__(self, title_slug: str = None):
         if title_slug is not None:
             self.fetch_data(self.title_slug)
 
-    def fetch_data(self, title_slug: str = None) -> Dict:
+    def fetch_data(self, title_slug) -> Dict:
         """ Fetches the content data for the problem.
         
         Args:

leetcode/models/graphql_question_info_table.py

@@ -47,7 +47,15 @@ def __init__(self, title_slug: str = None):
         if title_slug is not None:
             self.fetch_data(self.title_slug)
 
-    def fetch_data(self, title_slug: str = None) -> Dict:
+    def fetch_data(self, title_slug) -> Dict:
+        """ Fetches the question data for the given title slug. 
+        
+        Args:
+            title_slug (str, optional): The title slug of the question to fetch data for. 
+                If provided the data is fetched when the object is created. Defaults to None.
+                
+        Returns:
+            Dict: The question data for the given title slug. {id , title, difficulty, status, categoryTitle}"""
         try:
             with Loader('Fetching question details...', ''):
                 if title_slug is not None and title_slug != self.title_slug:
@@ -69,7 +77,7 @@ def fetch_data(self, title_slug: str = None) -> Dict:
             console.print(f"{e.__class__.__name__}: {e}", style=ALERT)
             sys.exit(1)
 
-    def format_table(self, data: Question):
+    def format_table(self, data: Question) -> LeetTable:
         """ Formats the given question data into a LeetTable object.
 
         Args:
@@ -93,7 +101,7 @@ def format_table(self, data: Question):
 
         return table
 
-    def show(self):
+    def show(self) -> None:
         """ Displays the question data in a LeetTable. 
         
         If the data has not been fetched yet, an exception is raised.
@@ -104,7 +112,7 @@ def show(self):
         else:
             raise Exception("Data is not fetched yet.")
 
-    def __rich_console__(self, console: Console, options):
+    def __rich_console__(self, console: Console, options) -> Table:
         """ Returns a Rich Table object for console output.
 
         Raises:

leetcode/models/graphql_submission_list.py

@@ -35,14 +35,16 @@ class SubmissionList(QueryTemplate):
     def __init__(self):
         super().__init__()
         # Instance specific variables
-        self.question_id: int = None
         self.show_terminal: bool = False
         self.submission_download: bool = False
 
-        self.data = None  
-        self.params = {'offset': 0, 'limit': 20, 'lastKey': None, 'questionSlug': None}
+        self._question_id: int = None
+        self._data = None  
+        self._params = {'offset': 0, 'limit': 20, 'lastKey': None, 'questionSlug': None}
+        self._data_fetched: bool = False
 
-    def fetch_data(self, question_id: int = None) -> Dict:
+    def fetch_data(self, question_id) -> Dict:
+        # TODO: make the parameters usable
         """ Fetches the submission list data for the problem.
 
         Args:
@@ -55,16 +57,20 @@ def fetch_data(self, question_id: int = None) -> Dict:
             with Loader('Fetching submission list...', ''):
                 if question_id is not None and question_id != self.question_id:
                     self.question_id = question_id
-                    self.params['questionSlug'] = ProblemInfo.get_title_slug(self.question_id)
+                
+                if self.data_fetched:
+                    return self.data
 
                 graphql_query = GraphQLQuery(self.query, self.params)
                 response = self.leet_API.post_query(graphql_query)
-                return response['data']
+                self.data = QuestionSubmisstionList.from_dict(response['data'])
+                self.data_fetched = True
+                return self.data
         except Exception as e:
             console.print(f"{e.__class__.__name__}: {e}", style=ALERT)
             sys.exit(1)
 
-    def _execute(self, args):
+    def _execute(self, args) -> None:
         """ Executes the query with the given arguments and displays the result. 
         
         Args:
@@ -88,7 +94,7 @@ def _execute(self, args):
         except Exception as e:
             console.print(f"{e.__class__.__name__}: {e}", style=ALERT)
 
-    def show(self):
+    def show(self) -> None:
         """ Displays the query result in a table. """
 
         table = LeetTable()
@@ -105,7 +111,7 @@ def show(self):
         console.print(table)
 
     @staticmethod
-    def fetch_accepted(submissions):
+    def fetch_accepted(submissions) -> QuestionSubmisstionList.Submission:
         """ Fetches the latest accepted submission from the list of submissions. 
         
         Args:
@@ -115,7 +121,7 @@ def fetch_accepted(submissions):
             Submission: The latest accepted submission. If no accepted submissions are found, None is returned."""
         return next((x for x in submissions if x.statusDisplay == 'Accepted'), None)
 
-    def show_code(self):
+    def show_code(self) -> None:
         """ Displays the code of the latest accepted submission. 
         
         If no accepted submissions are found, an exception is raised. """
@@ -140,7 +146,7 @@ def show_code(self):
         except Exception as e:
             console.print(f"{e.__class__.__name__}: {e}", style=ALERT)
 
-    def download_submission(self):
+    def download_submission(self) -> None:
         """ Downloads the code of the latest accepted submission. 
         
         If no accepted submissions are found, an exception is raised.
@@ -166,7 +172,7 @@ def download_submission(self):
         except Exception as e:
             console.print(f"{e.__class__.__name__}: {e}", style=ALERT)
 
-    def __parse_args(self, args):
+    def __parse_args(self, args) -> None:
         """ Parses the arguments passed to the query. 
         
         Args:
@@ -181,5 +187,46 @@ def __parse_args(self, args):
         if getattr(args, 'download'):
             self.submission_download = True
 
+    @property
+    def data(self):
+        return self._data
+    
+    @data.setter
+    def data(self, data: Dict):
+        self._data = data
+    
+    @property
+    def params(self):
+        return self._params
+    
+    @params.setter
+    def params(self, params: Dict):
+        self._params = params
+        self.data_fetched = False
+        
+    @property
+    def data_fetched(self):
+        return self._data_fetched
+    
+    @data_fetched.setter
+    def data_fetched(self, data_fetched: bool):
+        self._data_fetched = data_fetched    
 
-        
+    @property
+    def question_id(self):
+        return self._question_id
+    
+    @question_id.setter
+    def question_id(self, question_id: int):
+        self._question_id = question_id
+        self.data_fetched = False
+        self.params['questionSlug'] = ProblemInfo.get_title_slug(self.question_id)
+    
+
+if __name__ == '__main__':
+    submissions = SubmissionList()
+    submissions.fetch_data(6536534)
+    submissions.show()
+    
+    submissions.fetch_data(2)
+    submissions.show()