@jupyterlite/pyodide-kernel 0.0.2

package/lib/_pypi.d.ts

@@ -0,0 +1,6 @@
+export * as allJSONUrl from '../pypi/all.json';
+export * as ipykernelWheelUrl from '../pypi/ipykernel-6.9.2-py3-none-any.whl';
+export * as pipliteWheelUrl from '../pypi/piplite-0.0.2-py3-none-any.whl';
+export * as pyodide_kernelWheelUrl from '../pypi/pyodide_kernel-0.0.2-py3-none-any.whl';
+export * as widgetsnbextensionWheelUrl from '../pypi/widgetsnbextension-3.6.0-py3-none-any.whl';
+export * as widgetsnbextensionWheelUrl1 from '../pypi/widgetsnbextension-4.0.2-py3-none-any.whl';

package/lib/_pypi.js

@@ -0,0 +1,7 @@
+// this file is autogenerated from the wheels described in ../package.json
+export * as allJSONUrl from '../pypi/all.json';
+export * as ipykernelWheelUrl from '../pypi/ipykernel-6.9.2-py3-none-any.whl';
+export * as pipliteWheelUrl from '../pypi/piplite-0.0.2-py3-none-any.whl';
+export * as pyodide_kernelWheelUrl from '../pypi/pyodide_kernel-0.0.2-py3-none-any.whl';
+export * as widgetsnbextensionWheelUrl from '../pypi/widgetsnbextension-3.6.0-py3-none-any.whl';
+export * as widgetsnbextensionWheelUrl1 from '../pypi/widgetsnbextension-4.0.2-py3-none-any.whl';

package/lib/comlink.worker.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/comlink.worker.js

@@ -0,0 +1,9 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+/**
+ * A WebWorker entrypoint that uses comlink to handle postMessage details
+ */
+import { expose } from 'comlink';
+import { PyodideRemoteKernel } from './worker';
+const worker = new PyodideRemoteKernel();
+expose(worker);

package/lib/index.d.ts

@@ -0,0 +1,5 @@
+export * from './_pypi';
+export * from './comlink.worker';
+export * from './kernel';
+export * from './tokens';
+export * from './worker';

package/lib/index.js

@@ -0,0 +1,7 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+export * from './_pypi';
+export * from './comlink.worker';
+export * from './kernel';
+export * from './tokens';
+export * from './worker';

package/lib/kernel.d.ts

@@ -0,0 +1,132 @@
+import { KernelMessage } from '@jupyterlab/services';
+import { BaseKernel, IKernel } from '@jupyterlite/kernel';
+import { IPyodideWorkerKernel } from './tokens';
+/**
+ * A kernel that executes Python code with Pyodide.
+ */
+export declare class PyodideKernel extends BaseKernel implements IKernel {
+    /**
+     * Instantiate a new PyodideKernel
+     *
+     * @param options The instantiation options for a new PyodideKernel
+     */
+    constructor(options: PyodideKernel.IOptions);
+    /**
+     * Load the worker.
+     *
+     * ### Note
+     *
+     * Subclasses must implement this typographically almost _exactly_ for
+     * webpack to find it.
+     */
+    protected initWorker(options: PyodideKernel.IOptions): Worker;
+    protected initRemote(options: PyodideKernel.IOptions): Promise<void>;
+    protected initRemoteOptions(options: PyodideKernel.IOptions): IPyodideWorkerKernel.IOptions;
+    /**
+     * Dispose the kernel.
+     */
+    dispose(): void;
+    /**
+     * A promise that is fulfilled when the kernel is ready.
+     */
+    get ready(): Promise<void>;
+    /**
+     * Process a message coming from the pyodide web worker.
+     *
+     * @param msg The worker message to process.
+     */
+    private _processWorkerMessage;
+    /**
+     * Handle a kernel_info_request message
+     */
+    kernelInfoRequest(): Promise<KernelMessage.IInfoReplyMsg['content']>;
+    /**
+     * Handle an `execute_request` message
+     *
+     * @param msg The parent message.
+     */
+    executeRequest(content: KernelMessage.IExecuteRequestMsg['content']): Promise<KernelMessage.IExecuteReplyMsg['content']>;
+    /**
+     * Handle an complete_request message
+     *
+     * @param msg The parent message.
+     */
+    completeRequest(content: KernelMessage.ICompleteRequestMsg['content']): Promise<KernelMessage.ICompleteReplyMsg['content']>;
+    /**
+     * Handle an `inspect_request` message.
+     *
+     * @param content - The content of the request.
+     *
+     * @returns A promise that resolves with the response message.
+     */
+    inspectRequest(content: KernelMessage.IInspectRequestMsg['content']): Promise<KernelMessage.IInspectReplyMsg['content']>;
+    /**
+     * Handle an `is_complete_request` message.
+     *
+     * @param content - The content of the request.
+     *
+     * @returns A promise that resolves with the response message.
+     */
+    isCompleteRequest(content: KernelMessage.IIsCompleteRequestMsg['content']): Promise<KernelMessage.IIsCompleteReplyMsg['content']>;
+    /**
+     * Handle a `comm_info_request` message.
+     *
+     * @param content - The content of the request.
+     *
+     * @returns A promise that resolves with the response message.
+     */
+    commInfoRequest(content: KernelMessage.ICommInfoRequestMsg['content']): Promise<KernelMessage.ICommInfoReplyMsg['content']>;
+    /**
+     * Send an `comm_open` message.
+     *
+     * @param msg - The comm_open message.
+     */
+    commOpen(msg: KernelMessage.ICommOpenMsg): Promise<void>;
+    /**
+     * Send an `comm_msg` message.
+     *
+     * @param msg - The comm_msg message.
+     */
+    commMsg(msg: KernelMessage.ICommMsgMsg): Promise<void>;
+    /**
+     * Send an `comm_close` message.
+     *
+     * @param close - The comm_close message.
+     */
+    commClose(msg: KernelMessage.ICommCloseMsg): Promise<void>;
+    /**
+     * Send an `input_reply` message.
+     *
+     * @param content - The content of the reply.
+     */
+    inputReply(content: KernelMessage.IInputReplyMsg['content']): Promise<void>;
+    private _worker;
+    private _remoteKernel;
+    private _ready;
+}
+/**
+ * A namespace for PyodideKernel statics.
+ */
+export declare namespace PyodideKernel {
+    /**
+     * The instantiation options for a Pyodide kernel
+     */
+    interface IOptions extends IKernel.IOptions {
+        /**
+         * The URL to fetch Pyodide.
+         */
+        pyodideUrl: string;
+        /**
+         * The URLs from which to attempt PyPI API requests
+         */
+        pipliteUrls: string[];
+        /**
+         * Do not try pypi.org if `piplite.install` fails against local URLs
+         */
+        disablePyPIFallback: boolean;
+        /**
+         * Whether or not to mount the Emscripten drive
+         */
+        mountDrive: boolean;
+    }
+}

package/lib/kernel.js

@@ -0,0 +1,245 @@
+import { PromiseDelegate } from '@lumino/coreutils';
+import { PageConfig } from '@jupyterlab/coreutils';
+import { BaseKernel } from '@jupyterlite/kernel';
+import { wrap } from 'comlink';
+import { allJSONUrl, pipliteWheelUrl } from './_pypi';
+/**
+ * A kernel that executes Python code with Pyodide.
+ */
+export class PyodideKernel extends BaseKernel {
+    /**
+     * Instantiate a new PyodideKernel
+     *
+     * @param options The instantiation options for a new PyodideKernel
+     */
+    constructor(options) {
+        super(options);
+        this._ready = new PromiseDelegate();
+        this._worker = this.initWorker(options);
+        this._worker.onmessage = (e) => this._processWorkerMessage(e.data);
+        this._remoteKernel = wrap(this._worker);
+        this.initRemote(options);
+    }
+    /**
+     * Load the worker.
+     *
+     * ### Note
+     *
+     * Subclasses must implement this typographically almost _exactly_ for
+     * webpack to find it.
+     */
+    initWorker(options) {
+        return new Worker(new URL('./comlink.worker.js', import.meta.url), {
+            type: 'module',
+        });
+    }
+    async initRemote(options) {
+        const remoteOptions = this.initRemoteOptions(options);
+        await this._remoteKernel.initialize(remoteOptions);
+        this._ready.resolve();
+    }
+    initRemoteOptions(options) {
+        const { pyodideUrl } = options;
+        const indexUrl = pyodideUrl.slice(0, pyodideUrl.lastIndexOf('/') + 1);
+        const baseUrl = PageConfig.getBaseUrl();
+        const pipliteUrls = [...(options.pipliteUrls || []), allJSONUrl.default];
+        const disablePyPIFallback = !!options.disablePyPIFallback;
+        return {
+            baseUrl,
+            pyodideUrl,
+            indexUrl,
+            pipliteWheelUrl: pipliteWheelUrl.default,
+            pipliteUrls,
+            disablePyPIFallback,
+            location: this.location,
+            mountDrive: options.mountDrive,
+        };
+    }
+    /**
+     * Dispose the kernel.
+     */
+    dispose() {
+        if (this.isDisposed) {
+            return;
+        }
+        this._worker.terminate();
+        this._worker = null;
+        super.dispose();
+    }
+    /**
+     * A promise that is fulfilled when the kernel is ready.
+     */
+    get ready() {
+        return this._ready.promise;
+    }
+    /**
+     * Process a message coming from the pyodide web worker.
+     *
+     * @param msg The worker message to process.
+     */
+    _processWorkerMessage(msg) {
+        var _a, _b, _c, _d, _e, _f, _g;
+        if (!msg.type) {
+            return;
+        }
+        switch (msg.type) {
+            case 'stream': {
+                const bundle = (_a = msg.bundle) !== null && _a !== void 0 ? _a : { name: 'stdout', text: '' };
+                this.stream(bundle, msg.parentHeader);
+                break;
+            }
+            case 'input_request': {
+                const bundle = (_b = msg.content) !== null && _b !== void 0 ? _b : { prompt: '', password: false };
+                this.inputRequest(bundle, msg.parentHeader);
+                break;
+            }
+            case 'display_data': {
+                const bundle = (_c = msg.bundle) !== null && _c !== void 0 ? _c : { data: {}, metadata: {}, transient: {} };
+                this.displayData(bundle, msg.parentHeader);
+                break;
+            }
+            case 'update_display_data': {
+                const bundle = (_d = msg.bundle) !== null && _d !== void 0 ? _d : { data: {}, metadata: {}, transient: {} };
+                this.updateDisplayData(bundle, msg.parentHeader);
+                break;
+            }
+            case 'clear_output': {
+                const bundle = (_e = msg.bundle) !== null && _e !== void 0 ? _e : { wait: false };
+                this.clearOutput(bundle, msg.parentHeader);
+                break;
+            }
+            case 'execute_result': {
+                const bundle = (_f = msg.bundle) !== null && _f !== void 0 ? _f : {
+                    execution_count: 0,
+                    data: {},
+                    metadata: {},
+                };
+                this.publishExecuteResult(bundle, msg.parentHeader);
+                break;
+            }
+            case 'execute_error': {
+                const bundle = (_g = msg.bundle) !== null && _g !== void 0 ? _g : { ename: '', evalue: '', traceback: [] };
+                this.publishExecuteError(bundle, msg.parentHeader);
+                break;
+            }
+            case 'comm_msg':
+            case 'comm_open':
+            case 'comm_close': {
+                this.handleComm(msg.type, msg.content, msg.metadata, msg.buffers, msg.parentHeader);
+                break;
+            }
+        }
+    }
+    /**
+     * Handle a kernel_info_request message
+     */
+    async kernelInfoRequest() {
+        const content = {
+            implementation: 'pyodide',
+            implementation_version: '0.1.0',
+            language_info: {
+                codemirror_mode: {
+                    name: 'python',
+                    version: 3,
+                },
+                file_extension: '.py',
+                mimetype: 'text/x-python',
+                name: 'python',
+                nbconvert_exporter: 'python',
+                pygments_lexer: 'ipython3',
+                version: '3.8',
+            },
+            protocol_version: '5.3',
+            status: 'ok',
+            banner: 'A WebAssembly-powered Python kernel backed by Pyodide',
+            help_links: [
+                {
+                    text: 'Python (WASM) Kernel',
+                    url: 'https://pyodide.org',
+                },
+            ],
+        };
+        return content;
+    }
+    /**
+     * Handle an `execute_request` message
+     *
+     * @param msg The parent message.
+     */
+    async executeRequest(content) {
+        await this.ready;
+        const result = await this._remoteKernel.execute(content, this.parent);
+        result.execution_count = this.executionCount;
+        return result;
+    }
+    /**
+     * Handle an complete_request message
+     *
+     * @param msg The parent message.
+     */
+    async completeRequest(content) {
+        return await this._remoteKernel.complete(content, this.parent);
+    }
+    /**
+     * Handle an `inspect_request` message.
+     *
+     * @param content - The content of the request.
+     *
+     * @returns A promise that resolves with the response message.
+     */
+    async inspectRequest(content) {
+        return await this._remoteKernel.inspect(content, this.parent);
+    }
+    /**
+     * Handle an `is_complete_request` message.
+     *
+     * @param content - The content of the request.
+     *
+     * @returns A promise that resolves with the response message.
+     */
+    async isCompleteRequest(content) {
+        return await this._remoteKernel.isComplete(content, this.parent);
+    }
+    /**
+     * Handle a `comm_info_request` message.
+     *
+     * @param content - The content of the request.
+     *
+     * @returns A promise that resolves with the response message.
+     */
+    async commInfoRequest(content) {
+        return await this._remoteKernel.commInfo(content, this.parent);
+    }
+    /**
+     * Send an `comm_open` message.
+     *
+     * @param msg - The comm_open message.
+     */
+    async commOpen(msg) {
+        return await this._remoteKernel.commOpen(msg, this.parent);
+    }
+    /**
+     * Send an `comm_msg` message.
+     *
+     * @param msg - The comm_msg message.
+     */
+    async commMsg(msg) {
+        return await this._remoteKernel.commMsg(msg, this.parent);
+    }
+    /**
+     * Send an `comm_close` message.
+     *
+     * @param close - The comm_close message.
+     */
+    async commClose(msg) {
+        return await this._remoteKernel.commClose(msg, this.parent);
+    }
+    /**
+     * Send an `input_reply` message.
+     *
+     * @param content - The content of the reply.
+     */
+    async inputReply(content) {
+        return await this._remoteKernel.inputReply(content, this.parent);
+    }
+}

package/lib/tokens.d.ts

@@ -0,0 +1,56 @@
+/**
+ * Definitions for the Pyodide kernel.
+ */
+import type { Remote } from 'comlink';
+import { IWorkerKernel } from '@jupyterlite/kernel';
+/**
+ * An interface for Pyodide workers.
+ */
+export interface IPyodideWorkerKernel extends IWorkerKernel {
+    /**
+     * Handle any lazy initialization activities.
+     */
+    initialize(options: IPyodideWorkerKernel.IOptions): Promise<void>;
+}
+/**
+ * An convenience interface for Pyodide workers wrapped by a comlink Remote.
+ */
+export type IRemotePyodideWorkerKernel = Remote<IPyodideWorkerKernel>;
+/**
+ * An namespace for Pyodide workers.
+ */
+export declare namespace IPyodideWorkerKernel {
+    /**
+     * Initialization options for a worker.
+     */
+    interface IOptions extends IWorkerKernel.IOptions {
+        /**
+         * The URL of the main `pyodide.js` file in the standard pyodide layout.
+         */
+        pyodideUrl: string;
+        /**
+         * The URL of a pyodide index file in the standard pyodide layout.
+         */
+        indexUrl: string;
+        /**
+         * The URL of the `piplite` wheel for bootstrapping.
+         */
+        pipliteWheelUrl: string;
+        /**
+         * The URLs of additional warehouse-like wheel listings.
+         */
+        pipliteUrls: string[];
+        /**
+         * Whether `piplite` should fall back to the hard-coded `pypi.org` for resolving packages.
+         */
+        disablePyPIFallback: boolean;
+        /**
+         * The current working directory in which to start the kernel.
+         */
+        location: string;
+        /**
+         * Whether or not to mount the Emscripten drive
+         */
+        mountDrive: boolean;
+    }
+}

package/lib/tokens.js

@@ -0,0 +1,3 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+export {};

package/lib/worker.d.ts

@@ -0,0 +1,134 @@
+import type Pyodide from 'pyodide';
+import type { DriveFS } from '@jupyterlite/contents';
+import type { IPyodideWorkerKernel } from './tokens';
+export declare class PyodideRemoteKernel {
+    constructor();
+    /**
+     * Accept the URLs from the host
+     **/
+    initialize(options: IPyodideWorkerKernel.IOptions): Promise<void>;
+    protected initRuntime(options: IPyodideWorkerKernel.IOptions): Promise<void>;
+    protected initPackageManager(options: IPyodideWorkerKernel.IOptions): Promise<void>;
+    protected initKernel(options: IPyodideWorkerKernel.IOptions): Promise<void>;
+    protected initGlobals(options: IPyodideWorkerKernel.IOptions): Promise<void>;
+    /**
+     * Setup custom Emscripten FileSystem
+     */
+    protected initFilesystem(options: IPyodideWorkerKernel.IOptions): Promise<void>;
+    /**
+     * Recursively convert a Map to a JavaScript object
+     * @param obj A Map, Array, or other  object to convert
+     */
+    mapToObject(obj: any): any;
+    /**
+     * Format the response from the Pyodide evaluation.
+     *
+     * @param res The result object from the Pyodide evaluation
+     */
+    formatResult(res: any): any;
+    /**
+     * Makes sure pyodide is ready before continuing, and cache the parent message.
+     */
+    setup(parent: any): Promise<void>;
+    /**
+     * Execute code with the interpreter.
+     *
+     * @param content The incoming message with the code to execute.
+     */
+    execute(content: any, parent: any): Promise<any>;
+    /**
+     * Complete the code submitted by a user.
+     *
+     * @param content The incoming message with the code to complete.
+     */
+    complete(content: any, parent: any): Promise<any>;
+    /**
+     * Inspect the code submitted by a user.
+     *
+     * @param content The incoming message with the code to inspect.
+     */
+    inspect(content: {
+        code: string;
+        cursor_pos: number;
+        detail_level: 0 | 1;
+    }, parent: any): Promise<any>;
+    /**
+     * Check code for completeness submitted by a user.
+     *
+     * @param content The incoming message with the code to check.
+     */
+    isComplete(content: {
+        code: string;
+    }, parent: any): Promise<any>;
+    /**
+     * Respond to the commInfoRequest.
+     *
+     * @param content The incoming message with the comm target name.
+     */
+    commInfo(content: any, parent: any): Promise<{
+        comms: any;
+        status: string;
+    }>;
+    /**
+     * Respond to the commOpen.
+     *
+     * @param content The incoming message with the comm open.
+     */
+    commOpen(content: any, parent: any): Promise<any>;
+    /**
+     * Respond to the commMsg.
+     *
+     * @param content The incoming message with the comm msg.
+     */
+    commMsg(content: any, parent: any): Promise<any>;
+    /**
+     * Respond to the commClose.
+     *
+     * @param content The incoming message with the comm close.
+     */
+    commClose(content: any, parent: any): Promise<any>;
+    /**
+     * Resolve the input request by getting back the reply from the main thread
+     *
+     * @param content The incoming message with the reply
+     */
+    inputReply(content: any, parent: any): Promise<void>;
+    /**
+     * 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?
+     */
+    sendInputRequest(prompt: string, password: boolean): Promise<void>;
+    getpass(prompt: string): Promise<any>;
+    input(prompt: string): Promise<any>;
+    /**
+     * Send a comm message to the front-end.
+     *
+     * @param type The type of the comm message.
+     * @param content The content.
+     * @param metadata The metadata.
+     * @param ident The ident.
+     * @param buffers The binary buffers.
+     */
+    sendComm(type: string, content: any, metadata: any, ident: any, buffers: any): Promise<void>;
+    /**
+     * Initialization options.
+     */
+    protected _options: IPyodideWorkerKernel.IOptions | null;
+    /**
+     * A promise that resolves when all initiaization is complete.
+     */
+    protected _initialized: Promise<void>;
+    private _initializer;
+    protected _pyodide: Pyodide.PyodideInterface;
+    /** TODO: real typing */
+    protected _localPath: string;
+    protected _driveName: string;
+    protected _kernel: any;
+    protected _interpreter: any;
+    protected _stdout_stream: any;
+    protected _stderr_stream: any;
+    protected _resolveInputReply: any;
+    protected _driveFS: DriveFS | null;
+}