@jupyterlite/pyodide-kernel 0.6.0-alpha.5 → 0.6.0-beta.0

package/lib/kernel.d.ts

@@ -1,3 +1,4 @@
+import { ILogPayload } from '@jupyterlab/logconsole';
 import { Contents, KernelMessage } from '@jupyterlab/services';
 import { BaseKernel, IKernel } from '@jupyterlite/kernel';
 import { IPyodideWorkerKernel } from './tokens';
@@ -37,6 +38,7 @@ export declare class PyodideKernel extends BaseKernel implements IKernel {
      * A promise that is fulfilled when the kernel is ready.
      */
     get ready(): Promise<void>;
+    private _processLogMessage;
     /**
      * Process a message coming from the pyodide web worker.
      *
@@ -108,10 +110,12 @@ export declare class PyodideKernel extends BaseKernel implements IKernel {
      */
     inputReply(content: KernelMessage.IInputReplyMsg['content']): Promise<void>;
     private _contentsManager;
+    private _logger;
     private _contentsProcessor;
     private _worker;
     private _remoteKernel;
     private _ready;
+    private _inputDelegate;
 }
 /**
  * A namespace for PyodideKernel statics.
@@ -159,5 +163,12 @@ export declare namespace PyodideKernel {
          * identify the browsing context from which the request originated.
          */
         browsingContextId?: string;
+        /**
+         * The logger function to use for logging messages from the kernel.
+         */
+        logger?: (options: {
+            payload: ILogPayload;
+            kernelId: string;
+        }) => void;
     }
 }

package/lib/kernel.js

@@ -17,9 +17,11 @@ export class PyodideKernel extends BaseKernel {
     constructor(options) {
         super(options);
         this._ready = new PromiseDelegate();
+        this._inputDelegate = new PromiseDelegate();
         this._worker = this.initWorker(options);
         this._remoteKernel = this.initRemote(options);
         this._contentsManager = options.contentsManager;
+        this._logger = options.logger || (() => { });
     }
     /**
      * Load the worker.
@@ -52,6 +54,7 @@ export class PyodideKernel extends BaseKernel {
         let remote;
         if (crossOriginIsolated) {
             remote = coincident(this._worker);
+            remote.processLogMessage = this._processLogMessage.bind(this);
             remote.processWorkerMessage = this._processWorkerMessage.bind(this);
             // The coincident worker uses its own filesystem API:
             remote.processDriveRequest = async (data) => {
@@ -65,20 +68,41 @@ export class PyodideKernel extends BaseKernel {
                 }
                 return await this._contentsProcessor.processDriveRequest(data);
             };
+            remote.processStdinRequest =
+                async (content) => {
+                    const msg = {
+                        type: 'input_request',
+                        content,
+                    };
+                    this._processWorkerMessage(msg);
+                    this._inputDelegate = new PromiseDelegate();
+                    return await this._inputDelegate.promise;
+                };
         }
         else {
             remote = wrap(this._worker);
-            // we use the normal postMessage mechanism
+            // we use the normal postMessage mechanism in the case of comlink
             this._worker.addEventListener('message', (ev) => {
-                var _a;
+                var _a, _b;
                 if (typeof ((_a = ev === null || ev === void 0 ? void 0 : ev.data) === null || _a === void 0 ? void 0 : _a._kernelMessage) !== 'undefined') {
                     // only process non comlink messages
                     this._processWorkerMessage(ev.data._kernelMessage);
                 }
+                else if (typeof ((_b = ev === null || ev === void 0 ? void 0 : ev.data) === null || _b === void 0 ? void 0 : _b._logMessage) !== 'undefined') {
+                    this._processLogMessage(ev.data._logMessage);
+                }
             });
         }
         const remoteOptions = this.initRemoteOptions(options);
-        remote.initialize(remoteOptions).then(this._ready.resolve.bind(this._ready));
+        remote
+            .initialize(remoteOptions)
+            .then(this._ready.resolve.bind(this._ready))
+            .catch((err) => {
+            this._logger({
+                payload: { type: 'text', level: 'critical', data: err.message },
+                kernelId: this.id,
+            });
+        });
         return remote;
     }
     initRemoteOptions(options) {
@@ -98,6 +122,7 @@ export class PyodideKernel extends BaseKernel {
             mountDrive: options.mountDrive,
             loadPyodideOptions: options.loadPyodideOptions || {},
             browsingContextId: options.browsingContextId,
+            kernelId: this.id,
         };
     }
     /**
@@ -117,6 +142,9 @@ export class PyodideKernel extends BaseKernel {
     get ready() {
         return this._ready.promise;
     }
+    _processLogMessage(payload) {
+        this._logger({ payload, kernelId: this.id });
+    }
     /**
      * Process a message coming from the pyodide web worker.
      *
@@ -285,6 +313,7 @@ export class PyodideKernel extends BaseKernel {
      * @param content - The content of the reply.
      */
     async inputReply(content) {
-        return await this._remoteKernel.inputReply(content, this.parent);
+        const value = 'value' in content ? content.value : undefined;
+        this._inputDelegate.resolve(value);
     }
 }

package/lib/tokens.d.ts

@@ -20,15 +20,44 @@ export interface IPyodideWorkerKernel extends IWorkerKernel {
      * @param data
      */
     processDriveRequest<T extends TDriveMethod>(data: TDriveRequest<T>): TDriveResponse<T>;
+}
+/**
+ * An interface for Pyodide workers that use comlink.
+ */
+export interface IComlinkPyodideKernel extends IPyodideWorkerKernel {
+    /**
+     * Register a callback for handling messages from the worker.
+     */
+    registerWorkerMessageCallback(callback: (msg: any) => void): void;
+    /**
+     * Register a callback for handling log messages from the worker.
+     */
+    registerLogMessageCallback(callback: (msg: any) => void): void;
+}
+/**
+ * An interface for Coincident Pyodide workers that include extra SharedArrayBuffer
+ * functionality.
+ */
+export interface ICoincidentPyodideWorkerKernel extends IPyodideWorkerKernel {
+    /**
+     * Process a log message
+     * @param msg
+     */
+    processLogMessage(msg: any): void;
     /**
      * Process worker message
      * @param msg
      */
     processWorkerMessage(msg: any): void;
     /**
-     * Register a callback for handling messages from the worker.
+     * Process stdin request, blocking until the reply is received.
+     * This is sync for the web worker, async for the UI thread.
+     * @param inputRequest
      */
-    registerCallback(callback: (msg: any) => void): void;
+    processStdinRequest(content: {
+        prompt: string;
+        password: boolean;
+    }): string | undefined;
 }
 /**
  * Deprecated.
@@ -84,5 +113,9 @@ export declare namespace IPyodideWorkerKernel {
             lockFileURL: string;
             packages: string[];
         };
+        /**
+         * The kernel id.
+         */
+        kernelId?: string;
     }
 }

package/lib/worker.d.ts

@@ -1,8 +1,9 @@
 import type Pyodide from 'pyodide';
-import type { DriveFS } from '@jupyterlite/contents';
+import type { ILogPayload } from '@jupyterlab/logconsole';
 import { KernelMessage } from '@jupyterlab/services';
+import type { DriveFS } from '@jupyterlite/contents';
 import type { IPyodideWorkerKernel } from './tokens';
-export declare class PyodideRemoteKernel {
+export declare abstract class PyodideRemoteKernel {
     constructor();
     /**
      * Accept the URLs from the host
@@ -29,9 +30,16 @@ export declare class PyodideRemoteKernel {
     formatResult(res: any): any;
     /**
      * Register the callback function to send messages from the worker back to the main thread.
+     *
+     * @param callback the callback to register
+     */
+    registerWorkerMessageCallback(callback: (msg: any) => void): void;
+    /**
+     * Register the callback function to log messages from the worker back to the main thread.
+     *
      * @param callback the callback to register
      */
-    registerCallback(callback: (msg: any) => void): void;
+    registerLogMessageCallback(callback: (msg: any) => void): void;
     /**
      * Makes sure pyodide is ready before continuing, and cache the parent message.
      */
@@ -97,14 +105,15 @@ export declare class PyodideRemoteKernel {
      */
     inputReply(content: any, parent: any): Promise<void>;
     /**
-     * Send a input request to the front-end.
+     * Send a input request to the front-end and block until the reply is received.
      *
      * @param prompt the text to show at the prompt
      * @param password Is the request for a password?
+     * @returns String value from the input reply message, or undefined if there is none.
      */
-    sendInputRequest(prompt: string, password: boolean): Promise<void>;
-    getpass(prompt: string): Promise<any>;
-    input(prompt: string): Promise<any>;
+    protected abstract sendInputRequest(prompt: string, password: boolean): string | undefined;
+    getpass(prompt: string): string | undefined;
+    input(prompt: string): string | undefined;
     /**
      * Send a comm message to the front-end.
      *
@@ -133,7 +142,7 @@ export declare class PyodideRemoteKernel {
     protected _interpreter: any;
     protected _stdout_stream: any;
     protected _stderr_stream: any;
-    protected _resolveInputReply: any;
     protected _driveFS: DriveFS | null;
     protected _sendWorkerMessage: (msg: any) => void;
+    protected _logMessage: (msg: ILogPayload) => void;
 }

package/lib/worker.js

@@ -13,6 +13,7 @@ export class PyodideRemoteKernel {
         this._driveName = '';
         this._driveFS = null;
         this._sendWorkerMessage = () => { };
+        this._logMessage = () => { };
         this._initialized = new Promise((resolve, reject) => {
             this._initializer = { resolve, reject };
         });
@@ -56,6 +57,23 @@ export class PyodideRemoteKernel {
             indexURL: indexUrl,
             ...options.loadPyodideOptions,
         });
+        const log = (msg) => {
+            this._logMessage({ type: 'text', level: 'info', data: msg });
+        };
+        const err = (msg) => {
+            this._logMessage({ type: 'text', level: 'critical', data: msg });
+        };
+        // Workaround for being able to get information about packages being loaded by Pyodide
+        // See discussion in https://github.com/pyodide/pyodide/discussions/5512
+        const origLoadPackage = this._pyodide.loadPackage;
+        this._pyodide.loadPackage = (pkgs, options) => origLoadPackage(pkgs, {
+            // Use custom callbacks to surface messages from Pyodide
+            messageCallback: (msg) => log(msg),
+            errorCallback: (msg) => {
+                err(msg);
+            },
+            ...options,
+        });
     }
     async initPackageManager(options) {
         if (!this._options) {
@@ -168,11 +186,20 @@ export class PyodideRemoteKernel {
     }
     /**
      * Register the callback function to send messages from the worker back to the main thread.
+     *
      * @param callback the callback to register
      */
-    registerCallback(callback) {
+    registerWorkerMessageCallback(callback) {
         this._sendWorkerMessage = callback;
     }
+    /**
+     * Register the callback function to log messages from the worker back to the main thread.
+     *
+     * @param callback the callback to register
+     */
+    registerLogMessageCallback(callback) {
+        this._logMessage = callback;
+    }
     /**
      * Makes sure pyodide is ready before continuing, and cache the parent message.
      */
@@ -358,43 +385,16 @@ export class PyodideRemoteKernel {
      * @param content The incoming message with the reply
      */
     async inputReply(content, parent) {
-        await this.setup(parent);
-        this._resolveInputReply(content);
+        // Should never be called as input_reply messages are returned via service worker
+        // or SharedArrayBuffer.
     }
-    /**
-     * Send a input request to the front-end.
-     *
-     * @param prompt the text to show at the prompt
-     * @param password Is the request for a password?
-     */
-    async sendInputRequest(prompt, password) {
-        const content = {
-            prompt,
-            password,
-        };
-        this._sendWorkerMessage({
-            type: 'input_request',
-            parentHeader: this.formatResult(this._kernel._parent_header)['header'],
-            content,
-        });
-    }
-    async getpass(prompt) {
+    getpass(prompt) {
         prompt = typeof prompt === 'undefined' ? '' : prompt;
-        await this.sendInputRequest(prompt, true);
-        const replyPromise = new Promise((resolve) => {
-            this._resolveInputReply = resolve;
-        });
-        const result = await replyPromise;
-        return result['value'];
+        return this.sendInputRequest(prompt, true);
     }
-    async input(prompt) {
+    input(prompt) {
         prompt = typeof prompt === 'undefined' ? '' : prompt;
-        await this.sendInputRequest(prompt, false);
-        const replyPromise = new Promise((resolve) => {
-            this._resolveInputReply = resolve;
-        });
-        const result = await replyPromise;
-        return result['value'];
+        return this.sendInputRequest(prompt, false);
     }
     /**
      * Send a comm message to the front-end.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyterlite/pyodide-kernel",
-  "version": "0.6.0-alpha.5",
+  "version": "0.6.0-beta.0",
   "description": "JupyterLite - Pyodide Kernel",
   "homepage": "https://github.com/jupyterlite/pyodide-kernel",
   "bugs": {
@@ -51,6 +51,7 @@
   },
   "dependencies": {
     "@jupyterlab/coreutils": "^6.4.0",
+    "@jupyterlab/logconsole": "^4.4.0",
     "@jupyterlite/contents": "^0.6.0-alpha.8",
     "@jupyterlite/kernel": "^0.6.0-alpha.8",
     "coincident": "^1.2.3",
@@ -68,8 +69,8 @@
   },
   "pyodide-kernel": {
     "packages": {
-      "py/pyodide-kernel": "0.6.0a5",
-      "py/piplite": "0.6.0a5",
+      "py/pyodide-kernel": "0.6.0b0",
+      "py/piplite": "0.6.0b0",
       "py/ipykernel": "6.9.2",
       "py/widgetsnbextension3/widgetsnbextension": "3.6.999",
       "py/widgetsnbextension4/widgetsnbextension": "4.0.999"

package/pypi/all.json

@@ -5,19 +5,19 @@
         {
           "comment_text": "",
           "digests": {
-            "md5": "459eaf3dcda3c01862712d9fd835001a",
-            "sha256": "72c335b14858d4434942862254e657b328d1d7da6630bea9950d85893bafa27a"
+            "md5": "f37d584c1bc7c770b7c4d10c267474ac",
+            "sha256": "c1e200d95949b127b2c2778f2359c8419d5d5f2b9da38f088ead1cdc6cf14dbd"
           },
           "downloads": -1,
           "filename": "ipykernel-6.9.2-py3-none-any.whl",
           "has_sig": false,
-          "md5_digest": "459eaf3dcda3c01862712d9fd835001a",
+          "md5_digest": "f37d584c1bc7c770b7c4d10c267474ac",
           "packagetype": "bdist_wheel",
           "python_version": "py3",
           "requires_python": ">=3.10",
           "size": 2731,
-          "upload_time": "2025-04-15T15:09:15.435760Z",
-          "upload_time_iso_8601": "2025-04-15T15:09:15.435760Z",
+          "upload_time": "2025-05-12T16:45:30.604864Z",
+          "upload_time_iso_8601": "2025-05-12T16:45:30.604864Z",
           "url": "./ipykernel-6.9.2-py3-none-any.whl",
           "yanked": false,
           "yanked_reason": null
@@ -27,24 +27,24 @@
   },
   "piplite": {
     "releases": {
-      "0.6.0a5": [
+      "0.6.0b0": [
         {
           "comment_text": "",
           "digests": {
-            "md5": "a6cda0b176cf541573a6ed0aba094400",
-            "sha256": "32d584607eee32c0cbacc41435fe13255bbda99620584dc09834dd2275905ce9"
+            "md5": "08ae0da8c0bd9686fe1b80518599bafe",
+            "sha256": "2a8748fc0363fd1c1b8058b3a4bc8efd64521b0cacd3337685c7b40170769f9b"
           },
           "downloads": -1,
-          "filename": "piplite-0.6.0a5-py3-none-any.whl",
+          "filename": "piplite-0.6.0b0-py3-none-any.whl",
           "has_sig": false,
-          "md5_digest": "a6cda0b176cf541573a6ed0aba094400",
+          "md5_digest": "08ae0da8c0bd9686fe1b80518599bafe",
           "packagetype": "bdist_wheel",
           "python_version": "py3",
           "requires_python": "<3.12,>=3.11",
           "size": 7253,
-          "upload_time": "2025-04-15T15:09:15.435760Z",
-          "upload_time_iso_8601": "2025-04-15T15:09:15.435760Z",
-          "url": "./piplite-0.6.0a5-py3-none-any.whl",
+          "upload_time": "2025-05-12T16:45:30.604864Z",
+          "upload_time_iso_8601": "2025-05-12T16:45:30.604864Z",
+          "url": "./piplite-0.6.0b0-py3-none-any.whl",
           "yanked": false,
           "yanked_reason": null
         }
@@ -53,24 +53,24 @@
   },
   "pyodide-kernel": {
     "releases": {
-      "0.6.0a5": [
+      "0.6.0b0": [
         {
           "comment_text": "",
           "digests": {
-            "md5": "ccf6951cf6a5c53eebdf8e633551ea4e",
-            "sha256": "81e5a4eaa6e0d92b144e18b52a1c9295e89110ff7bf1d7c4853d52984b9ba8ee"
+            "md5": "ebb84e59c120ad300423b3da42f662da",
+            "sha256": "7c12b90f88cbf4c6b415082e930483913a3f15968fbc485d9275409de2eeeba3"
           },
           "downloads": -1,
-          "filename": "pyodide_kernel-0.6.0a5-py3-none-any.whl",
+          "filename": "pyodide_kernel-0.6.0b0-py3-none-any.whl",
           "has_sig": false,
-          "md5_digest": "ccf6951cf6a5c53eebdf8e633551ea4e",
+          "md5_digest": "ebb84e59c120ad300423b3da42f662da",
           "packagetype": "bdist_wheel",
           "python_version": "py3",
           "requires_python": "<3.12,>=3.11",
-          "size": 11415,
-          "upload_time": "2025-04-15T15:09:15.434760Z",
-          "upload_time_iso_8601": "2025-04-15T15:09:15.434760Z",
-          "url": "./pyodide_kernel-0.6.0a5-py3-none-any.whl",
+          "size": 11412,
+          "upload_time": "2025-05-12T16:45:30.604864Z",
+          "upload_time_iso_8601": "2025-05-12T16:45:30.604864Z",
+          "url": "./pyodide_kernel-0.6.0b0-py3-none-any.whl",
           "yanked": false,
           "yanked_reason": null
         }
@@ -83,19 +83,19 @@
         {
           "comment_text": "",
           "digests": {
-            "md5": "2288aa58b161ae3dd5d590b364dce5ce",
-            "sha256": "3389e73e8176ea1306788adff5d12b1559863f32851e668a9690494922633c30"
+            "md5": "11920654c4118e8c2f96ffe6a85529cc",
+            "sha256": "52c9995fb48f6576e73004de88c4a8c4e00b02166704735fef7041b373699df9"
           },
           "downloads": -1,
           "filename": "widgetsnbextension-3.6.999-py3-none-any.whl",
           "has_sig": false,
-          "md5_digest": "2288aa58b161ae3dd5d590b364dce5ce",
+          "md5_digest": "11920654c4118e8c2f96ffe6a85529cc",
           "packagetype": "bdist_wheel",
           "python_version": "py3",
           "requires_python": "<3.12,>=3.11",
           "size": 2369,
-          "upload_time": "2025-04-15T15:09:15.435760Z",
-          "upload_time_iso_8601": "2025-04-15T15:09:15.435760Z",
+          "upload_time": "2025-05-12T16:45:30.605864Z",
+          "upload_time_iso_8601": "2025-05-12T16:45:30.605864Z",
           "url": "./widgetsnbextension-3.6.999-py3-none-any.whl",
           "yanked": false,
           "yanked_reason": null
@@ -105,19 +105,19 @@
         {
           "comment_text": "",
           "digests": {
-            "md5": "ddd85a7cd15729c14b6387a0723793dc",
-            "sha256": "a22acd9d9921b2c542bd98ce33ab8ca6317898aee8f819bef57b41b779981a40"
+            "md5": "5bc0ab1125788cfdee56177b5fd759ee",
+            "sha256": "90f5943bfac451c71c60232fc6d9e3435775538de12006b8843dd27d93c07936"
           },
           "downloads": -1,
           "filename": "widgetsnbextension-4.0.999-py3-none-any.whl",
           "has_sig": false,
-          "md5_digest": "ddd85a7cd15729c14b6387a0723793dc",
+          "md5_digest": "5bc0ab1125788cfdee56177b5fd759ee",
           "packagetype": "bdist_wheel",
           "python_version": "py3",
           "requires_python": "<3.12,>=3.11",
           "size": 2370,
-          "upload_time": "2025-04-15T15:09:15.435760Z",
-          "upload_time_iso_8601": "2025-04-15T15:09:15.435760Z",
+          "upload_time": "2025-05-12T16:45:30.605864Z",
+          "upload_time_iso_8601": "2025-05-12T16:45:30.605864Z",
           "url": "./widgetsnbextension-4.0.999-py3-none-any.whl",
           "yanked": false,
           "yanked_reason": null