Refactor for cleaner codebase (#2)

- Break the pathfinding visualizer into smaller files for maintainability.
- Break the data structures file into multiple files for maintainability.
- Remove unneeded comments.

Author: truongluan303

.gitignore

@@ -27,10 +27,8 @@ repos:
     rev: 22.3.0
     hooks:
       - id: black
-        language_version: python3.10
-        args: ['--target-version', 'py310']
   - repo: https://github.com/asottile/pyupgrade
-    rev: v2.19.0
+    rev: v3.4.0
     hooks:
       - id: pyupgrade
         args: [--py37-plus]

.pre-commit-config.yaml

@@ -22,4 +22,5 @@ If the script fails, please check out the [setup doc](./docs/setup.md) for instr
 
 ## Running The Program
 
-Once you are done with dev setup, enter the virtual environment and simply run `python3 driver.py` to start the program.
+Once you are done with dev setup. Enter the virtual environment with `source .venv/bin/activate` if you are on a Mac/Unix/Linux system, or with `.\venv\Scripts\activate` if you are on a Windows system.
+Then simply run `python main.py` to start the program.

README.md

@@ -14,7 +14,7 @@ def is_win():
 
 def check_py_version(major: int, minor: int) -> None:
     pyver = sys.version_info
-    if pyver.major != 3 or pyver.minor != 10:
+    if pyver.major != major or pyver.minor < minor:
         print(
             f"Your Python version is {pyver.major}.{pyver.minor}. "
             f"Python {major}.{minor} is required!\n"
@@ -50,7 +50,7 @@ def perform_installations() -> None:
 
 def main():
     try:
-        check_py_version(3, 10)
+        check_py_version(3, 7)
         create_venv()
         perform_installations()
     except:

bin/clean

@@ -4,9 +4,9 @@ A complete guide to setup your development environment :D
 
 ---
 
-### Requirements
+### Requirement
 
-`python 3.7` or higher
+Minimum `python3.7`. `python 3.10` is recommended.
 
 Make sure you also already installed `pip` and `venv` for your Python
 
@@ -58,4 +58,4 @@ These lint tools will be run when you commit your code and you can only successf
 
 ---
 
-### You're good to run the program or to write your code now! :)
+### You're good to run the program and also write your code now! :)

bin/get_pip

@@ -1,7 +1,7 @@
-#!/usr/bin/python3
-
+#!/usr/bin/python
 from src.home_window import HomeWindow
 
+
 if __name__ == "__main__":
     while True:
         HomeWindow()

bin/setup

@@ -1 +1,10 @@
+cfgv==3.3.1
+distlib==0.3.6
+filelock==3.12.0
+identify==2.5.23
+nodeenv==1.7.0
+platformdirs==2.6.2
 pre-commit==2.20.0
+PyYAML==6.0
+toml==0.10.2
+virtualenv==20.16.5

docs/setup.md

@@ -0,0 +1,5 @@
+from .priority_queue import PriorityQueue
+from .queue import Queue
+from .stack import Stack
+
+__all__ = ["PriorityQueue", "Queue", "Stack"]

images/algo_icon.ico

@@ -0,0 +1,32 @@
+from typing import Generic
+from typing import TypeVar
+
+T = TypeVar("T")
+
+
+class Node(Generic[T]):
+    """Linked List Node"""
+
+    def __init__(self, value: T, next=None) -> None:
+        self._value = value
+        self._next = next
+
+    def get_value(self) -> T:
+        return self._value
+
+    def get_next(self):
+        return self._next
+
+    def set_next(self, next):
+        self._next = next
+
+
+class PriorityNode(Node):
+    """Priority Node"""
+
+    def __init__(self, value, priority: float, next_node=None) -> None:
+        super().__init__(value, next_node)
+        self._priority = priority
+
+    def get_priority(self) -> float:
+        return self._priority

images/path_icon.ico

@@ -0,0 +1,73 @@
+from typing import Generic
+from typing import TypeVar
+
+from .nodes import PriorityNode
+
+T = TypeVar("T")
+
+
+class PriorityQueue(Generic[T]):
+    """Priority Queue"""
+
+    def __init__(self) -> None:
+        self.reset()
+
+    # add new node to the queue
+    # The lower the priority is, the faster it gets to be poped
+    def enqueue(self, val: T, priority: float = None) -> None:
+        new_node = PriorityNode(val, priority)
+        if self.is_empty():
+            self._head = new_node
+            self._tail = new_node
+        else:
+            if priority is None or priority > self._tail.get_priority():
+                self._tail.set_next(new_node)
+                self._tail = new_node
+            elif priority <= self._head.get_priority():
+                new_node.set_next(self._head)
+                self._head = new_node
+            else:
+                current = self._head
+                # find the right place to put the new node in according to the priority
+                while (
+                    current.get_next() is not None
+                    and current.get_next().get_priority() < priority
+                ):
+                    current = current.get_next()
+                temp = current.get_next()
+                current.set_next(new_node)
+                new_node.set_next(temp)
+        self._size += 1
+
+    # pop the node at the top of the queue
+    # time complexity: O(1)
+    def dequeue(self) -> T:
+        if self.is_empty():
+            raise Exception("Attempted to dequeue an empty queue!!!")
+        temp = self.peek()
+        self._head = self._head.get_next()
+        self._size -= 1
+        # if the new head is None, it means the queue is empty
+        if self._head is None:
+            self.reset()
+        return temp
+
+    # get the value in the front of the queue
+    # time complexity: O(1)
+    def peek(self) -> T:
+        if self.is_empty():
+            raise Exception("Attempted to peek an empty queue!!!")
+        return self._head.get_value()
+
+    # get the size of the queue
+    def get_size(self) -> int:
+        return self._size
+
+    # check if the queue is empty
+    def is_empty(self) -> bool:
+        return self._size == 0
+
+    def reset(self) -> None:
+        self._head = None
+        self._tail = None
+        self._size = 0