Revert "Enable Python API in the JupyterLite deployment" (#685)

martinRenou · web-flow · commit 03f8567efa3e · 2025-02-12T19:01:58.000+01:00
Revert "Enable Python API in the JupyterLite deployment (#680)" This reverts commit 1611a56.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -25,7 +25,7 @@ jobs:
             yarn=3
 
       - name: Setup pip cache
-        uses: actions/cache@v4
+        uses: actions/cache@v2
         with:
           path: ~/.cache/pip
           key: pip-3.9-${{ hashFiles('package.json') }}
@@ -38,7 +38,7 @@ jobs:
         run: echo "::set-output name=dir::$(yarn cache dir)"
 
       - name: Setup yarn cache
-        uses: actions/cache@v4
+        uses: actions/cache@v2
         id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
         with:
           path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
@@ -47,7 +47,7 @@ jobs:
             yarn-
 
       - name: Setup OpenCascade build cache
-        uses: actions/cache@v4
+        uses: actions/cache@v2
         with:
           path: |
             packages/opencascade/lib/jupytercad.opencascade.js
@@ -84,7 +84,6 @@ jobs:
             python/jupytercad_core/dist/jupytercad*
             python/jupytercad_lab/dist/jupytercad*
             python/jupytercad_app/dist/jupytercad*
-            python/jupytercad/dist/jupytercad*
           if-no-files-found: error
 
   test_isolated:
@@ -149,7 +148,7 @@ jobs:
         shell: bash -l {0}
         run: |
           set -eux
-          cp ./jupytercad_core/dist/jupytercad*.whl ./jupytercad_lab/dist/jupytercad*.whl ./jupytercad_app/dist/jupytercad*.whl ./jupytercad/dist/jupytercad*.whl .
+          cp ./jupytercad_core/dist/jupytercad*.whl ./jupytercad_lab/dist/jupytercad*.whl ./jupytercad_app/dist/jupytercad*.whl .
           python -m pip install jupytercad*.whl
 
       - name: Install dependencies
@@ -160,7 +159,7 @@ jobs:
         run: jlpm install
 
       - name: Set up browser cache
-        uses: actions/cache@v4
+        uses: actions/cache@v3
         with:
           path: |
             ${{ github.workspace }}/pw-browsers
@@ -222,7 +221,6 @@ jobs:
             pip
             jupyterlite-core
             jupyterlite-xeus
-            jupyter_server
 
       - name: Download extension package
         uses: actions/download-artifact@v4
@@ -233,16 +231,15 @@ jobs:
         shell: bash -l {0}
         run: |
           set -eux
-          cp ./jupytercad_core/dist/jupytercad*.whl jupytercad_core-0.0.1-py3-none-any.whl
-          cp ./jupytercad_lab/dist/jupytercad*.whl jupytercad_lab-0.0.1-py3-none-any.whl
-          cp ./jupytercad_app/dist/jupytercad*.whl jupytercad_app-0.0.1-py3-none-any.whl
+          cp ./jupytercad_core/dist/jupytercad*.whl ./jupytercad_lab/dist/jupytercad*.whl ./jupytercad_app/dist/jupytercad*.whl .
+          python -m pip install jupytercad*.whl
 
       - name: Build the lite site
         shell: bash -l {0}
         working-directory: lite
         run: |
           set -eux
-          mkdir -p content && cp ../examples/*.jcad ../examples/*.STEP ../examples/*.stl ../examples/*.ipynb ./content
+          mkdir -p content && cp ../examples/*.jcad ../examples/*.STEP ../examples/*.stl ./content
           jupyter lite build --contents content --output-dir dist
 
       - name: Upload github-pages artifact
diff --git a/lite/environment.yml b/lite/environment.yml
@@ -1,18 +1,6 @@
 name: xeus-python-kernel
 channels:
-  - https://prefix.dev/emscripten-forge-dev
-  - https://prefix.dev/conda-forge
+  - https://repo.mamba.pm/emscripten-forge
+  - conda-forge
 dependencies:
-  - python=3.13
-  - pip
   - xeus-python
-  - requests
-  - jupyter_ydoc=2.1.5
-  - ypywidgets>=0.9.6,<0.10.0
-  - comm>=0.1.2,<0.2.0
-  - pydantic>=2,<3
-  - pip:
-      - yjs-widgets>=0.4,<0.5
-      - my-jupyter-shared-drive
-      - ../jupytercad_core-0.0.1-py3-none-any.whl
-      - ../jupytercad_lab-0.0.1-py3-none-any.whl
diff --git a/lite/jupyter-lite.json b/lite/jupyter-lite.json
@@ -1,4 +1,10 @@
 {
   "jupyter-lite-schema-version": 0,
-  "jupyter-config-data": {}
+  "jupyter-config-data": {
+    "appName": "My JupyterCAD App",
+    "disabledExtensions": [
+      "@jupyter/collaboration-extension",
+      "@jupyter/docprovider-extension"
+    ]
+  }
 }
diff --git a/packages/base/src/widget.ts b/packages/base/src/widget.ts
@@ -268,12 +268,12 @@ export class JupyterCadPanel extends SplitPanel {
 
         (this._consoleTracker.widgetAdded as any).emit(consolePanel);
         await consolePanel.sessionContext.ready;
-        this.addWidget(this._consoleView);
-        this.setRelativeSizes([2, 1]);
-        this._consoleOpened = true;
         await consolePanel.console.inject(
           `from jupytercad_lab import CadDocument\ndoc = CadDocument("${jcadPath}")`
         );
+        this.addWidget(this._consoleView);
+        this.setRelativeSizes([2, 1]);
+        this._consoleOpened = true;
         consolePanel.console.sessionContext.kernelChanged.connect((_, arg) => {
           if (!arg.newValue) {
             this.removeConsole();
diff --git a/python/jupytercad/pyproject.toml b/python/jupytercad/pyproject.toml
@@ -22,8 +22,6 @@ dependencies = [
   "jupytercad_core==3.0.1",
   "jupytercad_lab==3.0.1",
   "jupytercad_app==3.0.1",
-  "jupyter-collaboration>=3,<4",
-  "jupyterlab>=4.3,<5",
 ]
 dynamic = ["version"]
 license = {file = "LICENSE"}
diff --git a/python/jupytercad_app/package.json b/python/jupytercad_app/package.json
@@ -108,7 +108,7 @@
     "@lumino/widgets": "^2.0.0",
     "react": "^18.0.1",
     "yjs": "^13.5.40",
-    "yjs-widgets": "^0.4"
+    "yjs-widgets": "^0.3.7"
   },
   "devDependencies": {
     "@jupyterlab/builder": "^4.0.0",
diff --git a/python/jupytercad_core/jupytercad_core/__init__.py b/python/jupytercad_core/jupytercad_core/__init__.py
@@ -9,6 +9,8 @@
     warnings.warn("Importing 'jupytercad_core' outside a proper installation.")
     __version__ = "dev"
 
+from .handlers import setup_handlers
+
 
 def _jupyter_labextension_paths():
     return [{"src": "labextension", "dest": "@jupytercad/jupytercad-core"}]
@@ -22,7 +24,5 @@ def _load_jupyter_server_extension(server_app):
     server_app: jupyterlab.labapp.LabApp
         JupyterLab application instance
     """
-    from .handlers import setup_handlers
-
     setup_handlers(server_app.web_app)
     server_app.log.info("Registered jupytercad server extension")
diff --git a/python/jupytercad_core/pyproject.toml b/python/jupytercad_core/pyproject.toml
@@ -19,7 +19,9 @@ classifiers = [
   "Programming Language :: Python :: 3.12",
 ]
 dependencies = [
+  "jupyter_server>=2.0.6,<3",
   "jupyter_ydoc>=2,<4",
+  "jupyter-collaboration>=3.1.0,<4",
   "pydantic>=2,<3",
 ]
 dynamic = ["version", "description", "authors", "urls", "keywords"]
diff --git a/python/jupytercad_core/src/jcadplugin/modelfactory.ts b/python/jupytercad_core/src/jcadplugin/modelfactory.ts
@@ -19,7 +19,8 @@ export class JupyterCadJcadModelFactory
   /**
    * Whether the model is collaborative or not.
    */
-  readonly collaborative = true;
+  readonly collaborative =
+    document.querySelectorAll('[data-jupyter-lite-root]')[0] === undefined;
 
   /**
    * The name of the model.
diff --git a/python/jupytercad_core/src/stepplugin/modelfactory.ts b/python/jupytercad_core/src/stepplugin/modelfactory.ts
@@ -23,7 +23,8 @@ export class JupyterCadStepModelFactory
   /**
    * Whether the model is collaborative or not.
    */
-  readonly collaborative = true;
+  readonly collaborative =
+    document.querySelectorAll('[data-jupyter-lite-root]')[0] === undefined;
 
   /**
    * The name of the model.
diff --git a/python/jupytercad_core/src/stlplugin/modelfactory.ts b/python/jupytercad_core/src/stlplugin/modelfactory.ts
@@ -23,7 +23,8 @@ export class JupyterCadStlModelFactory
   /**
    * Whether the model is collaborative or not.
    */
-  readonly collaborative = true;
+  readonly collaborative =
+    document.querySelectorAll('[data-jupyter-lite-root]')[0] === undefined;
 
   /**
    * The name of the model.
diff --git a/python/jupytercad_lab/jupytercad_lab/notebook/cad_document.py b/python/jupytercad_lab/jupytercad_lab/notebook/cad_document.py
@@ -28,6 +28,7 @@
     ShapeMetadata,
     IAny,
 )
+from .utils import normalize_path
 
 logger = logging.getLogger(__file__)
 
@@ -71,7 +72,7 @@ def _path_to_comm(cls, filePath: Optional[str]) -> Dict:
         contentType = None
 
         if filePath is not None:
-            path = filePath
+            path = normalize_path(filePath)
             file_name = Path(path).name
             try:
                 ext = file_name.split(".")[1].lower()
diff --git a/python/jupytercad_lab/jupytercad_lab/notebook/utils.py b/python/jupytercad_lab/jupytercad_lab/notebook/utils.py
@@ -1,3 +1,4 @@
+import os
 from enum import Enum
 from urllib.parse import urljoin
 
@@ -14,3 +15,10 @@ def multi_urljoin(*parts) -> str:
         parts[0],
         "/".join(part for part in parts[1:]),
     )
+
+
+def normalize_path(path: str) -> str:
+    if os.path.isabs(path):
+        return path
+    else:
+        return os.path.abspath(os.path.join(os.getcwd(), path))
diff --git a/python/jupytercad_lab/package.json b/python/jupytercad_lab/package.json
@@ -68,7 +68,7 @@
     "@lumino/messaging": "^2.0.0",
     "@lumino/widgets": "^2.0.0",
     "react": "^18.0.1",
-    "yjs-widgets": "^0.4"
+    "yjs-widgets": "^0.3.7"
   },
   "devDependencies": {
     "@jupyterlab/builder": "^4.0.0",
@@ -119,7 +119,7 @@
       },
       "@jupyter/docprovider": {
         "singleton": true,
-        "bundled": true
+        "bundled": false
       },
       "yjs-widgets": {
         "singleton": true,
diff --git a/python/jupytercad_lab/pyproject.toml b/python/jupytercad_lab/pyproject.toml
@@ -25,7 +25,7 @@ classifiers = [
 dependencies = [
   "pycrdt",
   "ypywidgets>=0.9.0,<0.10.0",
-  "yjs-widgets>=0.4,<0.5",
+  "yjs-widgets>=0.3.7,<0.4",
   "comm>=0.1.2,<0.2.0",
   "pydantic>=2,<3",
   "jupytercad_core>=3.0.0a0,<4",
diff --git a/python/jupytercad_lab/src/notebookrenderer.ts b/python/jupytercad_lab/src/notebookrenderer.ts
@@ -15,19 +15,18 @@ import {
   JupyterCadModel
 } from '@jupytercad/schema';
 
-import { showErrorMessage } from '@jupyterlab/apputils';
 import {
   JupyterFrontEnd,
   JupyterFrontEndPlugin
 } from '@jupyterlab/application';
 import { Contents } from '@jupyterlab/services';
 import { MessageLoop } from '@lumino/messaging';
 import { Panel, Widget } from '@lumino/widgets';
+import * as Y from 'yjs';
 import {
   IJupyterYWidget,
   IJupyterYWidgetManager,
-  JupyterYModel,
-  JupyterYDoc
+  JupyterYModel
 } from 'yjs-widgets';
 import { Toolbar } from '@jupyterlab/ui-components';
 import { ConsolePanel } from '@jupyterlab/console';
@@ -95,6 +94,10 @@ export class YJupyterCADLuminoWidget extends Panel {
   private _buildWidget = (options: IOptions) => {
     const { commands, workerRegistry, model, externalCommands, tracker } =
       options;
+    // Ensure the model filePath is relevant with the shared model path.
+    if (model.sharedModel.getState('path')) {
+      model.filePath = model.sharedModel.getState('path') as string;
+    }
     const content = new JupyterCadPanel({
       model: model,
       workerRegistry: workerRegistry as IJCadWorkerRegistry
@@ -150,57 +153,17 @@ export const notebookRenderePlugin: JupyterFrontEndPlugin<void> = {
       console.error('Missing IJupyterYWidgetManager token!');
       return;
     }
-
+    if (!drive) {
+      console.error('Missing ICollaborativeDrive token!');
+      return;
+    }
     class YJupyterCADModelFactory extends YJupyterCADModel {
-      protected async initialize(commMetadata: {
-        [key: string]: any;
-      }): Promise<void> {
+      ydocFactory(commMetadata: ICommMetadata): Y.Doc {
         const { path, format, contentType } = commMetadata;
         const fileFormat = format as Contents.FileFormat;
 
-        if (!drive) {
-          showErrorMessage(
-            'Error using the JupyterCAD Python API',
-            'You cannot use the JupyterCAD Python API without a collaborative drive. You need to install a package providing collaboration features (e.g. jupyter-collaboration).'
-          );
-          throw new Error(
-            'Failed to create the YDoc without a collaborative drive'
-          );
-        }
-
-        // The path of the project is relative to the path of the notebook
-        let currentWidgetPath = '';
-        const currentWidget = app.shell.currentWidget;
-        if (
-          currentWidget instanceof NotebookPanel ||
-          currentWidget instanceof ConsolePanel
-        ) {
-          currentWidgetPath = currentWidget.sessionContext.path;
-        }
-
-        let localPath = '';
-        if (path) {
-          localPath = PathExt.join(PathExt.dirname(currentWidgetPath), path);
-
-          // If the file does not exist yet, create it
-          try {
-            await app.serviceManager.contents.get(localPath);
-          } catch (e) {
-            await app.serviceManager.contents.save(localPath, {
-              content: btoa('{}'),
-              format: 'base64'
-            });
-          }
-        } else {
-          // If the user did not provide a path, do not create
-          localPath = PathExt.join(
-            PathExt.dirname(currentWidgetPath),
-            'unsaved_project'
-          );
-        }
-
         const sharedModel = drive!.sharedModelFactory.createNew({
-          path: localPath,
+          path,
           format: fileFormat,
           contentType,
           collaborative: true
@@ -211,10 +174,28 @@ export const notebookRenderePlugin: JupyterFrontEndPlugin<void> = {
         });
 
         this.jupyterCADModel.contentsManager = app.serviceManager.contents;
-        this.jupyterCADModel.filePath = localPath;
 
-        this.ydoc = this.jupyterCADModel.sharedModel.ydoc;
-        this.sharedModel = new JupyterYDoc(commMetadata, this.ydoc);
+        if (!sharedModel) {
+          // The path of the project is set to the path of the notebook, to be able to
+          // add local geoJSON/shape file in a "file-less" project.
+          let currentWidgetPath: string | undefined = undefined;
+          const currentWidget = app.shell.currentWidget;
+          if (
+            currentWidget instanceof NotebookPanel ||
+            currentWidget instanceof ConsolePanel
+          ) {
+            currentWidgetPath = currentWidget.sessionContext.path;
+          }
+
+          if (currentWidgetPath) {
+            this.jupyterCADModel.filePath = PathExt.join(
+              PathExt.dirname(currentWidgetPath),
+              'unsaved_project'
+            );
+          }
+        }
+
+        return this.jupyterCADModel.sharedModel.ydoc;
       }
     }
 
diff --git a/requirements-build.txt b/requirements-build.txt
diff --git a/scripts/build_packages.py b/scripts/build_packages.py
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,10 @@`
`1`	`1`	`{`
`2`	`2`	`"jupyter-lite-schema-version": 0,`
`3`		`- "jupyter-config-data": {}`
	`3`	`+ "jupyter-config-data": {`
	`4`	`+ "appName": "My JupyterCAD App",`
	`5`	`+ "disabledExtensions": [`
	`6`	`+ "@jupyter/collaboration-extension",`
	`7`	`+ "@jupyter/docprovider-extension"`
	`8`	`+ ]`
	`9`	`+ }`
`4`	`10`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,8 +22,6 @@ dependencies = [`
`22`	`22`	`"jupytercad_core==3.0.1",`
`23`	`23`	`"jupytercad_lab==3.0.1",`
`24`	`24`	`"jupytercad_app==3.0.1",`
`25`		`- "jupyter-collaboration>=3,<4",`
`26`		`- "jupyterlab>=4.3,<5",`
`27`	`25`	`]`
`28`	`26`	`dynamic = ["version"]`
`29`	`27`	`license = {file = "LICENSE"}`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,9 @@ classifiers = [`
`19`	`19`	`"Programming Language :: Python :: 3.12",`
`20`	`20`	`]`
`21`	`21`	`dependencies = [`
	`22`	`+ "jupyter_server>=2.0.6,<3",`
`22`	`23`	`"jupyter_ydoc>=2,<4",`
	`24`	`+ "jupyter-collaboration>=3.1.0,<4",`
`23`	`25`	`"pydantic>=2,<3",`
`24`	`26`	`]`
`25`	`27`	`dynamic = ["version", "description", "authors", "urls", "keywords"]`