Function getPythonEnvDisplayName

src/platform/interpreter/helpers.ts:15–63

(interpreter: PythonEnvironment | Environment | { id: string })

import { WrappedError } from '../errors/types';

export function getPythonEnvDisplayName(interpreter: PythonEnvironment | Environment | { id: string }) {
    const env = getCachedEnvironment(interpreter);
    if (isCI) {
        logger.ci(`Python Env Info for ${JSON.stringify(interpreter)} is ${JSON.stringify(env)}`);
    }
    if (env) {
        const versionParts: string[] = [];
        if (typeof env.version?.major === 'number') {
            versionParts.push(env.version.major.toString());
            if (typeof env.version.minor === 'number') {
                versionParts.push(env.version.minor.toString());
                if (typeof env.version.micro === 'number') {
                    versionParts.push(env.version.micro.toString());
                }
            }
        }
        const version = versionParts.length ? versionParts.join('.') : '';
        const envName = env.environment?.name || (env.environment ? basename(env.environment?.folderUri) : '');
        const nameWithVersion = version ? `Python ${version}` : 'Python';
        if (isCondaEnvironmentWithoutPython(interpreter) && envName) {
            return envName;
        }
        if (envName) {
            return `${envName} (${nameWithVersion})`;
        }
        return nameWithVersion;
    }
    if (Object.keys(interpreter).length === 1 && interpreter.id) {
        return interpreter.id;
    }

    const pythonVersion = getTelemetrySafeVersion(getCachedVersion(interpreter) || '').trim();
    // If this is a conda environment without Python, then don't display `Python` in it.
    const isCondaEnvWithoutPython = isCondaEnvironmentWithoutPython(interpreter);
    const nameWithVersion = pythonVersion ? `Python ${pythonVersion}` : 'Python';
    const envName = getPythonEnvironmentName(interpreter as PythonEnvironment);
    if (isCondaEnvWithoutPython && envName) {
        return envName;
    }
    const details: string[] = [];
    if (envName) {
        details.push(envName);
    }
    const envType = getEnvironmentType(interpreter);
    if (envType && envType !== EnvironmentType.Unknown) {
        details.push(envType);
    }
    return [nameWithVersion, details.length ? `(${details.join(': ')})` : ''].join(' ').trim();
}

export function getPythonEnvironmentName(pythonEnv: { id: string }) {
    // Sometimes Python extension doesn't detect conda environments correctly (e.g. conda env create without a name).