Function getKernelId

src/kernels/helpers.ts:204–249

(spec: IJupyterKernelSpec, interpreter?: PythonEnvironment, serverId?: string)

    return connectionMetadata.kind === 'connectToLiveRemoteKernel';
}
export function getKernelId(spec: IJupyterKernelSpec, interpreter?: PythonEnvironment, serverId?: string) {
    // Non-Python kernels cannot contain an interpreter (even in their id).
    interpreter = isPythonKernelSpec(spec) ? interpreter : undefined;
    // Do not include things like display names, as they aren't unique & can change over time.
    // if the spec name is generated by us, then exclude the leading bit (as it can contain version numbers).
    // & sometimes the kernelspec might not have the version number (if it wasn't available at the time of generation of spec)
    // See getInterpreterKernelSpecName for details of this logic.
    let specName = spec.name;
    const kernelRegistrationKind = getKernelRegistrationInfo(spec);
    // eslint-disable-next-line @typescript-eslint/no-use-before-define
    if (kernelRegistrationKind && specName.includes(autoGeneratedKernelNameIdentifier)) {
        // eslint-disable-next-line @typescript-eslint/no-use-before-define
        specName = specName.substring(specName.indexOf(autoGeneratedKernelNameIdentifier));
        // When users create kernelspecs, we need to include the name of custom kernelspecs in the id.
        if (kernelRegistrationKind === 'registeredByNewVersionOfExtForCustomKernelSpec') {
            const originalSpecFile = spec.metadata?.vscode?.originalSpecFile || spec.metadata?.originalSpecFile;
            if (originalSpecFile) {
                specName = `${specName}#${path.basename(path.dirname(originalSpecFile))}`;
            }
        }
    }
    // The arguments in the spec can be different for multiple kernel specs pointing to the same interpreter.
    // E.g. we can have pyspark kernels with `"-m", "sparkmagic.kernels.pysparkkernel.pysparkkernel",`
    // & another with "-m","jupyter_nb_ext.kernels.synapse_pyspark.kernel"
    let argsForGenerationOfId = '';
    if (isPythonKernelSpec(spec)) {
        // Ignore the first argument (its the python path).
        // Ignore the common bits such as `-f` & `connection_file`
        argsForGenerationOfId = spec.argv
            .slice(1)
            .filter((item) => !['-f', '{connection_file}'].includes(item))
            .join('#')
            .toLowerCase();
    } else {
        // Lets not assume that non-python kernels cannot have such issues
        argsForGenerationOfId = spec.argv.join('#').toLowerCase();
    }
    const prefixForRemoteKernels = serverId ? `${serverId}.` : '';
    const specPath = getFilePath(
        getNormalizedInterpreterPath(spec.interpreterPath ? Uri.file(spec.interpreterPath) : Uri.file(spec.executable))
    );
    const interpreterPath = getFilePath(getNormalizedInterpreterPath(interpreter?.uri)) || '';
    return `${prefixForRemoteKernels}${
        spec.id || ''
    }.${specName}.${specPath}.${interpreterPath}.${argsForGenerationOfId}`;
}

export function getDisplayNameOrNameOfKernelConnection(kernelConnection: KernelConnectionMetadata | undefined) {
    const oldDisplayName = getOldFormatDisplayNameOrNameOfKernelConnection(kernelConnection);