Add the geventCompatible launch configuration option (DonJayamanne#…

…1699)

* Fix tslint errors brought in by typescript@2.8.3

* Add the `geventCompatible` launch configuration option

This makes the experimental Python debugger work with projects using
gevent's monkey patching.

Closes microsoft#127

news/1 Enhancements/127.md

@@ -0,0 +1 @@
+Add `gevent` launch configuration option to enable debugging of gevent monkey patched code.

package.json

@@ -818,6 +818,17 @@
                             "jinja": true
                         }
                     },
+                    {
+                        "label": "Python Experimental: Gevent",
+                        "description": "%python.snippet.launch.gevent.description%",
+                        "body": {
+                            "name": "Gevent",
+                            "type": "pythonExperimental",
+                            "request": "launch",
+                            "program": "^\"\\${file}\"",
+                            "gevent": true
+                        }
+                    },
                     {
                         "label": "Python Experimental: PySpark",
                         "description": "%python.snippet.launch.pyspark.description%",
@@ -975,6 +986,11 @@
                                 "description": "Debug standard library code.",
                                 "default": false
                             },
+                            "gevent": {
+                                "type": "boolean",
+                                "description": "Enable debugging of gevent monkey-patched code.",
+                                "default": false
+                            },
                             "django": {
                                 "type": "boolean",
                                 "description": "Django debugging.",

package.nls.json

@@ -39,6 +39,8 @@
     "python.snippet.launch.flask.description": "Debug a Flask Application",
     "python.snippet.launch.flaskOld.label": "Python: Flask (0.10.x or earlier)",
     "python.snippet.launch.flaskOld.description": "Debug an older styled Flask Application",
+    "python.snippet.launch.gevent.label": "Python: Gevent",
+    "python.snippet.launch.gevent.description": "Debug a Gevent Application",
     "python.snippet.launch.pyramid.label": "Python: Pyramid Application",
     "python.snippet.launch.pyramid.description": "Debug a Pyramid Application",
     "python.snippet.launch.watson.label": "Python: Watson Application",

src/client/debugger/Common/Contracts.ts

@@ -61,6 +61,7 @@ export type DebuggerType = 'python' | 'pythonExperimental';
 export interface AdditionalLaunchDebugOptions {
     redirectOutput?: boolean;
     django?: boolean;
+    gevent?: boolean;
     jinja?: boolean;
     debugStdLib?: boolean;
     sudo?: boolean;
@@ -70,6 +71,7 @@ export interface AdditionalLaunchDebugOptions {
 export interface AdditionalAttachDebugOptions {
     redirectOutput?: boolean;
     django?: boolean;
+    gevent?: boolean;
     jinja?: boolean;
     debugStdLib?: boolean;
 }

src/client/debugger/DebugClients/helper.ts

@@ -10,7 +10,8 @@ export class DebugClientHelper {
 
         // Merge variables from both .env file and env json variables.
         const envFileVars = await this.envParser.parseFile(args.envFile);
-        const debugLaunchEnvVars = (args.env && Object.keys(args.env).length > 0) ? { ...args.env } as EnvironmentVariables : {};
+        // tslint:disable-next-line:no-any
+        const debugLaunchEnvVars: {[key: string]: string} = (args.env && Object.keys(args.env).length > 0) ? { ...args.env } as any : {} as any;
         const env = envFileVars ? { ...envFileVars! } : {};
         this.envParser.mergeVariables(debugLaunchEnvVars, env);
 
@@ -51,6 +52,10 @@ export class DebugClientHelper {
             env.PYTHONUNBUFFERED = '1';
         }
 
+        if (args.gevent) {
+            env.GEVENT_SUPPORT = 'True';  // this is read in pydevd_constants.py
+        }
+
         return env;
     }
 }