Set PYDEVD_IPYTHON_COMPATIBLE_DEBUGGING in Python process (#11684)

news/3 Code Health/11682.md

@@ -0,0 +1 @@
+Initialize the environment variable `PYDEVD_IPYTHON_COMPATIBLE_DEBUGGING` at the point of spawning the Python kernel.

src/kernels/debuggerStartupCodeProvider.ts

@@ -3,7 +3,7 @@
 
 import { injectable } from 'inversify';
 import { isPythonKernelConnection } from './helpers';
-import { IKernel, IStartupCodeProvider, StartupCodePriority } from './types';
+import { IKernel, isLocalConnection, IStartupCodeProvider, StartupCodePriority } from './types';
 
 @injectable()
 export class DebugStartupCodeProvider implements IStartupCodeProvider {
@@ -13,7 +13,11 @@ export class DebugStartupCodeProvider implements IStartupCodeProvider {
         if (!isPythonKernelConnection(kernel.kernelConnectionMetadata)) {
             return [];
         }
-
+        if (isLocalConnection(kernel.kernelConnectionMetadata)) {
+            return [];
+        }
+        // Inject the env var only for remote kernels, for local kernels,
+        // this env var will be setup when spawning the kernel process.
         return [
             'import os as __VSCODE_os',
             // Required to get pydevd to work properly in Python kernel, more info here https://github.com/microsoft/vscode-jupyter/issues/11033

src/kernels/raw/launcher/kernelEnvVarsService.node.ts

@@ -140,7 +140,9 @@ export class KernelEnvironmentVariablesService {
             traceInfo(`Adding env Variable PYTHONNOUSERSITE to ${getDisplayPath(interpreter?.uri)}`);
             mergedVars.PYTHONNOUSERSITE = 'True';
         }
-
+        if (isPythonKernel) {
+            mergedVars.PYDEVD_IPYTHON_COMPATIBLE_DEBUGGING = '1';
+        }
         return mergedVars;
     }
 }