Merge pull request #139 from vidartf/fixes

Various minor fixes that cropped up

Author: vidartf

MANIFEST.in

@@ -1,3 +1,33 @@
 recursive-include pythreejs/static *.*
 
 include setupbase.py
+
+include LICENSE
+include README.md
+include pytest.ini
+
+# Documentation
+graft docs
+exclude docs/\#*
+
+# docs subdirs we want to skip
+prune docs/build
+prune docs/dist
+
+# Examples
+graft examples
+
+# Patterns to exclude from any directory
+global-exclude *~
+global-exclude *.pyc
+global-exclude *.pyo
+global-exclude .git
+global-exclude .ipynb_checkpoints
+
+# JS files
+graft js
+prune js/node_modules
+graft jslab
+prune jslab/node_modules
+
+# TODO: include / exclude autogenerated code?

examples/renderer_limit.ipynb

@@ -49,7 +49,7 @@
     "# - no prior image is lost because of subsequent renderings\n",
     "VBox(children=[\n",
     "    HBox(children=[\n",
-    "        PreviewWidget(mesh, _width=150, _height=150, layout=Layout(padding='2px'))\n",
+    "        Preview(mesh, _width=150, _height=150, layout=Layout(padding='2px'))\n",
     "        for mesh in [mesh1, mesh2, mesh3, mesh4, mesh5, mesh6]])\n",
     "    for _ in range(5)\n",
     "])"

js/package.json

@@ -20,16 +20,15 @@
   },
   "devDependencies": {
     "eslint": "^4.11.0",
-    "fs-extra": "^4.0.1",
-    "glob": "^7.0.6",
-    "handlebars": "^4.0.5",
-    "rimraf": "^2.4.1",
-    "underscore": "^1.8.3",
-    "webpack": "^3.6.0"
+    "fs-extra": "^4.0.2",
+    "glob": "^7.1.2",
+    "handlebars": "^4.0.11",
+    "rimraf": "^2.6.2",
+    "webpack": "^3.8.1"
   },
   "dependencies": {
-    "@jupyter-widgets/base": "^1.0.0",
-    "bluebird": "^3.4.3",
+    "@jupyter-widgets/base": "^1.1.4",
+    "bluebird": "^3.5.1",
     "jupyter-dataserializers": "^1.0.0",
     "three": "^0.87.1",
     "underscore": "^1.8.3"

js/scripts/generate-wrappers.js

@@ -2,15 +2,10 @@
 
 const _ = require('underscore');
 const path = require('path');
-const fs = require('fs');
 const fse = require('fs-extra');
 const Glob = require('glob').Glob;
-const Promise = require('bluebird');
 const Handlebars = require('handlebars');
 
-Promise.promisifyAll(fs);
-Promise.promisifyAll(fse);
-
 const classConfigs = require('./three-class-config');
 const Types = require('./prop-types.js');
 
@@ -56,9 +51,17 @@ const IGNORE_FILES = [
     '**/animation/KeyframeTrackConstructor.js',     // Sub-part of one object, ignore
     '**/animation/KeyframeTrackPrototype.js',       // Sub-part of one object, ignore
     '**/audio/AudioContext.js',             // JS API for audio, nothing to expose
+    '**/core/Face3.js',     // Implemented as trait only, not widget model
     '**/geometries/Geometries.js',          // index.js like file, nothing new here
     '**/materials/Materials.js',            // index.js like file, nothing new here
     '**/materials/MeshDistanceMaterial.js', // TODO: Undocumented as of yet
+    '**/math/Vector2.js',   // Implemented as trait only, not widget model
+    '**/math/Vector3.js',   // Implemented as trait only, not widget model
+    '**/math/Vector4.js',   // Implemented as trait only, not widget model
+    '**/math/Matrix3.js',   // Implemented as trait only, not widget model
+    '**/math/Matrix4.js',   // Implemented as trait only, not widget model
+    '**/math/Color.js',     // Implemented as trait only, not widget model
+    '**/math/Euler.js',     // Implemented as trait only, not widget model
     '**/renderers/WebGLRenderer.js',        // For now, the internals of the webgl
     '**/renderers/WebGL2Renderer.js',       //   render is not exposed.
     //'**/renderers/webgl/**',
@@ -87,7 +90,7 @@ const IGNORE_FILES = [
 function compileTemplate(templateName) {
     templateName = path.basename(templateName, '.mustache');
     const templatePath = path.resolve(templateDir, templateName + '.mustache');
-    return Handlebars.compile(fs.readFileSync(templatePath, {
+    return Handlebars.compile(fse.readFileSync(templatePath, {
         encoding: 'utf-8'
     }));
 }
@@ -306,7 +309,7 @@ class JavascriptWrapper {
 
         // check if manual file exists
         const customSrcPath = path.join(path.dirname(this.jsDestPath), path.basename(this.jsDestPath, '.js') + '.js');
-        this.hasOverride = fs.existsSync(customSrcPath);
+        this.hasOverride = fse.existsSync(customSrcPath);
 
         this.processSuperClass();
         this.processDependencies();
@@ -363,7 +366,7 @@ class JavascriptWrapper {
 
         result.absolutePath = path.resolve(jsSrcDir, result.relativePath);
         let absPath = result.absolutePath;
-        if (fs.existsSync(absPath + '.js')) {
+        if (fse.existsSync(absPath + '.js')) {
             absPath += '.js';
         } else {
             absPath += JS_AUTOGEN_EXT;
@@ -524,7 +527,7 @@ function createJavascriptWrapper(modulePath, className) {
         console.log('skipping: ' + modulePath + (className ? ':' + className : ''));
         return Promise.resolve(false);
     }
-    return fse.outputFileAsync(wrapper.getOutputFilename(), wrapper.output);
+    return fse.outputFile(wrapper.getOutputFilename(), wrapper.output);
 
     // NOTE: Old implementation
     // const wrapper = new JavascriptWrapper(modulePath);
@@ -553,7 +556,7 @@ function writeJavascriptIndexFiles() {
         const dirAbsPath = path.resolve(jsSrcDir, dirPath);
 
         // Generate list of files in dir to include in index.js as require lines
-        return fs.readdirAsync(dirAbsPath).then(function(dirFiles) {
+        return fse.readdir(dirAbsPath).then(function(dirFiles) {
 
             // get proper relative path for file
             dirFiles = dirFiles.map(function(filename) {
@@ -616,7 +619,7 @@ function writeJavascriptIndexFiles() {
             const output = jsIndexTemplate(context);
             const outputPath = path.resolve(jsSrcDir, dirPath, 'index.js');
 
-            return fse.outputFileAsync(outputPath, output);
+            return fse.outputFile(outputPath, output);
 
         });
     }
@@ -668,7 +671,9 @@ class PythonWrapper {
         this.pyBaseRelativePath = relativePathToPythonImportPath(this.pyBaseRelativePath);
 
         // check if manual file exists
-        this.hasOverride = fs.existsSync(this.pyDestPath);
+        this.hasOverride = fse.existsSync(this.pyDestPath);
+
+        this.isCustom = CUSTOM_CLASSES.indexOf(modulePath) !== -1;
 
         this.hasParameters = false;
 
@@ -681,7 +686,6 @@ class PythonWrapper {
         this.processConstructorArgs();
 
         // Template and context
-        this.template = pyWrapperTemplate;
         this.context = {
             now: new Date(),
             generatorScriptName: path.basename(__filename),
@@ -698,10 +702,11 @@ class PythonWrapper {
             properties: this.properties,
             dependencies: this.dependencies,
             hasOverride: this.hasOverride,
+            isCustom: this.isCustom,
         };
 
         // Render template
-        this.output = this.template(this.context);
+        this.output = pyWrapperTemplate(this.context);
 
     }
 
@@ -727,7 +732,7 @@ class PythonWrapper {
         // get path of dependency relative to module dir
         result.absolutePath = path.resolve(pySrcDir, result.relativePath);
 
-        if (!fs.existsSync(result.absolutePath + '.py')) {
+        if (!fse.existsSync(result.absolutePath + '.py')) {
             result.absolutePath += '_' + AUTOGEN_EXT;
         }
 
@@ -821,12 +826,16 @@ class PythonWrapper {
 
     processDocsUrl() {
 
+        if (this.isCustom) {
+            this.docsUrl = null;
+        }
+
         const refTokens = this.modulePath.split(pathSep);
 
         // strip extension off filename
         refTokens[refTokens.length - 1] = path.basename(refTokens[refTokens.length - 1], '.js');
 
-        let refUrl = 'http://threejs.org/docs/#api/' + refTokens.join('/');
+        let refUrl = 'https://threejs.org/docs/#api/' + refTokens.join('/');
 
         // combine middle elements of url with dot
         refUrl = refUrl.replace('Renderers/WebGL/Plugins/', 'Renderers.WebGL.Plugins/');
@@ -859,8 +868,10 @@ function createPythonWrapper(modulePath, className) {
         console.log('skipping: ' + modulePath + (className ? ':' + className : ''));
         return Promise.resolve(false);
     }
-    return fse.outputFileAsync(wrapper.getOutputFilename(), wrapper.output);
+    let fname = wrapper.getOutputFilename();
+    let pyPromise = fse.outputFile(fname, wrapper.output);
 
+    return pyPromise;
 }
 
 function createPythonModuleInitFile(modulePath) {
@@ -892,7 +903,7 @@ function createTopLevelPythonModuleFile() {
         if (/autogen/.test(moduleName)) {
             const overrideName = moduleName.replace('_autogen', '');
             const overridePath = path.resolve(pySrcDir, modulePath, overrideName + '.py');
-            if (fs.existsSync(overridePath)) {
+            if (fse.existsSync(overridePath)) {
                 console.log('Python override exists: ' + overrideName + '. Skipping...');
                 return;
             }
@@ -925,7 +936,7 @@ function createTopLevelPythonModuleFile() {
         const output = pyTopLevelInitTemplate(context);
         const outFilePath = path.resolve(pySrcDir, '__init__.py');
 
-        return fse.outputFileAsync(outFilePath, output);
+        return fse.outputFile(outFilePath, output);
 
     });
 
@@ -945,7 +956,7 @@ function createJavascriptFiles() {
 function createPythonFiles() {
 
     // Prevent python file generation when outside dir (e.g. npm install in dependent)
-    if (!fs.existsSync(pySrcDir)) {
+    if (!fse.existsSync(pySrcDir)) {
         return Promise.resolve();
     }
 
@@ -975,6 +986,7 @@ function createPythonFiles() {
 
 }
 
+
 function generateFiles() {
 
     return Promise.all([

js/scripts/prop-types.js

@@ -13,7 +13,7 @@ class BaseType {
         if (this.defaultValue === false) { return 'False'; }
         if (this.defaultValue === true) { return 'True'; }
         if (this.defaultValue === 0) { return '0'; }
-        if (this.defaultValue === '') { return '""'; }
+        if (this.defaultValue === '') { return "''"; }
         if (this.defaultValue === Infinity) { return "float('inf')"; }
         if (this.defaultValue === -Infinity) { return "-float('inf')"; }
         if (!this.defaultValue) { return 'None'; }
@@ -66,9 +66,9 @@ class ThreeType extends BaseType {
     getTraitlet() {
         let typeName = this.typeName;
         if (typeName instanceof Array) {
-            for (let tname of typeName) {
+            typeName = typeName.map(tname => {
                 return `${tname || 'ThreeWidget'}`;
-            }
+            });
         } else {
             typeName = `${typeName || 'ThreeWidget'}`;
         }
@@ -99,7 +99,7 @@ class ForwardDeclaredThreeType extends ThreeType {
 
 class InitializedThreeType extends ThreeType {
     getJSPropertyValue() {
-        return '"uninitialized"';
+        return "'uninitialized'";
     }
     getPythonDefaultValue() {
         return 'UninitializedSentinel';
@@ -304,7 +304,7 @@ class Color extends BaseType {
     constructor(defaultValue, options) {
         super();
         options = options || {};
-        this.defaultValue = defaultValue || "#ffffff";
+        this.defaultValue = defaultValue || '#ffffff';
         this.nullable = options.nullable === true;
     }
     getTraitlet() {
@@ -319,7 +319,7 @@ class Color extends BaseType {
 class ColorArray extends BaseType {
     constructor(defaultValue) {
         super();
-        this.defaultValue = defaultValue || ["#ffffff"];
+        this.defaultValue = defaultValue || ['#ffffff'];
     }
     getTraitlet() {
         return `List(trait=Unicode(), default_value=${this.getPythonDefaultValue()}).tag(sync=True)`;
@@ -411,7 +411,7 @@ class Vector2 extends BaseType {
         this.defaultValue = [ x||0, y||0 ];
     }
     getTraitlet() {
-        return 'Vector2(default=' + JSON.stringify(this.defaultValue) + ').tag(sync=True)';
+        return 'Vector2(default_value=' + JSON.stringify(this.defaultValue) + ').tag(sync=True)';
     }
     getPropertyConverterFn() {
         return 'convertVector';
@@ -427,7 +427,7 @@ class Vector3 extends BaseType {
         this.defaultValue = [ x||0, y||0, z||0 ];
     }
     getTraitlet() {
-        return 'Vector3(default=' + JSON.stringify(this.defaultValue) + ').tag(sync=True)';
+        return 'Vector3(default_value=' + JSON.stringify(this.defaultValue) + ').tag(sync=True)';
     }
     getPropertyConverterFn() {
         return 'convertVector';
@@ -443,7 +443,7 @@ class Vector4 extends BaseType {
         this.defaultValue = [ x||0, y||0, z||0, w||0 ];
     }
     getTraitlet() {
-        return 'Vector4(default=' + JSON.stringify(this.defaultValue) + ').tag(sync=True)';
+        return 'Vector4(default_value=' + JSON.stringify(this.defaultValue) + ').tag(sync=True)';
     }
     getPropertyConverterFn() {
         return 'convertVector';
@@ -495,7 +495,7 @@ class Matrix3 extends BaseType {
         ];
     }
     getTraitlet() {
-        return 'Matrix3(default=' + JSON.stringify(this.defaultValue) + ').tag(sync=True)';
+        return 'Matrix3(default_value=' + JSON.stringify(this.defaultValue) + ').tag(sync=True)';
     }
     getPropertyConverterFn() {
         return 'convertMatrix';
@@ -516,7 +516,7 @@ class Matrix4 extends BaseType {
         ];
     }
     getTraitlet() {
-        return 'Matrix4(default=' + JSON.stringify(this.defaultValue) + ').tag(sync=True)';
+        return 'Matrix4(default_value=' + JSON.stringify(this.defaultValue) + ').tag(sync=True)';
     }
     getPropertyConverterFn() {
         return 'convertMatrix';
@@ -534,7 +534,7 @@ class Euler extends BaseType {
     }
 
     getTraitlet() {
-        return 'Euler(default=' + JSON.stringify(this.defaultValue) + ').tag(sync=True)';
+        return 'Euler(default_value=' + JSON.stringify(this.defaultValue) + ').tag(sync=True)';
     }
     getPropertyConverterFn() {
         return 'convertEuler';

js/scripts/templates/js_index.mustache

@@ -3,14 +3,6 @@
 // Date: {{ now }}
 //
 {{#if top_level}}
-// Entry point for the notebook bundle containing custom model definitions.
-//
-// Setup notebook base URL
-//
-// Some static assets may be required by the custom widget javascript. The base
-// url for the notebook is not known at build time and is therefore computed
-// dynamically.
-__webpack_public_path__ = document.querySelector('body').getAttribute('data-base-url') + 'nbextensions/jupyter-threejs/';
 
 // Export widget models and views, and the npm package version number.
 module.exports['version'] = require('../package.json').version;