Function openNotebook

src/standalone/api/unstable/index.ts:119–161

(
    uri: Uri,
    kernelOrPythonEnvId: string | EnvironmentPath,
    serviceContainer: IServiceContainer
)

}

export async function openNotebook(
    uri: Uri,
    kernelOrPythonEnvId: string | EnvironmentPath,
    serviceContainer: IServiceContainer
) {
    const extensions = serviceContainer.get<IExtensions>(IExtensions);
    sendTelemetryEvent(Telemetry.JupyterApiUsage, undefined, {
        clientExtId: extensions.determineExtensionFromCallStack().extensionId,
        pemUsed: 'openNotebook'
    });
    const controllers = serviceContainer.get<IControllerRegistration>(IControllerRegistration);
    const kernelId = typeof kernelOrPythonEnvId === 'string' ? kernelOrPythonEnvId : undefined;
    const pythonEnv = typeof kernelOrPythonEnvId === 'string' ? undefined : kernelOrPythonEnvId;
    let id = kernelId && controllers.all.find((controller) => controller.id === kernelOrPythonEnvId)?.id;
    if (!id && pythonEnv && !isWeb()) {
        // Look for a python environment with this id.
        id = controllers.all.find(
            (controller) =>
                controller.kind === 'startUsingPythonInterpreter' && controller.interpreter.id === pythonEnv.id
        )?.id;
        if (!id) {
            // Controller has not yet been created.
            const selector = serviceContainer.get<ILocalPythonNotebookKernelSourceSelector>(
                ILocalPythonNotebookKernelSourceSelector
            );
            const connection = await selector.getKernelConnection(pythonEnv);
            id = connection && controllers.all.find((controller) => controller.id === connection?.id)?.id;
        }
    }
    if (!id) {
        throw new Error(`Kernel ${kernelOrPythonEnvId} not found.`);
    }
    const notebookEditor =
        window.activeNotebookEditor?.notebook?.uri?.toString() === uri.toString()
            ? window.activeNotebookEditor
            : await window.showNotebookDocument(await workspace.openNotebookDocument(uri));
    await commands.executeCommand('notebook.selectKernel', {
        notebookEditor,
        id,
        extension: JVSC_EXTENSION_ID
    });
    return notebookEditor.notebook;
}