Python CodeQL reports parse error due to a trailing comma used in `match` patterns

[sergei-maertens]

The exact warning is:

Could not process some files due to syntax errors

A parse error occurred while processing /home/runner/work/open-forms/open-forms/src/openforms/formio/validation.py, and as a result this file could not be analyzed. Check the syntax of the file using the python -m py_compile command and correct any invalid syntax.

The offending file: https://github.com/open-formulieren/open-forms/blob/b237275f77153c3541a920a09ccdc2570c46248e/src/openforms/formio/validation.py#L87

Code QL does not seem to understand the Python 3.10 pattern matching correctly yet. The file runs fine and is actually used in production (+ has 100% test coverage).

[MathiasVP]

Hi @sergei-maertens

Thanks for flagging this up. It looks like our parser wasn't handling the trailing comma very well 😅. We're working on a fix now, and I expect that the fix will be included in the next next release of CodeQL (that is, probably, CodeQL version 2.15.4).

[sidshank]

Closing this issue (belatedly) now that the fix has shipped.

[mkashwin]

I am still facing this issue

A parse error occurred while processing /home/runner/work/unifiednamespace/unifiednamespace/02_mqtt-cluster/test/test_uns_spb_helper_metrics.py, and as a result this file could not be analyzed. Check the syntax of the file using the python -m py_compile command and correct any invalid syntax.
I am unable to figure out more details about why this is failing
https://github.com/mkashwin/unifiednamespace/blob/main/02_mqtt-cluster/test/test_uns_spb_helper_metrics.py

[sidshank]

@mkashwin Although the error message printed is the same, the underlying cause seems to be different here. The error originally reported in this issue was a result of a trailing comma used within a match pattern. The file you have referenced doesn't seem to have that problem. I have reopened this issue for now, so we can investigate and help you understand next steps.

[tausbn]

@mkashwin Thank you for supplying a link to the file in question. This greatly eased the debugging process. 🙂

I have created a fix for this issue (which turned out to be the presence of a comment inside a tuple on line 90), and once that fix has been merged, this issue will automatically close. The fix should then become part of version 2.16.4 of the CodeQL CLI, which will likely be released within the next couple of weeks.

[mkashwin]

Wow, that was really fast. Great work and thanks for turning around so quickly

[sidshank]

I'm closing this issue. @mkashwin Although we expect this issue to be fixed in CodeQL CLI 2.16.4, please let us know if it persists for you once you are using that version of CodeQL.

[mkashwin]

Just wanted to confirm that today finally the github action for codeql was released with the CodeQL CLI 2.16.4, and the fix successfully worked on the pipeline run
Thanks @sidshank for your help
Mentioning this in the issue for other CodeQL that there is a lag between the CodeQL CLI release and the CodeQL github action . Please always remember to check both.

[Zxilly]

I also met this error on file https://github.com/Zxilly/go-size-analyzer/blob/45149d986beb03bf9846a5adc6b166bc43cbfb4a/scripts/tests.py. Could you please take a look on this? python -m py_compile tests.py works fine.

The error may occured between L178 - L186