jupyterpack 0.4.0 → 0.5.1

package/README.md

@@ -7,7 +7,7 @@
 
 ## Features
 
-- **Python Web Apps**: Serve Python web applications directly in the browser using JupyterLite's in-browser Python kernel. `jupyterpack` currently supports Dash.
+- **Python Web Apps**: Serve Python web applications directly in the browser using JupyterLite's in-browser Python kernel. `jupyterpack` currently supports Dash and Streamlit.
 - **JavaScript Web Apps**: Bundle and serve JavaScript web applications using in-browser bundlers.
 
 ![Image](https://github.com/user-attachments/assets/22849fe8-199f-4d9f-ad45-055bccf88bad)

package/lib/document/widgetFactory.js

@@ -35,7 +35,9 @@ export class JupyterPackWidgetFactory extends ABCWidgetFactory {
                 }
                 case JupyterPackFramework.DASH:
                 case JupyterPackFramework.STREAMLIT:
-                case JupyterPackFramework.TORNADO: {
+                case JupyterPackFramework.TORNADO:
+                case JupyterPackFramework.STARLETTE:
+                case JupyterPackFramework.SHINY: {
                     const model = new PythonWidgetModel({
                         jpackModel,
                         context,

package/lib/pythonServer/baseServer.d.ts

@@ -0,0 +1,82 @@
+import { KernelExecutor } from './kernelExecutor';
+import { IDict, IBasePythonServer, IKernelExecutor, JupyterPackFramework } from '../type';
+export declare abstract class BasePythonServer implements IBasePythonServer {
+    constructor(options: KernelExecutor.IOptions);
+    abstract reloadPythonServer(options: {
+        entryPath?: string;
+        initCode?: string;
+    }): Promise<void>;
+    get isDisposed(): boolean;
+    get kernelExecutor(): IKernelExecutor;
+    dispose(): void;
+    init(options: {
+        entryPath?: string;
+        initCode?: string;
+        instanceId: string;
+        kernelClientId: string;
+    }): Promise<void>;
+    disposePythonServer(): Promise<void>;
+    getResponseFunctionFactory(options: {
+        urlPath: string;
+        method: string;
+        headers: IDict;
+        params?: string;
+        content?: string;
+    }): string;
+    openWebsocketFunctionFactory(options: {
+        instanceId: string;
+        kernelId: string;
+        wsUrl: string;
+        protocol?: string;
+    }): string;
+    closeWebsocketFunctionFactory(options: {
+        instanceId: string;
+        kernelId: string;
+        wsUrl: string;
+    }): string;
+    sendWebsocketMessageFunctionFactory(options: {
+        instanceId: string;
+        kernelId: string;
+        wsUrl: string;
+        message: string;
+    }): string;
+    openWebsocket(options: {
+        instanceId: string;
+        kernelId: string;
+        wsUrl: string;
+        protocol?: string;
+    }): Promise<void>;
+    closeWebsocket(options: {
+        instanceId: string;
+        kernelId: string;
+        wsUrl: string;
+    }): Promise<void>;
+    sendWebsocketMessage(options: {
+        instanceId: string;
+        kernelId: string;
+        wsUrl: string;
+        message: string;
+    }): Promise<void>;
+    getResponse(options: {
+        method: string;
+        urlPath: string;
+        headers: IDict;
+        requestBody?: ArrayBuffer;
+        params?: string;
+    }): Promise<IDict>;
+    protected buildBaseURL(options: {
+        instanceId: string;
+        kernelClientId: string;
+        framework: JupyterPackFramework;
+    }): string;
+    protected _baseUrl: string | undefined;
+    protected readonly _openedWebsockets: {
+        instanceId: string;
+        kernelId: string;
+        wsUrl: string;
+    }[];
+    protected readonly _server_var = "__jupyterpack_python_server";
+    private _kernelExecutor;
+    private _isDisposed;
+    private _wsPatch;
+}

package/lib/pythonServer/baseServer.js

@@ -0,0 +1,141 @@
+import { KernelExecutor } from './kernelExecutor';
+import websocketPatch from '../websocket/websocket.js?raw';
+import { PageConfig, URLExt } from '@jupyterlab/coreutils';
+import { arrayBufferToBase64, base64ToArrayBuffer, base64ToString, isBinaryContentType, stringOrNone } from '../tools';
+export class BasePythonServer {
+    constructor(options) {
+        this._openedWebsockets = [];
+        this._server_var = '__jupyterpack_python_server';
+        this._isDisposed = false;
+        this._kernelExecutor = new KernelExecutor(options);
+        this._wsPatch = websocketPatch.replaceAll('"use strict";', '');
+    }
+    get isDisposed() {
+        return this._isDisposed;
+    }
+    get kernelExecutor() {
+        return this._kernelExecutor;
+    }
+    dispose() {
+        if (this._isDisposed) {
+            return;
+        }
+        this._isDisposed = true;
+        this.disposePythonServer()
+            .then(() => {
+            this._kernelExecutor.dispose();
+        })
+            .catch(console.error);
+    }
+    async init(options) {
+        const patchCode = `
+    from jupyterpack.common import patch_all
+    patch_all()
+    `;
+        await this._kernelExecutor.executeCode({ code: patchCode });
+    }
+    async disposePythonServer() {
+        await this.kernelExecutor.executeCode({
+            code: `${this._server_var}.dispose()`
+        });
+        for (const element of this._openedWebsockets) {
+            await this.closeWebsocket(element);
+        }
+    }
+    getResponseFunctionFactory(options) {
+        const { method, urlPath, headers, params, content } = options;
+        const code = `await ${this._server_var}.get_response("${method}", "${urlPath}", headers=${JSON.stringify(headers)} , content=${stringOrNone(content)}, params=${stringOrNone(params)})`;
+        return code;
+    }
+    openWebsocketFunctionFactory(options) {
+        const { instanceId, kernelId, wsUrl, protocol } = options;
+        const code = `await ${this._server_var}.open_ws("${instanceId}", "${kernelId}", "${wsUrl}", ${stringOrNone(protocol)})`;
+        return code;
+    }
+    closeWebsocketFunctionFactory(options) {
+        const { instanceId, kernelId, wsUrl } = options;
+        const code = `await ${this._server_var}.close_ws("${instanceId}", "${kernelId}", "${wsUrl}")`;
+        return code;
+    }
+    sendWebsocketMessageFunctionFactory(options) {
+        const { instanceId, kernelId, wsUrl, message } = options;
+        const code = `await ${this._server_var}.receive_ws_message("${instanceId}", "${kernelId}", "${wsUrl}", '''${message}''')`;
+        return code;
+    }
+    async openWebsocket(options) {
+        const code = this.openWebsocketFunctionFactory(options);
+        if (code) {
+            try {
+                await this._kernelExecutor.executeCode({ code });
+                this._openedWebsockets.push(options);
+            }
+            catch (e) {
+                console.error('Failed to open websocket', e);
+            }
+        }
+        else {
+            throw new Error('Missing websocket open code');
+        }
+    }
+    async closeWebsocket(options) {
+        const code = this.closeWebsocketFunctionFactory(options);
+        if (code) {
+            await this._kernelExecutor.executeCode({ code });
+        }
+        else {
+            throw new Error('Missing websocket close code');
+        }
+    }
+    async sendWebsocketMessage(options) {
+        const code = this.sendWebsocketMessageFunctionFactory(options);
+        if (code) {
+            await this._kernelExecutor.executeCode({ code });
+        }
+        else {
+            throw new Error('Missing websocket send code');
+        }
+    }
+    async getResponse(options) {
+        var _a;
+        const { method, urlPath, requestBody, params, headers } = options;
+        const content = requestBody ? arrayBufferToBase64(requestBody) : undefined;
+        const code = this.getResponseFunctionFactory({
+            method,
+            urlPath,
+            headers,
+            params,
+            content
+        });
+        const raw = await this._kernelExecutor.executeCode({ code }, true);
+        if (!raw) {
+            throw new Error(`Missing response for ${urlPath}`);
+        }
+        const jsonStr = raw.replaceAll("'", '');
+        const obj = JSON.parse(jsonStr);
+        const responseHeaders = JSON.parse(atob(obj.headers));
+        const contentType = (_a = responseHeaders === null || responseHeaders === void 0 ? void 0 : responseHeaders['Content-Type']) !== null && _a !== void 0 ? _a : responseHeaders === null || responseHeaders === void 0 ? void 0 : responseHeaders['content-type'];
+        let responseContent;
+        if (isBinaryContentType(contentType)) {
+            responseContent = base64ToArrayBuffer(obj.content);
+        }
+        else {
+            responseContent = base64ToString(obj.content);
+        }
+        if (contentType && contentType.toLowerCase().includes('text/html')) {
+            responseContent = responseContent.replace('<head>', `<head>\n<script>\n${this._wsPatch}\n</script>\n`);
+        }
+        const decodedObj = {
+            status_code: obj.status_code,
+            headers: responseHeaders,
+            content: responseContent
+        };
+        return decodedObj;
+    }
+    buildBaseURL(options) {
+        const { instanceId, kernelClientId, framework } = options;
+        const fullLabextensionsUrl = PageConfig.getOption('fullLabextensionsUrl');
+        const baseURL = URLExt.join(fullLabextensionsUrl, 'jupyterpack/static', instanceId, framework, kernelClientId, '/');
+        this._baseUrl = baseURL;
+        return baseURL;
+    }
+}

package/lib/pythonServer/dash/dashServer.d.ts

@@ -1,22 +1,12 @@
-import { IDict } from '../../type';
-import { KernelExecutor } from '../kernelExecutor';
-export declare class DashServer extends KernelExecutor {
+import { BasePythonServer } from '../baseServer';
+export declare class DashServer extends BasePythonServer {
     init(options: {
         initCode?: string;
         instanceId: string;
         kernelClientId: string;
     }): Promise<void>;
-    getResponseFunctionFactory(options: {
-        urlPath: string;
-        method: string;
-        headers: IDict;
-        params?: string;
-        content?: string;
-    }): string;
-    disposePythonServer(): Promise<void>;
     reloadPythonServer(options: {
         entryPath?: string;
         initCode?: string;
     }): Promise<void>;
-    private _DASH_SERVER_VAR;
 }

package/lib/pythonServer/dash/dashServer.js

@@ -1,11 +1,6 @@
-import { stringOrNone } from '../../tools';
 import { JupyterPackFramework } from '../../type';
-import { KernelExecutor } from '../kernelExecutor';
-export class DashServer extends KernelExecutor {
-    constructor() {
-        super(...arguments);
-        this._DASH_SERVER_VAR = '__jupyterpack_dash_server';
-    }
+import { BasePythonServer } from '../baseServer';
+export class DashServer extends BasePythonServer {
     async init(options) {
         await super.init(options);
         const { initCode, instanceId, kernelClientId } = options;
@@ -14,34 +9,26 @@ export class DashServer extends KernelExecutor {
             kernelClientId,
             framework: JupyterPackFramework.DASH
         });
-        await this.executeCode({
+        await this.kernelExecutor.executeCode({
             code: `
       import os
       os.environ["DASH_URL_BASE_PATHNAME"] = "${baseURL}"
       `
         });
         if (initCode) {
-            await this.executeCode({ code: initCode });
+            await this.kernelExecutor.executeCode({ code: initCode });
         }
         const loaderCode = `
       from jupyterpack.dash import DashServer
-      ${this._DASH_SERVER_VAR} = DashServer(app, "${baseURL}")
+      ${this._server_var} = DashServer(app, "${baseURL}")
       `;
-        await this.executeCode({ code: loaderCode });
-    }
-    getResponseFunctionFactory(options) {
-        const { method, urlPath, headers, params, content } = options;
-        const code = `${this._DASH_SERVER_VAR}.get_response("${method}", "${urlPath}", headers=${JSON.stringify(headers)} , content=${stringOrNone(content)}, params=${stringOrNone(params)})`;
-        return code;
-    }
-    async disposePythonServer() {
-        await this.executeCode({ code: `${this._DASH_SERVER_VAR}.dispose()` });
+        await this.kernelExecutor.executeCode({ code: loaderCode });
     }
     async reloadPythonServer(options) {
         const { initCode } = options;
         if (initCode) {
-            await this.executeCode({ code: initCode });
+            await this.kernelExecutor.executeCode({ code: initCode });
         }
-        await this.executeCode({ code: `${this._DASH_SERVER_VAR}.reload(app)` }, true);
+        await this.kernelExecutor.executeCode({ code: `${this._server_var}.reload(app)` }, true);
     }
 }

package/lib/pythonServer/index.d.ts

@@ -1,5 +1,5 @@
-import { IKernelExecutor, JupyterPackFramework } from '../type';
+import { IBasePythonServer, JupyterPackFramework } from '../type';
 import { KernelExecutor } from './kernelExecutor';
-type KernelExecutorConstructor = new (options: KernelExecutor.IOptions) => IKernelExecutor;
-export declare const PYTHON_SERVER: Map<JupyterPackFramework, KernelExecutorConstructor>;
+type BasePythonServerConstructor = new (options: KernelExecutor.IOptions) => IBasePythonServer;
+export declare const PYTHON_SERVER: Map<JupyterPackFramework, BasePythonServerConstructor>;
 export {};

package/lib/pythonServer/index.js

@@ -1,9 +1,13 @@
 import { JupyterPackFramework } from '../type';
 import { DashServer } from './dash/dashServer';
+import { ShinyServer } from './shiny/shinyServer';
+import { StarletteServer } from './starlette/starletteServer';
 import { StreamlitServer } from './streamlit/streamlitServer';
 import { TornadoServer } from './tornado/tornadoServer';
 export const PYTHON_SERVER = new Map([
     [JupyterPackFramework.DASH, DashServer],
     [JupyterPackFramework.STREAMLIT, StreamlitServer],
-    [JupyterPackFramework.TORNADO, TornadoServer]
+    [JupyterPackFramework.TORNADO, TornadoServer],
+    [JupyterPackFramework.SHINY, ShinyServer],
+    [JupyterPackFramework.STARLETTE, StarletteServer]
 ]);

package/lib/pythonServer/kernelExecutor.d.ts

@@ -1,68 +1,12 @@
 import { KernelMessage, Session } from '@jupyterlab/services';
-import { IDict, IKernelExecutor, JupyterPackFramework } from '../type';
-export declare abstract class KernelExecutor implements IKernelExecutor {
+import { IKernelExecutor } from '../type';
+export declare class KernelExecutor implements IKernelExecutor {
     constructor(options: KernelExecutor.IOptions);
     get isDisposed(): boolean;
-    abstract disposePythonServer(): Promise<void>;
-    abstract reloadPythonServer(options: {
-        entryPath?: string;
-        initCode?: string;
-    }): Promise<void>;
-    abstract getResponseFunctionFactory(options: {
-        urlPath: string;
-        method: string;
-        headers: IDict;
-        params?: string;
-        content?: string;
-    }): string;
-    init(options: {
-        entryPath?: string;
-        initCode?: string;
-        instanceId: string;
-        kernelClientId: string;
-    }): Promise<void>;
-    openWebsocketFunctionFactory(options: {
-        instanceId: string;
-        kernelId: string;
-        wsUrl: string;
-        protocol?: string;
-    }): string | undefined;
-    sendWebsocketMessageFunctionFactory(options: {
-        instanceId: string;
-        kernelId: string;
-        wsUrl: string;
-        message: string;
-    }): string | undefined;
-    openWebsocket(options: {
-        instanceId: string;
-        kernelId: string;
-        wsUrl: string;
-        protocol?: string;
-    }): Promise<void>;
-    sendWebsocketMessage(options: {
-        instanceId: string;
-        kernelId: string;
-        wsUrl: string;
-        message: string;
-    }): Promise<void>;
-    getResponse(options: {
-        method: string;
-        urlPath: string;
-        headers: IDict;
-        requestBody?: ArrayBuffer;
-        params?: string;
-    }): Promise<IDict>;
     executeCode(code: KernelMessage.IExecuteRequestMsg['content'], waitForResult?: boolean): Promise<string | null>;
     dispose(): void;
-    protected buildBaseURL(options: {
-        instanceId: string;
-        kernelClientId: string;
-        framework: JupyterPackFramework;
-    }): string;
-    protected _baseUrl: string | undefined;
     private _isDisposed;
     private _sessionConnection;
-    private _wsPatch;
 }
 export declare namespace KernelExecutor {
     interface IOptions {

package/lib/pythonServer/kernelExecutor.js

@@ -1,77 +1,12 @@
-import { PageConfig, URLExt } from '@jupyterlab/coreutils';
 import stripAnsi from 'strip-ansi';
-import { arrayBufferToBase64, base64ToArrayBuffer, base64ToString, isBinaryContentType } from '../tools';
-import websocketPatch from '../websocket/websocket.js?raw';
 export class KernelExecutor {
     constructor(options) {
         this._isDisposed = false;
         this._sessionConnection = options.sessionConnection;
-        this._wsPatch = websocketPatch.replaceAll('"use strict";', '');
     }
     get isDisposed() {
         return this._isDisposed;
     }
-    async init(options) {
-        const patchCode = `
-    from jupyterpack.common import patch_all
-    patch_all()
-    `;
-        await this.executeCode({ code: patchCode });
-    }
-    openWebsocketFunctionFactory(options) {
-        return undefined;
-    }
-    sendWebsocketMessageFunctionFactory(options) {
-        return undefined;
-    }
-    async openWebsocket(options) {
-        const code = this.openWebsocketFunctionFactory(options);
-        if (code) {
-            await this.executeCode({ code });
-        }
-    }
-    async sendWebsocketMessage(options) {
-        const code = this.sendWebsocketMessageFunctionFactory(options);
-        if (code) {
-            await this.executeCode({ code });
-        }
-    }
-    async getResponse(options) {
-        var _a;
-        const { method, urlPath, requestBody, params, headers } = options;
-        const content = requestBody ? arrayBufferToBase64(requestBody) : undefined;
-        const code = this.getResponseFunctionFactory({
-            method,
-            urlPath,
-            headers,
-            params,
-            content
-        });
-        const raw = await this.executeCode({ code }, true);
-        if (!raw) {
-            throw new Error(`Missing response for ${urlPath}`);
-        }
-        const jsonStr = raw.replaceAll("'", '');
-        const obj = JSON.parse(jsonStr);
-        const responseHeaders = JSON.parse(atob(obj.headers));
-        const contentType = (_a = responseHeaders === null || responseHeaders === void 0 ? void 0 : responseHeaders['Content-Type']) !== null && _a !== void 0 ? _a : responseHeaders === null || responseHeaders === void 0 ? void 0 : responseHeaders['content-type'];
-        let responseContent;
-        if (isBinaryContentType(contentType)) {
-            responseContent = base64ToArrayBuffer(obj.content);
-        }
-        else {
-            responseContent = base64ToString(obj.content);
-        }
-        if (contentType && contentType.toLowerCase() === 'text/html') {
-            responseContent = responseContent.replace('<head>', `<head>\n<script>\n${this._wsPatch}\n</script>\n`);
-        }
-        const decodedObj = {
-            status_code: obj.status_code,
-            headers: responseHeaders,
-            content: responseContent
-        };
-        return decodedObj;
-    }
     async executeCode(code, waitForResult) {
         var _a;
         const kernel = (_a = this._sessionConnection) === null || _a === void 0 ? void 0 : _a.kernel;
@@ -130,11 +65,4 @@ export class KernelExecutor {
         this._isDisposed = true;
         this._sessionConnection.dispose();
     }
-    buildBaseURL(options) {
-        const { instanceId, kernelClientId, framework } = options;
-        const fullLabextensionsUrl = PageConfig.getOption('fullLabextensionsUrl');
-        const baseURL = URLExt.join(fullLabextensionsUrl, 'jupyterpack/static', instanceId, framework, kernelClientId, '/');
-        this._baseUrl = baseURL;
-        return baseURL;
-    }
 }

package/lib/pythonServer/shiny/shinyServer.d.ts

@@ -0,0 +1,14 @@
+import { BasePythonServer } from '../baseServer';
+export declare class ShinyServer extends BasePythonServer {
+    init(options: {
+        entryPath?: string;
+        initCode?: string;
+        instanceId: string;
+        kernelClientId: string;
+    }): Promise<void>;
+    disposePythonServer(): Promise<void>;
+    reloadPythonServer(options: {
+        entryPath?: string;
+        initCode?: string;
+    }): Promise<void>;
+}

package/lib/pythonServer/shiny/shinyServer.js

@@ -0,0 +1,49 @@
+import { JupyterPackFramework } from '../../type';
+import { BasePythonServer } from '../baseServer';
+export class ShinyServer extends BasePythonServer {
+    async init(options) {
+        await super.init(options);
+        const { instanceId, kernelClientId, entryPath } = options;
+        const baseURL = this.buildBaseURL({
+            instanceId,
+            kernelClientId,
+            framework: JupyterPackFramework.SHINY
+        });
+        const bootstrapCode = `
+    from jupyterpack.common import set_base_url_env
+    set_base_url_env("${baseURL}")
+    from jupyterpack.shiny import patch_shiny
+    patch_shiny()
+    `;
+        await this.kernelExecutor.executeCode({ code: bootstrapCode });
+        if (entryPath) {
+            const loaderCode = `
+      from jupyterpack.shiny import ShinyServer, get_shiny_app
+
+
+      ${this._server_var} = ShinyServer(get_shiny_app("${entryPath}"), "${baseURL}")
+      `;
+            await this.kernelExecutor.executeCode({ code: loaderCode });
+        }
+    }
+    async disposePythonServer() {
+        await this.kernelExecutor.executeCode({
+            code: `${this._server_var}.dispose()`
+        });
+        for (const element of this._openedWebsockets) {
+            await this.closeWebsocket(element);
+        }
+    }
+    async reloadPythonServer(options) {
+        const { entryPath } = options;
+        if (entryPath) {
+            const reloadCode = `
+      from jupyterpack.shiny import  get_shiny_app
+
+      await ${this._server_var}.dispose()
+      ${this._server_var}.reload(get_shiny_app("${entryPath}"))
+      `;
+            await this.kernelExecutor.executeCode({ code: reloadCode }, true);
+        }
+    }
+}

package/lib/pythonServer/starlette/starletteServer.d.ts

@@ -0,0 +1,13 @@
+import { BasePythonServer } from '../baseServer';
+export declare class StarletteServer extends BasePythonServer {
+    init(options: {
+        initCode?: string;
+        instanceId: string;
+        kernelClientId: string;
+    }): Promise<void>;
+    disposePythonServer(): Promise<void>;
+    reloadPythonServer(options: {
+        entryPath?: string;
+        initCode?: string;
+    }): Promise<void>;
+}

package/lib/pythonServer/starlette/starletteServer.js

@@ -0,0 +1,49 @@
+import { JupyterPackFramework } from '../../type';
+import { BasePythonServer } from '../baseServer';
+export class StarletteServer extends BasePythonServer {
+    async init(options) {
+        await super.init(options);
+        const { initCode, instanceId, kernelClientId } = options;
+        const baseURL = this.buildBaseURL({
+            instanceId,
+            kernelClientId,
+            framework: JupyterPackFramework.STARLETTE
+        });
+        const bootstrapCode = `
+    from jupyterpack.common import set_base_url_env
+    set_base_url_env("${baseURL}")
+    `;
+        await this.kernelExecutor.executeCode({ code: bootstrapCode });
+        if (initCode) {
+            const initCodeWithUrl = initCode.replaceAll('{{base_url}}', baseURL);
+            await this.kernelExecutor.executeCode({ code: initCodeWithUrl });
+            const loaderCode = `
+      from jupyterpack.asgi import AsgiServer
+      ${this._server_var} = AsgiServer(app, "${baseURL}")
+      `;
+            await this.kernelExecutor.executeCode({ code: loaderCode });
+        }
+    }
+    async disposePythonServer() {
+        await this.kernelExecutor.executeCode({
+            code: `${this._server_var}.dispose()`
+        });
+        for (const element of this._openedWebsockets) {
+            await this.closeWebsocket(element);
+        }
+    }
+    async reloadPythonServer(options) {
+        var _a;
+        const { initCode } = options;
+        if (initCode) {
+            await this.kernelExecutor.executeCode({
+                code: initCode.replaceAll('{{base_url}}', (_a = this._baseUrl) !== null && _a !== void 0 ? _a : '')
+            });
+            const reloadCode = `
+      await ${this._server_var}.dispose()
+      ${this._server_var}.reload(app)
+      `;
+            await this.kernelExecutor.executeCode({ code: reloadCode }, true);
+        }
+    }
+}

package/lib/pythonServer/streamlit/streamlitServer.d.ts

@@ -10,5 +10,4 @@ export declare class StreamlitServer extends TornadoServer {
         entryPath?: string;
         initCode?: string;
     }): Promise<void>;
-    protected _SERVER_VAR: string;
 }