Function getKernelRegistrationInfo

src/kernels/helpers.ts:547–589

(
    kernelSpec: IJupyterKernelSpec
)

 *                              E.g. a custom kernelspec found in a Python environment (either created by user or as a result of installing some custom kernelspec).
 */
export function getKernelRegistrationInfo(
    kernelSpec: IJupyterKernelSpec
):
    | 'registeredByOldVersionOfExt'
    | 'registeredByNewVersionOfExt'
    | 'registeredByNewVersionOfExtForCustomKernelSpec'
    | undefined {
    if (kernelSpec.isRegisteredByVSC) {
        return kernelSpec.isRegisteredByVSC;
    }
    if (!kernelSpec.name) {
        return;
    }

    // The name of the original kernel can be derived from the original spec file path (directory containing the specfile).
    const originalSpecFile = kernelSpec.metadata?.vscode?.originalSpecFile || kernelSpec.metadata?.originalSpecFile;
    const originalName = originalSpecFile ? path.basename(path.dirname(originalSpecFile)) : kernelSpec.name;
    const isUserCreatedOrUserCustomizedKernelSpec = isDefaultKernelSpec({ ...kernelSpec, name: originalName })
        ? // If this is a default kernelspec, and we have env variables, then assume user modified it (effectively a user defined kernelspec).
          Object.keys(kernelSpec.env || {}).length > 0
        : // Original kernel spec file paths cannot contain the auto generated identifier.
          typeof originalSpecFile === 'string' && !originalSpecFile.includes(autoGeneratedKernelNameIdentifier);

    // Check if this is a kernel we registered in the old days.
    // If it is, then no need to display that (selecting kernels registered is done by selecting the corresponding interpreter).
    // Hence we can hide such kernels.
    // Kernels we create will end with a uuid (with - stripped), & will have interpreter info in the metadata.
    // Only do this for raw kernel scenarios
    if (kernelSpec.name.includes(autoGeneratedKernelNameIdentifier)) {
        return isUserCreatedOrUserCustomizedKernelSpec
            ? // This is a kernelspec we created to be able to load custom kernelspecs using Jupyter.
              // E.g. user creates a custom kernelspec in a Python env, Jupyter will not be able to load that.
              // We need to create a corresponding kernelspec in global location (which would be a copy of the users custom kernelspec).
              'registeredByNewVersionOfExtForCustomKernelSpec'
            : // This is a kernelspec we created to be able to load Python environments using Jupyter.
              'registeredByNewVersionOfExt';
    }
    const guidRegEx = /[a-f0-9]{32}$/;
    if (kernelSpec.metadata?.interpreter && kernelSpec.name.toLowerCase().search(guidRegEx) !== -1) {
        return 'registeredByOldVersionOfExt';
    }
    return;
}

export function areKernelConnectionsEqual(
    connection1?: KernelConnectionMetadata,