Overriding default debugOptions in launch.json

[DonJayamanne]

Currently we have debug options defined in debugOptions setting of launch.json file.
Here are some of those settings:

    "debugOptions":  [
            "RedirectOutput",       // Whether to redirect stdout and stderr (see pydevd_comm.CMD_REDIRECT_OUTPUT)
            "Django",               // Enables Django Template debugging
            "Jinja",                // Enables Jinja (Flask) Template debugging
            "FixFilePathCase",      // Used to ensure file paths on windows are properly cased (as they exist on the fs)
            "DebugStdLib"           // Whether to enable debugging of standard library functions
            "UseSourceReferences"   // New feature (#1322)
    ],

Now, the defaults:

• When you create a launch.json, debugOptoins is not in the file (except for some configurations, e.g. django, flask)
• We always inject RedirectOutput (this was a decision made in a previous version of the extension)
• Now we have a new feature to enable source references (Add support for remote source references #1322), and I think we should just inject UseSourceReferences into debugOptions (always)
• If the user is debugging a flask app ("module": "flask" in launch.json), then we inject Jinja into debugOptions

This is all well and good, the problem is there's no way for the user to opt out of these (injected) defaults. E.g. the user for some reason does not want the output to be redirected to the Debug Console, or they do not want source references enabled by default. I cannot think of any reason why one wouldn't want these, but I'm concerned about the way we're forcing these defaults. The user has no way of opting out of these.

The only solution I can think of, is to use individual settings in launch.json as follows:

{
            "redirectOutput": true/false,
            "django": true/false,
            "jinja": true/false,
            "fixFilePathCase": true/false
}

This way, if the values are not in launch.json we use the defaults, else user can chose to opt out by providing values for them with the value false in launch.json

However, this is inconsistent compared to the previous version of debugger.

@qubitron @brettcannon

[patrys]

Would it be possible to use the importlib hooks to detect Django/Jinja as they are imported?

[DonJayamanne]

importlib hooks to detect Django/Jinja as they are imported?

This was discussed, however this just introduces unnecessary complexity and with a higher probability of things to going wrong.