Properly set up sys.path, add logging to debug-exports

Author: kazimuth

runtime/src/jycessing/RunnableSketch.java

@@ -11,11 +11,44 @@
  *
  */
 public interface RunnableSketch {
+  /**
+   * @return The main file of the sketch
+   */
   public abstract File getMainFile();
+  
+  /**
+   * @return The primary code to run
+   */
   public abstract String getMainCode();
+  
+  /**
+   * @return The main directory of the sketch
+   */
   public abstract File getHomeDirectory();
+  
+  /**
+   * @return Files to append to sys.path
+   */
+  public abstract List<File> getPathEntries();
+  
+  /**
+   * @return Arguments to pass to PApplet
+   */
   public abstract String[] getPAppletArguments();
+  
+  /**
+   * @return Directories to search for Processing libraries
+   */
   public abstract List<File> getLibraryDirectories();
+  
+  /**
+   * @return How eagerly we should look for libraries
+   */
   public abstract LibraryPolicy getLibraryPolicy();
-  public abstract boolean shouldRun(); // should probably be true, unless you're a warmup sketch
+  
+  /**
+   * Should probably be true, unless you're a warmup sketch
+   * @return Whether the sketch should run or not
+   */
+  public abstract boolean shouldRun();
 }

runtime/src/jycessing/Runner.java

@@ -242,6 +242,13 @@ public LibraryPolicy getLibraryPolicy() {
     public boolean shouldRun() {
       return false;
     }
+
+    @Override
+    public List<File> getPathEntries() {
+      final List<File> entries = new ArrayList<>();
+      entries.add(getHomeDirectory());
+      return entries;
+    }
   }
 
   /**
@@ -294,8 +301,10 @@ public synchronized static void runSketchBlocking(final RunnableSketch sketch,
     try {
       final InteractiveConsole interp = new InteractiveConsole();
 
-      // Add the sketch directory to the Python library path for auxilliary modules.
-      sys.path.insert(0, Py.newString(sketchDirPath));
+      // Add all of the sketch's requested sys.path entries
+      for (final File entry : sketch.getPathEntries()) {
+        sys.path.insert(0, Py.newString(entry.getAbsolutePath()));
+      }
 
       // For moar useful error messages.
       interp.set("__file__", sketch.getMainFile().getAbsolutePath());

runtime/src/jycessing/launcher/StandaloneSketch.java

@@ -83,9 +83,9 @@ public StandaloneSketch(final String[] args) throws Exception {
 
     // In case the sketch path points to "internal" we get it from the wrapper
     if (argsList.contains("--internal")) {
-      this.sketchPath = new File(getRuntimeRoot(), "Runtime/sketch.py");
+      this.sketchPath = new File(getRuntimeRoot(), "Runtime/sketch.py").getAbsoluteFile();
     } else {
-      this.sketchPath = new File(args[args.length - 1]);
+      this.sketchPath = new File(args[args.length - 1]).getAbsoluteFile();
     }
 
     // Debug when using launcher
@@ -175,4 +175,19 @@ public boolean shouldRun() {
     return true;
   }
 
+  @Override
+  public List<File> getPathEntries() {
+    final List<File> entries = new ArrayList<>();
+    
+    // Main sketch folder
+    entries.add(sketchPath.getParentFile());
+    
+    for (final File dir : getLibraryDirectories()) {
+      // In case the user has added python libraries in their library directories
+      entries.add(dir);
+    }
+    
+    return entries;
+  }
+
 }

runtime/src/jycessing/mode/export/ExportedSketch.java

@@ -26,6 +26,7 @@ public class ExportedSketch implements RunnableSketch {
   public static final String ARGS_EXPORTED = "--exported";
 
   private final File sketchPath;
+  private final File sketchHome;
   private final String code;
   private final DisplayType displayType;
   private final String backgroundColor;
@@ -39,6 +40,7 @@ public class ExportedSketch implements RunnableSketch {
   public ExportedSketch(final String[] args) throws Exception {
     // The last argument is the path to the sketch
     this.sketchPath = new File(args[args.length - 1]).getAbsoluteFile();
+    this.sketchHome = sketchPath.getParentFile().getParentFile();
 
     if (!sketchPath.exists()) {
       throw new FileNotFoundException("Something is terribly wrong - I can't find your sketch!");
@@ -97,7 +99,7 @@ public String getMainCode() {
 
   @Override
   public File getHomeDirectory() {
-    return sketchPath.getParentFile().getParentFile();
+    return sketchHome;
   }
 
   @Override
@@ -137,4 +139,15 @@ public boolean shouldRun() {
     return true;
   }
 
+  @Override
+  public List<File> getPathEntries() {
+    final List<File> entries = new ArrayList<>();
+    
+    entries.add(sketchHome);
+    entries.add(new File(sketchHome, "source"));
+    entries.add(new File(sketchHome, "lib"));
+    
+    return entries;
+  }
+
 }

runtime/src/jycessing/mode/export/LinuxExport.java

@@ -136,6 +136,11 @@ private void buildShellScript(final File destFolder, final boolean embedJava) th
 
     options.add("-splash:\"$APPDIR/lib/jycessing/splash.png\"");
 
+    if (PythonMode.VERBOSE) {
+      // If we're in debug mode, assume we want our exports to be, too
+      options.add("-Dverbose=true");
+    }
+
     // Class to run
     options.add("jycessing.Runner");
 

runtime/src/jycessing/mode/export/MacExport.java

@@ -224,6 +224,11 @@ private void setUpExecutable(final File binFolder, final File processingFolder,
     options.add("-Xdock:icon=\"$CONTENTS/Resources/sketch.icns\"");
     options.add("-Xdock:name=\"" + sketchName + "\"");
 
+    if (PythonMode.VERBOSE) {
+      // If we're in debug mode, assume we want our exports to be, too
+      options.add("-Dverbose=true");
+    }
+
     // Class to run
     options.add("jycessing.Runner");
 

runtime/src/jycessing/mode/run/PdeSketch.java

@@ -124,4 +124,16 @@ public LibraryPolicy getLibraryPolicy() {
   public boolean shouldRun() {
     return true;
   }
+
+  @Override
+  public List<File> getPathEntries() {
+    final List<File> entries = new ArrayList<>();
+    entries.add(sketchHome);
+    entries.add(new File(sketchHome, "source"));
+    final File code = new File(sketchHome, "code");
+    if (code.exists()) {
+      entries.add(code);
+    }
+    return entries;
+  }
 }

testing/src/test/jycessing/TestSketch.java

@@ -3,6 +3,7 @@
 import java.io.File;
 import java.nio.file.Path;
 import java.nio.file.Paths;
+import java.util.ArrayList;
 import java.util.List;
 
 import processing.core.PApplet;
@@ -61,4 +62,11 @@ public boolean shouldRun() {
     return true;
   }
 
+  @Override
+  public List<File> getPathEntries() {
+    final List<File> entries = new ArrayList<>();
+    entries.add(getHomeDirectory());
+    return entries;
+  }
+
 }