add dynamic module importing

allows to add modules without recompiling the program

Author: amari-calipso

README.md

@@ -47,7 +47,17 @@ To do Python development for the visualizer, it's recommended to create its Pyth
 opal pycompile SortingVisualizer.opal
 ```
 
-And then add these lines on top of your Python code:
+When adding modules to the visualizer dynamically (through the `external` folder), you can use the pycompiled version like this:
+```py
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+	from SortingVisualizer import *
+```
+
+This way, your IDE will be able to typecheck the program and give you proper hints, while not executing the import when the code is actually ran.
+
+Instead, if you are writing code that will be embedded in the compiled visualizer, add these lines on top of your Python code:
 ```py
 #opal$if False
 from SortingVisualizer import *

SortingVisualizer.opal

@@ -17,7 +17,7 @@ new float UNIT_SAMPLE_DURATION = 1.0 / 30.0,
           N_OVER_R             = NATIVE_FRAMERATE / RENDER_FRAMERATE,
           R_OVER_N             = RENDER_FRAMERATE / NATIVE_FRAMERATE;
 
-new str VERSION = "2024.6.29";
+new str VERSION = "2024.7.19";
 
 import math, random, time, os, numpy, sys, 
        pygame_gui, json, subprocess, shutil,
@@ -2138,5 +2138,19 @@ main {
     $includeDirectory os.path.join(HOME_DIR, "shuffles")
     $includeDirectory os.path.join(HOME_DIR, "sorts")
 
+    try {
+        new dynamic externalMods = os.path.join(HOME_DIR, "external");
+        for module in os.listdir(externalMods) {
+            if module.endswith(".py") {
+                with open(os.path.join(externalMods, module), "r", encoding = "utf-8") as f {
+                    use f; exec(f.read());
+                }
+            }
+        }
+    } catch Exception as e {
+        IO.out("An error occurred while importing external modules. Exception:\n{formatException(e)}");
+        sys.exit(1);
+    }
+
     sortingVisualizer.run();
 }

build.iproj

@@ -1,6 +1,7 @@
 source: "SortingVisualizer.opal",
 copy: {
     "resources": folder,
+    "external": folder,
     "profiles": folder,
     "threads": folder,
     "config": folder

external/readme.txt

@@ -0,0 +1 @@
+put external modules to be dynamically loaded inside the visualizer here!