Function getDisplayNameOrNameOfKernelConnection

src/kernels/helpers.ts:251–318

(kernelConnection: KernelConnectionMetadata | undefined)

}

export function getDisplayNameOrNameOfKernelConnection(kernelConnection: KernelConnectionMetadata | undefined) {
    const oldDisplayName = getOldFormatDisplayNameOrNameOfKernelConnection(kernelConnection);
    if (!kernelConnection) {
        return oldDisplayName;
    }
    switch (kernelConnection.kind) {
        case 'connectToLiveRemoteKernel': {
            const notebookPath = removeNotebookSuffixAddedByExtension(
                kernelConnection.kernelModel?.notebook?.path || kernelConnection.kernelModel?.model?.path || ''
            );
            return notebookPath ? `${oldDisplayName} (${notebookPath})` : oldDisplayName;
        }
        case 'startUsingRemoteKernelSpec':
        case 'startUsingLocalKernelSpec': {
            if (
                kernelConnection.interpreter &&
                getEnvironmentType(kernelConnection.interpreter) !== EnvironmentType.Unknown
            ) {
                const envName = getPythonEnvironmentName(kernelConnection.interpreter);
                if (kernelConnection.kernelSpec.language === PYTHON_LANGUAGE) {
                    const pythonVersion = `Python ${
                        getTelemetrySafeVersion(getCachedVersion(kernelConnection.interpreter)) || ''
                    }`.trim();
                    return envName ? `${oldDisplayName} (${pythonVersion})` : oldDisplayName;
                } else {
                    // Non-Python kernelspec that launches via python interpreter
                    return envName ? `${oldDisplayName} (${envName})` : oldDisplayName;
                }
            } else {
                return oldDisplayName;
            }
        }
        case 'startUsingPythonInterpreter':
            const pythonVersion = (
                getTelemetrySafeVersion(getCachedVersion(kernelConnection.interpreter)) || ''
            ).trim();
            if (
                kernelConnection.interpreter &&
                getEnvironmentType(kernelConnection.interpreter) !== EnvironmentType.Unknown
            ) {
                // If user has created a custom kernelspec, then use that.
                if (
                    kernelConnection.kernelSpec.display_name &&
                    getKernelRegistrationInfo(kernelConnection.kernelSpec) ===
                        'registeredByNewVersionOfExtForCustomKernelSpec'
                ) {
                    return kernelConnection.kernelSpec.display_name;
                }

                return getDisplayNameOrNameOfPythonKernelConnection(kernelConnection.interpreter);
            } else {
                return `Python ${pythonVersion}`.trim();
            }
        case 'startUsingDeepnoteKernel': {
            // Display as "Project Title"
            if (kernelConnection.projectName) {
                return kernelConnection.projectName;
            }