Make "internalConsoleOptions": "openOnSessionStart" easy to use

[1Mark]

fyi @sandy081 @isidorn
microsoft/vscode-python#6159 introduced "internalConsoleOptions": "openOnSessionStart" but using this via one of the pre-existing python debug configurations doesn't work out of the box since it has a constraint.

Start debugging a new project or file, it will ask you to choose a debug config

If you choose this first option it gives

{
    // Use IntelliSense to learn about possible attributes.
    // Hover to view descriptions of existing attributes.
    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python: Current File",
            "type": "python",
            "request": "launch",
            "program": "${file}",
            "console": "integratedTerminal",
            "justMyCode": true
        }
    ]
}

Then you realise you want the debug console to open automatically when you start the debugging, you come across microsoft/vscode-python#6159
then you add this to your config and

{
    // Use IntelliSense to learn about possible attributes.
    // Hover to view descriptions of existing attributes.
    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python: Current File",
            "type": "python",
            "request": "launch",
            "program": "${file}",
            "console": "integratedTerminal",
            "justMyCode": true,
            "internalConsoleOptions": "openOnSessionStart"
        }
    ]
}

Which doesn't work since

"purpose": [
    "debug-test"
    ],

Isn't in the default config.

Several requests

1. Make it the default to always launch the debug console
2. Make it clear in the docs (and in the hints in vscode) that internalConsoleOptions must be used with

"purpose": [
    "debug-test"
    ],

3. Add a new debug configuration just for debugging tests and make it be

{
    // Use IntelliSense to learn about possible attributes.
    // Hover to view descriptions of existing attributes.
    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python: Debug Tests",
            "type": "python",
            "request": "launch",
            "program": "${file}",
            "purpose": [
                "debug-test" // the main requirement
            ],
            "console": "integratedTerminal",
            "justMyCode": false, // not bothered about this value
            "internalConsoleOptions": "openOnSessionStart" // the main requirement
        }
    ]
}

Here is a diff compared to the existing one Python File Debug the currently active Python file

4. Update the existing Python File Debug the currently active Python file config to include. This is somewhat controversial but although it's incorrect, purpose works both for tests and debug file and therefore there is no downside by doing this.

"purpose": [
    "debug-test"
    ],

5. Maybe remove this constraint for

"purpose": [
    "debug-test"
    ],

Since I don't see how this is related to launching the Debug console.

[weinand]

/extPython

[weinand]

VS Code's "internalConsoleOptions": "openOnSessionStart" setting has no "constraint".
If there is a constraint, then this is introduced by the Python extension.

[1Mark]

VS Code's "internalConsoleOptions": "openOnSessionStart" setting has no "constraint". If there is a constraint, then this is introduced by the Python extension.

Created new issue here microsoft/vscode-python-debugger#529