Enhance functionality with improved problem handling and UI

Added problem tags, acceptance rate, and descriptions to logs for better user experience. Introduced default values for CLI arguments to streamline input handling. Minor logging improvements, upgraded dependencies, and refined problem fetching logic for robustness.

Author: nicholasadamou

PracticeFactory.py

@@ -1,4 +1,6 @@
 import random
+import html2text
+
 from typing import List, Dict, Any, Optional
 
 from utils.logger import log, LogLevel
@@ -20,10 +22,30 @@ def handle(self, args):
         raise NotImplementedError("This method should be implemented by subclasses.")
 
     def log_problem_details(self, problem, difficulty_label, url):
-        log(f"🎯 Problem Selected: {problem['title']}", LogLevel.INFO)
+        log(f"🎯 Problem Selected: {problem.get('title', 'Unknown')}", LogLevel.INFO)
         log(f"✨ Difficulty: {difficulty_label}", LogLevel.INFO)
         log(f"🔗 URL: {url}", LogLevel.INFO)
 
+        topic_tags = problem.get("topicTags", [])
+        if topic_tags:
+            tags = ", ".join(tag.get("name", "Unknown") for tag in topic_tags)
+            log(f"🏷️ Tags: {tags}", LogLevel.INFO)
+
+        ac_rate = problem.get("acRate")
+        if ac_rate is not None:
+            log(f"📈 Acceptance Rate: {ac_rate:.2f}%", LogLevel.INFO)
+
+        content = problem.get("content")
+        if content:
+            try:
+                text_maker = html2text.HTML2Text()
+                text_maker.ignore_links = True
+                plain_text = text_maker.handle(content)
+                log(f"📝 Problem Description:", LogLevel.INFO)
+                log(f"{plain_text}", LogLevel.INFO)
+            except Exception as e:
+                log(f"⚠️ Failed to process problem description: {e}", LogLevel.WARN)
+
     def open_in_browser(self, url, open_flag):
         if open_flag:
             import webbrowser
@@ -42,17 +64,15 @@ def create_and_solve_handler(self, problem_slug, difficulty_label, args):
 
     def get_random_problem(
         self,
-        category_slug: Optional[str] = None,
         difficulties: Optional[List[str]] = None,
     ) -> Optional[Dict[str, Any]]:
         """
         Get a random problem from LeetCode.
-        :param category_slug: Slug of the category to fetch problems from.
         :param difficulties: Difficulty levels of the problems (e.g., "Easy", "Medium", "Hard").
         :return: A random problem dictionary or None if no problems are found.
         """
         problems = self.leetcode_api.fetch_problems(
-            category_slug=category_slug, limit=1000, difficulties=difficulties
+            limit=1000, difficulties=difficulties
         )
 
         if not problems:
@@ -104,7 +124,7 @@ def handle(self, args):
 
         try:
             # Use the LeetCodeAPI's fetch_problems method
-            problem = self.get_random_problem(args["difficulties"])
+            problem = self.get_random_problem(difficulties=args["difficulties"])
 
             if not problem:
                 log("No problems found for the selected difficulties.", LogLevel.ERROR)
@@ -148,7 +168,6 @@ def handle(self, args):
         log("Selected 🧩 Custom Practice Mode", LogLevel.INFO)
 
         for slug in args["problems"]:
-            log(f"🔍 Fetching details for problem: {slug}", LogLevel.INFO)
             try:
                 problem = self.leetcode_api.fetch_problem(slug.strip())
 
@@ -171,13 +190,15 @@ def handle(self, args):
         try:
             log(f"Selected 🎯 Study Plan Mode: {args['plan_name']}", LogLevel.INFO)
 
-            # Use the LeetCodeAPI's fetch_problems method
             problem = self.get_random_study_plan_problem(args["plan_name"])
 
             if not problem:
                 log("No problems found for the selected study plan.", LogLevel.ERROR)
                 return
 
+            # Get the problem in the right format
+            problem = self.leetcode_api.fetch_problem(problem["titleSlug"])
+
             difficulty_label = difficulty_map[problem["difficulty"].lower()]
             url = f"https://leetcode.com/problems/{problem['titleSlug']}"
 

README.md

@@ -59,10 +59,24 @@ Optional arguments:
 - `--open-in-browser`: Opens the challenge in a browser window.
 - `--editor`: Open the code editor to write solutions. Supported editors include `default`, `vim`, `nano`, and others. Example usage: `--editor vim`
 
+```text
+Welcome to 🦑 SquidLeet!
+🔐 Using authenticated session
+Selected 📅 Daily Challenge Mode
+🎯 Daily Coding Challenge:
+📅 Date: 2025-01-19
+🎯 Problem Selected: Trapping Rain Water II
+✨ Difficulty: Hard
+🔗 URL: https://leetcode.com/problems/trapping-rain-water-ii
+🏷️ Tags: Array, Breadth-First Search, Heap (Priority Queue), Matrix
+📈 Acceptance Rate: 55.04%
+...
+```
+
 ### Random Problem Mode
 
-Solve a randomly selected LeetCode problem based on difficulty.
-Random Practice Mode allows you to solve a randomly selected LeetCode problem. Enhanced difficulty classification includes options such as `easy`, `medium`, `hard`, or a combination (e.g., `--difficulty easy,medium`).
+Solve a randomly selected LeetCode problem based on difficulty. Random Practice Mode allows you to solve a randomly selected LeetCode problem. Enhanced difficulty classification includes options such as `easy`, `medium`, `hard`, or a combination (e.g., `--difficulty easy,medium`).
+
 ```bash
 python3 main.py --mode random --difficulty medium
 ```
@@ -72,6 +86,18 @@ Optional arguments:
 - `--open-in-browser`: Opens the problem in a browser window.
 - `--editor`: Specify a code editor for writing solutions. Supported editors: `default`, `vim`, `nano`, etc.
 
+```text
+Welcome to 🦑 SquidLeet!
+🔐 Using authenticated session
+Selected 🎲 Random Problem Mode
+🎯 Problem Selected: Shortest Distance in a Plane
+✨ Difficulty: Medium
+🔗 URL: https://leetcode.com/problems/shortest-distance-in-a-plane
+🏷️ Tags: Database
+📈 Acceptance Rate: 61.29%
+...
+```
+
 ### Custom Mode
 
 Custom Modes enable solving specific problems or sets of problems by providing one or multiple problem slugs (e.g., `--problems two-sum,three-sum`).
@@ -84,6 +110,18 @@ Optional arguments:
 - `--open-in-browser`: Opens the problem in a browser window.
 - `--editor`: Specify the preferred code editor (e.g., `vim`, `nano`). Default is the system-configured default editor.
 
+```text
+Welcome to 🦑 SquidLeet!
+🔐 Using authenticated session
+Selected 🧩 Custom Practice Mode
+🎯 Problem Selected: Two Sum
+✨ Difficulty: Easy
+🔗 URL: https://leetcode.com/problems/two-sum
+🏷️ Tags: Array, Hash Table
+📈 Acceptance Rate: 54.67%
+...
+```
+
 ### Study Plan Mode
 
 Study Plan Mode allows you to fetch random problems based on a specific study plan. You can specify the study plan name to fetch problems from that plan.
@@ -96,6 +134,18 @@ Optional arguments:
 - `--open-in-browser`: Opens the problem in a browser window.
 - `--editor`: Specify the preferred code editor (e.g., `vim`, `nano`). Default is the system-configured default editor.
 
+```text
+Welcome to 🦑 SquidLeet!
+🔐 Using authenticated session
+Selected 🎯 Study Plan Mode: top-interview-150
+🎯 Problem Selected: Game of Life
+✨ Difficulty: Medium
+🔗 URL: https://leetcode.com/problems/game-of-life
+🏷️ Tags: Array, Matrix, Simulation
+📈 Acceptance Rate: 70.65%
+...
+```
+
 ## Configurations
 Squidleet uses a `LEETCODE_SESSION` cookie for authentication. Setting the `LEETCODE_SESSION` environment variable is necessary for all operations, including fetching and submitting problems.
 

api/LeetCodeAPI.py

@@ -23,14 +23,12 @@ def __init__(self):
 
     def fetch_problems(
         self,
-        category_slug: str = "all-code-essentials",
         limit: int = 50,
         skip: int = 0,
         difficulties: Optional[List[str]] = None,
     ) -> List[Dict[str, Any]]:
         """
         Fetch a list of problems from LeetCode.
-        :param category_slug: The category of problems to fetch.
         :param limit: Number of problems to fetch.
         :param skip: Offset for pagination.
         :param difficulties: List of difficulty levels (e.g., ["Easy", "Medium", "Hard"]).
@@ -74,7 +72,7 @@ def fetch_for_difficulty(difficulty: str) -> List[Dict[str, Any]]:
 
             filters = {"difficulty": difficulty_enum.get(difficulty.lower())}
             variables = {
-                "categorySlug": category_slug,
+                "categorySlug": "all-code-essentials",
                 "limit": limit,
                 "skip": skip,
                 "filters": filters,
@@ -126,6 +124,7 @@ def fetch_daily_challenge(self) -> Dict[str, Any]:
               titleSlug
               title
               translatedTitle
+              content
               acRate
               difficulty
               freqBar

main.py

@@ -7,11 +7,11 @@ def main():
         # Parse CLI options
         cli_options = CommandParser.parse()
 
+        log("Welcome to 🦑 SquidLeet!", LogLevel.INFO)
+
         # Validate and set the LeetCode session token
         SessionManager.initialize(cli_options)
 
-        log("Welcome to 🦑 SquidLeet!", LogLevel.INFO)
-
         # Collect & validate inputs and detect practice mode
         inputs = InputsCollector.collect(cli_options)
 

requirements.txt

@@ -1,14 +1,53 @@
 black==24.10.0
-certifi==2024.12.14
-charset-normalizer==3.4.1
+build==1.2.1
+CacheControl==0.14.0
+certifi==2024.7.4
+cffi==1.16.0
+cfgv==3.4.0
+charset-normalizer==3.3.2
+cleo==2.1.0
 click==8.1.8
-idna==3.10
+crashtest==0.4.1
+distlib==0.3.8
+dulwich==0.21.7
+fastjsonschema==2.20.0
+filelock==3.15.4
+identify==2.6.5
+idna==3.7
+importlib_metadata==8.2.0
+installer==0.7.0
+jaraco.classes==3.4.0
+keyring==24.3.1
+more-itertools==10.3.0
+msgpack==1.0.8
 mypy-extensions==1.0.0
-packaging==24.2
+nodeenv==1.9.1
+packaging==24.1
 pathspec==0.12.1
-platformdirs==4.3.6
-python-dotenv==1.0.1
+pexpect==4.9.0
+pkginfo==1.11.1
+platformdirs==4.2.2
+poetry==1.8.3
+poetry-core==1.9.0
+poetry-plugin-export==1.8.0
+pre_commit==4.0.1
+ptyprocess==0.7.0
+pycparser==2.22
+pyproject_hooks==1.1.0
+PyYAML==6.0.2
+rapidfuzz==3.9.4
 requests==2.32.3
-tomli==2.2.1
+requests-toolbelt==1.0.0
+shellingham==1.5.4
+six==1.17.0
+tomli==2.0.1
+tomlkit==0.13.0
+trove-classifiers==2024.7.2
 typing_extensions==4.12.2
-urllib3==2.3.0
+urllib3==2.2.2
+virtualenv==20.26.3
+xattr==1.1.0
+zipp==3.19.2
+
+python-dotenv~=1.0.1
+html2text~=2024.2.26

services/CommandParser.py

@@ -15,11 +15,13 @@ def parse():
         "--difficulties",
         type=str,
         help="Comma-separated difficulty levels (easy, medium, hard)",
+        default="easy,medium,hard",
     )
     parser.add_argument(
         "--problems",
         type=str,
         help="Comma-separated problem slugs (e.g., 'two-sum,fizz-buzz')",
+        default="two-sum",
     )
     parser.add_argument(
         "--plan-name",

services/InputsCollector.py

@@ -7,11 +7,15 @@ def collect(cli_options):
     problems = None
 
     if practice_mode == "random":
-        difficulties = cli_options.get(
-            "difficulties", ["easy", "medium", "hard"]
-        ).split(",")
+        difficulties = cli_options.get("difficulties", "easy,medium,hard")
+
+        if difficulties:
+            difficulties = difficulties.split(",")
     elif practice_mode == "custom":
-        problems = cli_options.get("problems", "").split(",")
+        problems = cli_options.get("problems", "")
+
+        if problems:
+            problems = problems.split(",")
 
     log_level = cli_options.get("log_level", "INFO")
     plan_name = cli_options.get("study_plan", "top-interview-150")

services/SessionManager.py

@@ -12,8 +12,8 @@ def initialize(cli_options: dict):
         "LEETCODE_SESSION"
     )
     if not leetcode_session:
-        log("Using unauthenticated session", LogLevel.WARN)
+        log("🔓 Using unauthenticated session", LogLevel.WARN)
         return
 
     os.environ["LEETCODE_SESSION"] = leetcode_session
-    log("Using authenticated session", LogLevel.DEBUG)
+    log("🔐 Using authenticated session", LogLevel.INFO)