@datalayer/core 0.0.1 → 0.0.2

package/lib/api/runtimes/exec/Python.js

@@ -0,0 +1,105 @@
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD License.
+ */
+/*
+ * Copyright (c) 2021-2024 Datalayer, Inc.
+ *
+ * Datalayer License
+ */
+export function listVariables() {
+    return `
+def _list_variables():
+    import json
+    from types import BuiltinFunctionType, BuiltinMethodType, FunctionType, MethodType, MethodWrapperType, ModuleType, TracebackType
+
+    _FORBIDDEN_TYPES = [type, BuiltinFunctionType, BuiltinMethodType, FunctionType, MethodType, MethodWrapperType, ModuleType, TracebackType]
+    try:
+        from IPython.core.autocall import ExitAutocall
+        _FORBIDDEN_TYPES.append(ExitAutocall)
+    except ImportError:
+        pass
+    _exclude = tuple(_FORBIDDEN_TYPES)
+
+    _all = frozenset(globals())
+    _vars = {}
+    for _n in _all:
+        _v = globals()[_n]
+        
+        if not (
+            _n.startswith('_') or
+            isinstance(_v, _exclude) or
+            # Special IPython variables
+            (_n == 'In' and isinstance(_v, list)) or
+            (_n == 'Out' and isinstance(_v, dict))
+        ):
+            _vars[_n] = type(_v).__qualname__
+
+    return json.dumps(_vars)
+
+_list_variables()`;
+}
+export function saveVariables(variables) {
+    return `
+def _pickle_variables():
+    from base64 import encodebytes
+    import json
+    import pickle
+    _names = {${variables.map(v => `"${v}"`).join(',')}}
+    _data = {}
+    for _n in _names:
+        try:
+            _v = globals()[_n]
+            dump = pickle.dumps(_v)
+            _data[_n] = encodebytes(dump).decode("ascii")
+        except:
+            ...
+
+    return json.dumps(_data)
+
+_pickle_variables()
+`;
+}
+export function loadVariables(variables) {
+    return `
+def _load_variables():
+    from base64 import decodebytes
+    import json
+    import pickle
+    _data = json.loads(${variables})
+    _loaded = []
+    for _n, _v in _data.items():
+        try:
+            dump = decodebytes(_v.encode("ascii"))
+            globals()[_n] = pickle.loads(dump)
+            _loaded.append(_n)
+        except:
+            ...
+    return json.dumps(_loaded)
+
+_load_variables()
+`;
+}
+export function changeCurrentWorkingDirectory(path) {
+    const formattedPath = path
+        .split('/')
+        .map(seg => `"${seg}"`)
+        .join(' / ');
+    return `
+def _change_current_directory():
+    import os
+    from pathlib import Path
+    _local_content_mount_point = Path(Path.home() / ${formattedPath})
+    _local_content_mount_point.mkdir(parents=True, exist_ok=True)
+    os.chdir(_local_content_mount_point)
+
+    assert Path.cwd() == _local_content_mount_point
+
+_change_current_directory()
+`;
+}
+export function getOutputCandidates(code) {
+    return Array.from(code.matchAll(/^((?<output>[A-z][\w]*)\s*=[^=]|\((?<walrus>[A-z][\w]*)\s*:=[^=)]+\))/gm))
+        .map(match => match.groups?.output ?? match.groups?.walrus ?? '')
+        .filter(n => !!n);
+}

package/lib/api/runtimes/exec/Snippets.d.ts

@@ -0,0 +1,145 @@
+/**
+ * Runtime snippets.
+ */
+export interface IRuntimeSnippets {
+    /**
+     * Code snippet to change the current working directory.
+     *
+     * The code snippet has no returned value.
+     *
+     * The path is relative to the home directory and use
+     * the separator `/`.
+     *
+     * @param path New current directory
+     * @returns The code snippet
+     */
+    changeCurrentWorkingDirectory(path: string): string;
+    /**
+     * Code snippet to list the transferable kernel variables.
+     *
+     * The code snippet must return a serialized-JSON
+     * dictionary (<variable name>, <variable type>)
+     *
+     * @returns The code snippet
+     */
+    listVariables(): string;
+    /**
+     * Code snippet to load kernel variables.
+     *
+     * The code snippet must return a serialized-JSON list
+     * with successfully loaded variables.
+     *
+     * The format used to store the variable value is up to the kernel.
+     * It should JSON-serializable and will be passed from {@link saveVariables}.
+     *
+     * @param variables Serialized-JSON dictionary (<variable name>, <variable value blob>)
+     * @returns The code snippet
+     */
+    loadVariables(variables: string): string;
+    /**
+     * Code snippet to save kernel variables.
+     *
+     * The code snippet must return a serialized-JSON dictionary
+     * (<variable name>, <variable value blob>).
+     *
+     * The format used to store the variable value is up to the kernel.
+     * It should JSON-serializable and will be passed to {@link loadVariables}
+     * without modification.
+     *
+     * @param variables Variable names.
+     * @returns The code snippet
+     */
+    saveVariables(variables: string[]): string;
+    /**
+     * Extract output variables candidates by parsing the cell content.
+     *
+     * @param code Cell code source
+     * @returns The output variable candidates
+     */
+    getOutputCandidates(code: string): string[];
+}
+/**
+ * Facade to interact with kernels by requesting code execution.
+ */
+export declare class RuntimeSnippetsFacade {
+    private static $language;
+    /**
+     * Register a facade for a given language
+     *
+     * @param language Kernel language
+     * @param API Kernel API
+     */
+    static register(language: string, API: IRuntimeSnippets): void;
+    /**
+     * Whether there is an API for the given kernel language
+     *
+     * @param language Kernel language
+     */
+    static supports(language: string): boolean;
+    private _language;
+    /**
+     * Create a kernel snippet generator for a given kernel
+     * language.
+     *
+     * It will raise if the language is not available.
+     *
+     * @param language Kernel language
+     */
+    constructor(language: string);
+    /**
+     * Kernel language
+     */
+    get language(): string;
+    /**
+     * Code snippet to change the current working directory.
+     *
+     * The code snippet has no returned value.
+     *
+     * @param path New current directory
+     * @returns The code snippet
+     */
+    changeCurrentWorkingDirectory(path: string): string;
+    /**
+     * Code snippet to list the transferable kernel variables.
+     *
+     * The code snippet must return a serialized-JSON
+     * dictionary (<variable name>, <variable type>)
+     *
+     * @returns The code snippet
+     */
+    listVariables(): string;
+    /**
+     * Code snippet to load kernel variables.
+     *
+     * The code snippet must return a serialized-JSON list
+     * with successfully loaded variables.
+     *
+     * The format used to store the variable value is up to the kernel.
+     * It should JSON-serializable and will be passed from {@link saveVariables}.
+     *
+     * @param variables Serialized-JSON dictionary (<variable name>, <variable value blob>)
+     * @returns The code snippet
+     */
+    loadVariables(variables: string): string;
+    /**
+     * Code snippet to save kernel variables.
+     *
+     * The code snippet must return a serialized-JSON dictionary
+     * (<variable name>, <variable value blob>).
+     *
+     * The format used to store the variable value is up to the kernel.
+     * It should JSON-serializable and will be passed to {@link loadVariables}
+     * without modification.
+     *
+     * @param variables Variable names.
+     * @returns The code snippet
+     */
+    saveVariables(variables: string[]): string;
+    /**
+     * Extract output variables candidates by parsing the cell content.
+     *
+     * @param code Cell code source
+     * @returns The output variable candidates
+     */
+    getOutputCandidates(code: string): string[];
+}

package/lib/api/runtimes/exec/Snippets.js

@@ -0,0 +1,125 @@
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD License.
+ */
+/*
+ * Copyright (c) 2021-2024 Datalayer, Inc.
+ *
+ * Datalayer License
+ */
+import * as Python from './Python';
+/**
+ * Facade to interact with kernels by requesting code execution.
+ */
+export class RuntimeSnippetsFacade {
+    static $language = new Map();
+    /**
+     * Register a facade for a given language
+     *
+     * @param language Kernel language
+     * @param API Kernel API
+     */
+    static register(language, API) {
+        this.$language.set(language, API);
+    }
+    /**
+     * Whether there is an API for the given kernel language
+     *
+     * @param language Kernel language
+     */
+    static supports(language) {
+        return this.$language.has(language);
+    }
+    _language;
+    /**
+     * Create a kernel snippet generator for a given kernel
+     * language.
+     *
+     * It will raise if the language is not available.
+     *
+     * @param language Kernel language
+     */
+    constructor(language) {
+        if (!RuntimeSnippetsFacade.$language.has(language)) {
+            throw new Error(`${language} is not supported.`);
+        }
+        this._language = language;
+    }
+    /**
+     * Kernel language
+     */
+    get language() {
+        return this._language;
+    }
+    /**
+     * Code snippet to change the current working directory.
+     *
+     * The code snippet has no returned value.
+     *
+     * @param path New current directory
+     * @returns The code snippet
+     */
+    changeCurrentWorkingDirectory(path) {
+        return RuntimeSnippetsFacade.$language
+            .get(this.language)
+            .changeCurrentWorkingDirectory(path);
+    }
+    /**
+     * Code snippet to list the transferable kernel variables.
+     *
+     * The code snippet must return a serialized-JSON
+     * dictionary (<variable name>, <variable type>)
+     *
+     * @returns The code snippet
+     */
+    listVariables() {
+        return RuntimeSnippetsFacade.$language.get(this.language).listVariables();
+    }
+    /**
+     * Code snippet to load kernel variables.
+     *
+     * The code snippet must return a serialized-JSON list
+     * with successfully loaded variables.
+     *
+     * The format used to store the variable value is up to the kernel.
+     * It should JSON-serializable and will be passed from {@link saveVariables}.
+     *
+     * @param variables Serialized-JSON dictionary (<variable name>, <variable value blob>)
+     * @returns The code snippet
+     */
+    loadVariables(variables) {
+        return RuntimeSnippetsFacade.$language
+            .get(this.language)
+            .loadVariables(variables);
+    }
+    /**
+     * Code snippet to save kernel variables.
+     *
+     * The code snippet must return a serialized-JSON dictionary
+     * (<variable name>, <variable value blob>).
+     *
+     * The format used to store the variable value is up to the kernel.
+     * It should JSON-serializable and will be passed to {@link loadVariables}
+     * without modification.
+     *
+     * @param variables Variable names.
+     * @returns The code snippet
+     */
+    saveVariables(variables) {
+        return RuntimeSnippetsFacade.$language
+            .get(this.language)
+            .saveVariables(variables);
+    }
+    /**
+     * Extract output variables candidates by parsing the cell content.
+     *
+     * @param code Cell code source
+     * @returns The output variable candidates
+     */
+    getOutputCandidates(code) {
+        return RuntimeSnippetsFacade.$language
+            .get(this.language)
+            .getOutputCandidates(code);
+    }
+}
+RuntimeSnippetsFacade.register('python', Python);

package/lib/api/runtimes/exec/index.d.ts

@@ -0,0 +1,2 @@
+export * from './Python';
+export * from './Snippets';

package/lib/api/runtimes/exec/index.js

@@ -0,0 +1,11 @@
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD License.
+ */
+/*
+ * Copyright (c) 2021-2024 Datalayer, Inc.
+ *
+ * Datalayer License
+ */
+export * from './Python';
+export * from './Snippets';

package/lib/api/runtimes/index.d.ts

@@ -0,0 +1,7 @@
+export * from './exec';
+export * from './kernelsHandler';
+export * from './models';
+export * from './runtimesApi';
+export * from './settings';
+export * from './snapshots';
+export * from './utils';

package/lib/api/runtimes/index.js

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD License.
+ */
+/*
+ * Copyright (c) 2021-2024 Datalayer, Inc.
+ *
+ * Datalayer License
+ */
+export * from './exec';
+export * from './kernelsHandler';
+export * from './models';
+export * from './runtimesApi';
+export * from './settings';
+export * from './snapshots';
+export * from './utils';

package/lib/api/runtimes/kernelsHandler.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Call the Runtimes extension
+ *
+ * @param endPoint API REST end point for the extension
+ * @param init Initial values for the request
+ * @returns The response body interpreted as JSON
+ */
+export declare function requestJupyterKernelsExtension<T>(endPoint?: string, init?: RequestInit): Promise<T>;

package/lib/api/runtimes/kernelsHandler.js

@@ -0,0 +1,44 @@
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD License.
+ */
+/*
+ * Copyright (c) 2021-2024 Datalayer, Inc.
+ *
+ * Datalayer License
+ */
+import { URLExt } from '@jupyterlab/coreutils';
+import { ServerConnection } from '@jupyterlab/services';
+/**
+ * Call the Runtimes extension
+ *
+ * @param endPoint API REST end point for the extension
+ * @param init Initial values for the request
+ * @returns The response body interpreted as JSON
+ */
+export async function requestJupyterKernelsExtension(endPoint = '', init = {}) {
+    // Make request to Jupyter API
+    const settings = ServerConnection.makeSettings();
+    const requestUrl = URLExt.join(settings.baseUrl, 'jupyter_kernels', // API Namespace
+    endPoint);
+    let response;
+    try {
+        response = await ServerConnection.makeRequest(requestUrl, init, settings);
+    }
+    catch (error) {
+        throw new ServerConnection.NetworkError(error);
+    }
+    let data = await response.text();
+    if (data.length > 0) {
+        try {
+            data = JSON.parse(data);
+        }
+        catch (error) {
+            console.log('Not a JSON response body.', response);
+        }
+    }
+    if (!response.ok) {
+        throw new ServerConnection.ResponseError(response, data.message || data);
+    }
+    return data;
+}

package/lib/api/runtimes/models.d.ts

@@ -0,0 +1,59 @@
+import { Kernel } from '@jupyterlab/services';
+import { IRuntimePod } from "../../models";
+/**
+ * Runtime location.
+ */
+export type RuntimeLocation = 'browser' | 'local' | string;
+/**
+ * Runtime model.
+ */
+export interface IRuntimeModel extends IRuntimePod, Kernel.IModel {
+}
+/**
+ * Error thrown when a remote machine has been created
+ * but no kernel can be reached within it.
+ */
+export declare class RuntimeUnreachable extends Error {
+    name: string;
+}
+/**
+ * Runtime description.
+ */
+export interface IRuntimeDesc {
+    /**
+     * Runtime ID.
+     */
+    id?: string;
+    /**
+     * Runtime Kernel ID.
+     */
+    kernelId?: string;
+    /**
+     * Runtime name.
+     */
+    name: string;
+    /**
+     * Runtime language.
+     */
+    language: string;
+    /**
+     * Runtime location.
+     */
+    location: RuntimeLocation;
+    /**
+     * Runtime display name.
+     */
+    displayName?: string;
+    /**
+     * Runtime parameters.
+     */
+    params?: Record<string, any>;
+    /**
+     * Runtime credits burning rate.
+     */
+    burningRate?: number;
+    /**
+     * Runtime Pod name (if applicable).
+     */
+    podName?: string;
+}

package/lib/api/runtimes/models.js

@@ -0,0 +1,11 @@
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD License.
+ */
+/**
+ * Error thrown when a remote machine has been created
+ * but no kernel can be reached within it.
+ */
+export class RuntimeUnreachable extends Error {
+    name = 'RuntimeUnreachable';
+}