Show message in logs when distutils is missing. (#21125)

Fixes #21120

Author: karthiknadig

pythonFiles/create_venv.py

@@ -161,12 +161,17 @@ def main(argv: Optional[Sequence[str]] = None) -> None:
     venv_installed = is_installed("venv")
     pip_installed = is_installed("pip")
     ensure_pip_installed = is_installed("ensurepip")
+    distutils_installed = is_installed("distutils")
 
     if not venv_installed:
         if sys.platform == "win32":
             raise VenvError("CREATE_VENV.VENV_NOT_FOUND")
         else:
             use_micro_venv = True
+            if not distutils_installed:
+                print("Install `python3-distutils` package or equivalent for your OS.")
+                print("On Debian/Ubuntu: `sudo apt install python3-distutils`")
+                raise VenvError("CREATE_VENV.DISTUTILS_NOT_INSTALLED")
 
     if venv_exists(args.name):
         # A virtual environment with same name exists.

src/client/pythonEnvironments/creation/provider/venvProgressAndTelemetry.ts

@@ -29,6 +29,7 @@ const INSTALLING_PIP_MARKER = 'CREATE_VENV.INSTALLING_PIP';
 const INSTALL_PIP_FAILED_MARKER = 'CREATE_VENV.INSTALL_PIP_FAILED';
 const DOWNLOADING_PIP_MARKER = 'CREATE_VENV.DOWNLOADING_PIP';
 const DOWNLOAD_PIP_FAILED_MARKER = 'CREATE_VENV.DOWNLOAD_PIP_FAILED';
+const DISTUTILS_NOT_INSTALLED_MARKER = 'CREATE_VENV.DISTUTILS_NOT_INSTALLED';
 
 export class VenvProgressAndTelemetry {
     private readonly processed = new Set<string>();
@@ -88,6 +89,16 @@ export class VenvProgressAndTelemetry {
                 return PIP_NOT_INSTALLED_MARKER;
             },
         ],
+        [
+            DISTUTILS_NOT_INSTALLED_MARKER,
+            (_progress: CreateEnvironmentProgress) => {
+                sendTelemetryEvent(EventName.ENVIRONMENT_FAILED, undefined, {
+                    environmentType: 'venv',
+                    reason: 'noDistUtils',
+                });
+                return VENV_NOT_INSTALLED_MARKER;
+            },
+        ],
         [
             VENV_NOT_INSTALLED_MARKER,
             (_progress: CreateEnvironmentProgress) => {

src/client/telemetry/index.ts

@@ -2057,7 +2057,7 @@ export interface IEventNamePropertyMapping {
      */
     [EventName.ENVIRONMENT_FAILED]: {
         environmentType: 'venv' | 'conda' | 'microvenv';
-        reason: 'noVenv' | 'noPip' | 'other';
+        reason: 'noVenv' | 'noPip' | 'noDistUtils' | 'other';
     };
     /**
      * Telemetry event sent before installing packages.