Add support for preloading modules (#148)

* Add support for preloading modules

See palantir/python-language-server#367

* Add config for Eope extensionModules

Author: lgeiger

lib/main.js

@@ -1,7 +1,7 @@
 const cp = require("child_process");
 const { shell } = require("electron");
 const { AutoLanguageClient } = require("atom-languageclient");
-const { detectVirtualEnv } = require("./utils");
+const { detectVirtualEnv, sanitizeConfig } = require("./utils");
 
 // Ref: https://github.com/nteract/hydrogen/blob/master/lib/autocomplete-provider.js#L33
 // adapted from http://stackoverflow.com/q/5474008
@@ -34,7 +34,7 @@ class PythonLanguageClient extends AutoLanguageClient {
     return {
       pyls: {
         configurationSources: configuration.pylsConfigurationSources,
-        rope: { ropeFolder: configuration.ropeFolder !== "null" ? configuration.ropeFolder : null },
+        rope: sanitizeConfig(configuration.rope),
         plugins: configuration.pylsPlugins
       }
     };

lib/utils.js

@@ -42,4 +42,14 @@ async function detectVirtualEnv(path) {
   }
 }
 
+function sanitizeConfig(config) {
+  Object.entries(config).forEach(([key, value]) => {
+    if (value === "null") {
+      config[key] = null;
+    }
+  });
+  return config;
+}
+
 exports.detectVirtualEnv = detectVirtualEnv;
+exports.sanitizeConfig = sanitizeConfig;

package.json

@@ -55,15 +55,10 @@
         ]
       }
     },
-    "ropeFolder": {
-      "order": 3,
-      "type": "string",
-      "default": ".ropeproject",
-      "description": "The name of the folder in which rope stores project configurations and data. Pass `null` for not using such a folder at all."
-    },
     "pylsPlugins": {
       "title": "Python Language Server Plugins",
       "type": "object",
+      "order": 3,
       "properties": {
         "jedi_completion": {
           "title": "Jedi Completion",
@@ -162,6 +157,74 @@
             }
           }
         },
+        "preload": {
+          "title": "Preload",
+          "type": "object",
+          "properties": {
+            "enabled": {
+              "title": "Enabled",
+              "type": "boolean",
+              "default": true,
+              "description": "Enable or disable preload."
+            },
+            "modules": {
+              "title": "Modules",
+              "type": "array",
+              "default": [
+                "OpenGL",
+                "PIL",
+                "array",
+                "audioop",
+                "binascii",
+                "cPickle",
+                "cStringIO",
+                "cmath",
+                "collections",
+                "datetime",
+                "errno",
+                "exceptions",
+                "gc",
+                "imageop",
+                "imp",
+                "itertools",
+                "marshal",
+                "math",
+                "matplotlib",
+                "mmap",
+                "mpmath",
+                "msvcrt",
+                "networkx",
+                "nose",
+                "nt",
+                "numpy",
+                "operator",
+                "os",
+                "os.path",
+                "pandas",
+                "parser",
+                "rgbimg",
+                "scipy",
+                "signal",
+                "skimage",
+                "sklearn",
+                "statsmodels",
+                "strop",
+                "sympy",
+                "sys",
+                "thread",
+                "time",
+                "wx",
+                "xxsubtype",
+                "zipimport",
+                "zlib"
+              ],
+              "items": {
+                "type": "string"
+              },
+              "description": "List of modules to import on startup"
+            }
+          }
+        },
         "pycodestyle": {
           "title": "PyCodeStyle",
           "type": "object",
@@ -345,6 +408,73 @@
           }
         }
       }
+    },
+    "rope": {
+      "type": "object",
+      "properties": {
+        "ropeFolder": {
+          "title": "Rope Folder",
+          "type": "string",
+          "default": ".ropeproject",
+          "description": "The name of the folder in which rope stores project configurations and data. Pass `null` for not using such a folder at all."
+        },
+        "extensionModules": {
+          "title": "Extension Modules",
+          "type": "array",
+          "default": [
+            "OpenGL",
+            "PIL",
+            "array",
+            "audioop",
+            "binascii",
+            "cPickle",
+            "cStringIO",
+            "cmath",
+            "collections",
+            "datetime",
+            "errno",
+            "exceptions",
+            "gc",
+            "imageop",
+            "imp",
+            "itertools",
+            "marshal",
+            "math",
+            "matplotlib",
+            "mmap",
+            "mpmath",
+            "msvcrt",
+            "networkx",
+            "nose",
+            "nt",
+            "numpy",
+            "operator",
+            "os",
+            "os.path",
+            "pandas",
+            "parser",
+            "rgbimg",
+            "scipy",
+            "signal",
+            "skimage",
+            "sklearn",
+            "statsmodels",
+            "strop",
+            "sympy",
+            "sys",
+            "thread",
+            "time",
+            "wx",
+            "xxsubtype",
+            "zipimport",
+            "zlib"
+          ],
+          "items": {
+            "type": "string"
+          },
+          "description": "Builtin and c-extension modules that are allowed to be imported and inspected by rope."
+        }
+      }
     }
   },
   "consumedServices": {

spec/utils-spec.js

@@ -1,5 +1,5 @@
 const path = require("path");
-const { detectVirtualEnv } = require("../lib/utils");
+const { detectVirtualEnv, sanitizeConfig } = require("../lib/utils");
 
 const venvFixturesDir = path.join(__dirname, "fixtures", "venv");
 
@@ -50,3 +50,24 @@ describe("detectVirtualEnv", () => {
     });
   });
 });
+
+describe("sanitizeConfig", () => {
+  it("converts 'null' to null", () => {
+    const config = {
+      ropeFolder: "null",
+      extensionModules: ["numpy", "pandas"]
+    };
+    expect(sanitizeConfig(config)).toEqual({
+      ropeFolder: null,
+      extensionModules: ["numpy", "pandas"]
+    });
+  });
+
+  it("doesn't change object", () => {
+    const config = {
+      ropeFolder: ".ropeproject",
+      extensionModules: ["numpy", "pandas"]
+    };
+    expect(sanitizeConfig(config)).toEqual(config);
+  });
+});