TPI: Python Default Problem Matcher

[anthonykim1]

Refs: #24154

• macOS @sandy081
• linux @connor4312
• windows @bamurtaugh

Complexity: 3

Create Issue

---

Thank you in advance for testing Python extension's default problem matcher

Background Information

Problem matcher works very closely with Tasks to parse through the Task Terminal's output and display "problems" or errors in your problems panel. More description on task and problem matcher can be found: https://code.visualstudio.com/docs/editor/tasks#_processing-task-output-with-problem-matchers

The intend of the problem matcher that Python extension provide is to allow users to reference this problem matcher via '$python' in their tasks.json file.

Example of tasks.json file that references $python

{
    "version": "2.0.0",
    "tasks": [
        {
            "label": "Run Python Script in your desired Folder",
            "type": "shell",
            "command": "python",     <or whichever way you reference your python executable>
            "args": [
                "your_file.py"   <whichever file you want to run with this task+problem matcher attached>
            ],
            "group": {
                "kind": "build",
                "isDefault": true
            },
            "problemMatcher": "$python"
        }
    ]
}

Setup:

1. Update the Python extension to the latest pre-release
2. Open a vscode workspace (or create empty one)
3. Create tasks.json that runs python file of your choice

Steps:

1. Have some Python file you would like to run that contains errors/exceptions.
2. Run Task
3. Find the task that you have defined in your tasks.json file, where you have reference problem matcher contributed by Python extension.
4. Run your task
5. Observe that appropriate errors/problems show up in your problems panel view.

Try killing all of your task terminal and reloading window if errors do not show up in your problems panel.

Warning: You may observe problems not show up in your problems panel if you re-use the same task terminal.
Reference: microsoft/vscode#228883

[sandy081]

Observe that appropriate errors/problems show up in your problems panel view.

I have never seen the problems in the problems view. I tried killing all tasks and open terminals and reload window and none of them works. Is this same as the issue you mentioned or something different?

[connor4312]

Same behavior as Sandeep for me for compilation errors.

Raised errors do work though

[anthonykim1]

Thanks for testing this. How about if you try to run some non-pythonic code such as:

I'm thinking it might be the one newline space before the "SyntaxError: " line specifically that is leading to not picking up only syntax errors problems correctly? I would give a try for other non-syntax errors as I've expected pylance to pick up on Syntax errors in your python file and show it in problems panel.

[anthonykim1]

In fact, for things like syntax/compile time, I would expect Pylance errors should be showing up in your problems panel before&after you run your custom task with my problem matcher.

[bamurtaugh]

How about if you try to run some non-pythonic code such as:

I do get the output you show in that case:

[connor4312]

Yes, that works for me

[bamurtaugh]

Believe this is the same issue already identified above with no problems appearing in this kind of case:

And another: