Refactor variable names to increase readability

Author: NeverMendel

README.md

@@ -72,11 +72,11 @@ docker run -it -v $(pwd):/usr/app/out --rm nevermendel/leetcode-export
 ## Login
 
 To download your submissions you need to log in your LeetCode account by providing the cookies. To log in using cookies,
-you need to get them from a session where you are already logged in.
+get them from an existing session.
 
 **Steps required**:
 
-- Login in your LeetCode account in your browser
+- Login in to LeetCode in the web browser
 - Open the browser's Dev Tool
 - Click on the Network tab
 - Copy the cookie header that can be found under Request Headers in any leetcode.com request.

leetcode_export/__main__.py

@@ -1,3 +1,8 @@
+'''
+LeetCode Export.
+
+Export your LeetCode submissions and related problem statements.
+'''
 import argparse
 import logging
 import os
@@ -10,17 +15,17 @@
 
 
 def parse_args():
-    parser = argparse.ArgumentParser(description='Export LeetCode solutions', formatter_class=argparse.RawTextHelpFormatter)
+    parser = argparse.ArgumentParser(description='Export LeetCode submissions', formatter_class=argparse.RawTextHelpFormatter)
     parser.add_argument('--cookies', type=str, help='set LeetCode cookies')
     parser.add_argument('--folder', type=str, default='.', help='set output folder')
     parser.add_argument('--problem-folder-name', type=str, default='${question_id}-${title_slug}',
                         help='problem folder name format')
-    parser.add_argument('--problem-filename', type=str, default='${question_id}-${title_slug}.html',
-                        help='problem description filename format')
-    parser.add_argument('--problem-content', type=str,
+    parser.add_argument('--problem-statement-filename', type=str, default='${question_id}-${title_slug}.html',
+                        help='problem statement filename format')
+    parser.add_argument('--problem-statement-content', type=str,
                         default='<h1>${question_id} - ${title}</h1><h2>Difficulty: ${difficulty} - ' +
                                 '<a href="https://leetcode.com/problems/${title_slug}/">${title_slug}</a></h2>${content}',
-                        help='problem description content format')
+                        help='problem statement content format')
     parser.add_argument('--submission-filename', type=str,
                         default='${date_formatted} - ${status_display} - runtime ${runtime} - memory ${memory}.${extension}',
                         help='submission filename format')
@@ -73,9 +78,9 @@ def main():
     logging.info(args)
 
     problem_folder_name_template = Template(args.problem_folder_name)
-    problem_statement_template = Template(args.problem_filename)
-    problem_content_template = Template(args.problem_content)
-    submission_template = Template(args.submission_filename)
+    problem_statement_filename_template = Template(args.problem_statement_filename)
+    problem_statement_template = Template(args.problem_statement_content)
+    submission_filename_template = Template(args.submission_filename)
 
     leetcode = LeetCode()
     cookies = args.cookies
@@ -84,8 +89,8 @@ def main():
         cookies = input("Insert LeetCode cookies: ")
 
     if not leetcode.set_cookies(cookies):
-        print(
-            "Cookies not valid. Copy them from the Network tab of your browser by clicking on any leetcode.com request and going in Request Headers > cookie.")
+        logging.error(
+            "Cookies not valid. Copy them from the Network tab of your browser by clicking on any leetcode.com request and going in Request Headers > cookie. Check README.md file for further information")
         exit(1)
 
     # Create output folder if it doesn't already exist
@@ -103,28 +108,28 @@ def main():
             continue
 
         if submission.title_slug not in title_slug_to_problem_folder_name:
-            problem_statement = leetcode.get_problem(submission.title_slug)
+            problem_statement = leetcode.get_problem_statement(submission.title_slug)
             problem_folder_name = problem_folder_name_template.substitute(**problem_statement.__dict__)
             title_slug_to_problem_folder_name[submission.title_slug] = problem_folder_name
             if not os.path.exists(problem_folder_name):
                 os.mkdir(problem_folder_name)
             os.chdir(problem_folder_name)
 
-            problem_statement_filename = problem_statement_template.substitute(**problem_statement.__dict__)
+            problem_statement_filename = problem_statement_filename_template.substitute(**problem_statement.__dict__)
             if not os.path.exists(problem_statement_filename):
                 with open(problem_statement_filename, 'w+') as problem_statement_file:
-                    problem_statement_file.write(problem_content_template.substitute(**problem_statement.__dict__))
+                    problem_statement_file.write(problem_statement_template.substitute(**problem_statement.__dict__))
         else:
             os.chdir(title_slug_to_problem_folder_name[submission.title_slug])
 
-        sub_filename = submission_template.substitute(**submission.__dict__)
-        if not os.path.exists(sub_filename):
-            logging.info(f"Writing {submission.title_slug}/{sub_filename}")
-            sub_file = open(sub_filename, 'w+')
+        submission_filename = submission_filename_template.substitute(**submission.__dict__)
+        if not os.path.exists(submission_filename):
+            logging.info(f"Writing {submission.title_slug}/{submission_filename}")
+            sub_file = open(submission_filename, 'w+')
             sub_file.write(submission.code)
             sub_file.close()
         else:
-            logging.info(f"{submission.title_slug}/{sub_filename} already exists, skipping it")
+            logging.info(f"{submission.title_slug}/{submission_filename} already exists, skipping it")
 
         os.chdir("..")
 

leetcode_export/leetcode.py

@@ -1,3 +1,6 @@
+'''
+LeetCode Python APIs for retrieving submitted problems and problem statements.
+'''
 import datetime
 import logging
 from time import sleep
@@ -18,6 +21,12 @@ def __init__(self):
         self.user_logged_expiration = datetime.datetime.now()
 
     def log_in(self, username: str, password: str) -> bool:
+        '''
+        Log in to LeetCode using username and password
+        :param username: LeetCode username
+        :param password: LeetCode password
+        :return: bool, true if login is successful, false otherwise
+        '''
         self.session.get(LOGIN_URL)
 
         csrftoken = self.session.cookies.get('csrftoken')
@@ -42,16 +51,27 @@ def set_cookies(self, cookies: str) -> bool:
         :param cookies: string with cookies to set
         :return: bool, true if login is successful, false otherwise
         '''
-        cookies_list = cookies.split(';')
-        cookies_list = map(lambda el: el.split('='), cookies_list)
-        for cookies in cookies_list:
-            self.session.cookies.set(cookies[0].strip(), cookies[1].strip())
+        valid_cookies = True
+        cookie_dict = {}
+
+        for cookie in cookies.split(';'):
+            cookie_split = [el.strip() for el in cookie.split('=', 1)]
+            if len(cookie_split) != 2:
+                valid_cookies = False
+                break
+            cookie_dict[cookie_split[0]] = cookie_split[1]
+
+        valid_cookies = valid_cookies and 'csrftoken' in cookie_dict and 'LEETCODE_SESSION' in cookie_dict
+        if not valid_cookies:
+            logging.error("Cookie format not valid. Expected: 'csrftoken=value1;LEETCODE_SESSION=value2;...'")
+            return False
+
+        for (cookie_key, cookie_value) in cookie_dict.items():
+            self.session.cookies.set(cookie_key, cookie_value)
         if self.is_user_logged():
-            logging.info("Cookies set successful")
+            logging.info("Cookie set successful")
             return True
-        else:
-            logging.warning("Cookies set failed")
-            return False
+        return False
 
     def is_user_logged(self) -> bool:
         '''
@@ -69,12 +89,12 @@ def is_user_logged(self) -> bool:
                 self.user_logged = True
                 self.user_logged_expiration = datetime.datetime.now() + datetime.timedelta(hours=5)
                 return True
-        logging.debug("User is not logged in")
+        logging.error("User is not logged in or account is invalid!")
         return False
 
-    def get_problem(self, slug: str) -> Problem:
+    def get_problem_statement(self, slug: str) -> Problem:
         '''
-        Get LeetCode problem info
+        Get LeetCode problem statement
         :param slug: problem identifier
         :return: Problem
         '''
@@ -91,7 +111,7 @@ def get_submissions(self) -> Iterator[Submission]:
         :return: Iterator[Submission], LeetCode submission
         '''
         if not self.is_user_logged():
-            logging.warning("Trying to get user submissions while user is not logged in")
+            logging.error("Trying to get user submissions while user is not logged in")
             return None
 
         current = 0
@@ -115,6 +135,6 @@ def get_submissions(self) -> Iterator[Submission]:
                     yield submission
 
             current += 20
-            sleep(5)
+            sleep(5) # cooldown time for get request
         if 'detail' in response_json:
             logging.warning(response_json['detail'])