Add a fix for python 3.12 #1928

aeisenberg · 2023-10-06T20:07:31Z

The python extractor does not yet support 3.12. Check for this and instead make sure we run python 3.11. Only need to check on windows since we are extremely unlikely to be running 3.12 on linux or macos.

Merge / deployment checklist

Confirm this change is backwards compatible with existing workflows.
Confirm the readme has been updated if necessary.
Confirm the changelog has been updated if necessary.

The python extractor does not yet support 3.12. Check for this and instead make sure we run python 3.11. Only need to check on windows since we are extremely unlikely to be running 3.12 on linux or macos.

adityasharad

Clever. Looks reasonable.
Can we have an integration test on Windows that calls setup-python with 3.12 to exercise this path?

adityasharad · 2023-10-06T20:16:32Z

python-setup/check_python12.ps1

+    Write-Host "Python 3.11 detected, using this version instead of 3.12+."
+    Write-Output "PY_PYTHON3=3.11" | Out-File -FilePath $Env:GITHUB_ENV -Encoding utf8 -Append
+  } else {
+    Write-Host "FAILURE: Python 3.12+ is not supported. Please install Python 3.11."


Optional.

Suggested change

Write-Host "FAILURE: Python 3.12+ is not supported. Please install Python 3.11."

Write-Host "FAILURE: Python 3.12+ is not supported, and Python 3.11 could not be detected on the system. Please install Python 3.11."

angelapwen · 2023-10-06T20:20:42Z

python-setup/check_python12.ps1

+#! /usr/bin/pwsh
+
+# If we are running greater than or equal to python 3.12, change py to run version 3.11
+Write-Host "Checking python version"


Suggested change

Write-Host "Checking python version"

Write-Host "Checking Python version"

Super-nit

Actually, I think all Python should be python.

aeisenberg · 2023-10-06T20:30:21Z

Should be simple enough to create a test.

Also: - Update changelog - Fix comments in check_python script

criemen · 2023-10-06T20:56:33Z

I think we should query a feature flag from the CLI so that we can turn off this workaround from within the CLI once we've a release out that fixes the python extractor.

aeisenberg · 2023-10-06T20:59:03Z

Good call. I can check for less than 2.15.0.

criemen · 2023-10-06T21:02:46Z

I think the new tool-features feature (see https://github.com/github/codeql-action/pull/1909/files#diff-a2b4f46aa09bd648db18893b59331e2e037dfb60954c80383d820703b09d2519) would be more appropriate to use.

aeisenberg · 2023-10-06T21:05:31Z

That requires adding the feature to the CLI directly, no?

criemen · 2023-10-06T21:06:58Z

As far as I understand it yes, but only once we're actually shipping new python-3.12 support - which should be doable, as we release the python extractor together with the CLI.

aeisenberg · 2023-10-06T21:08:09Z

Ah...I see what you're saying. I choose a feature name now and that will be the feature name in the version of codeql that has the fix. Good idea.

github-advanced-security · 2023-10-06T21:08:21Z

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

CHANGELOG.md

angelapwen

Looks good modulo question on the changelog file!

angelapwen · 2023-10-06T22:31:41Z

CHANGELOG.md

@@ -4,7 +4,7 @@ See the [releases page](https://github.com/github/codeql-action/releases) for th

 ## [UNRELEASED]

-No user facing changes.
+- Add a workaround python 3.12, which is not supported in CodeQL CLI version 2.14.6 or earlier. If you are running an analysis on Windows and using python 3.12 or later, the CodeQL Action will switch to running python 3.11. If python 3.11 is not found, then the workflow will fail.


Suggested change

- Add a workaround python 3.12, which is not supported in CodeQL CLI version 2.14.6 or earlier. If you are running an analysis on Windows and using python 3.12 or later, the CodeQL Action will switch to running python 3.11. If python 3.11 is not found, then the workflow will fail.

- Add a workaround for python 3.12, which is not supported in CodeQL CLI version 2.14.6 or earlier. If you are running an analysis on Windows and using python 3.12 or later, the CodeQL Action will switch to running python 3.11. If python 3.11 is not found in this case, then the workflow will fail.

Just realized it's missing a word..

Thanks I'll put this in a follow-up.

Add a fix for python 3.12

d091652

The python extractor does not yet support 3.12. Check for this and instead make sure we run python 3.11. Only need to check on windows since we are extremely unlikely to be running 3.12 on linux or macos.

aeisenberg requested review from a team as code owners October 6, 2023 20:07

adityasharad reviewed Oct 6, 2023

View reviewed changes

angelapwen reviewed Oct 6, 2023

View reviewed changes

aeisenberg requested review from adityasharad and angelapwen October 6, 2023 20:50

Add integration test

028bacb

Also: - Update changelog - Fix comments in check_python script

aeisenberg force-pushed the aeisenberg/fix-python312 branch from 9ebed2f to 028bacb Compare October 6, 2023 20:52

aeisenberg force-pushed the aeisenberg/fix-python312 branch from bd30ad1 to 8a81c5b Compare October 6, 2023 21:12

Add a feature flag to turn this off for newer versions of codeql

669c610

aeisenberg force-pushed the aeisenberg/fix-python312 branch from 8a81c5b to 669c610 Compare October 6, 2023 21:17

angelapwen reviewed Oct 6, 2023

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

angelapwen previously approved these changes Oct 6, 2023

View reviewed changes

Update CHANGELOG.md

94b6970

aeisenberg dismissed angelapwen’s stale review via 94b6970 October 6, 2023 21:49

aeisenberg enabled auto-merge October 6, 2023 21:49

angelapwen approved these changes Oct 6, 2023

View reviewed changes

angelapwen reviewed Oct 6, 2023

View reviewed changes

angelapwen disabled auto-merge October 6, 2023 22:32

aeisenberg enabled auto-merge October 6, 2023 22:34

aeisenberg merged commit 0d5c2e0 into main Oct 6, 2023
391 checks passed

aeisenberg deleted the aeisenberg/fix-python312 branch October 6, 2023 23:42

aeisenberg mentioned this pull request Oct 7, 2023

Update CHANGELOG.md #1930

Merged

github-actions bot mentioned this pull request Oct 9, 2023

Merge main into releases/v2 #1932

Merged

6 tasks

aeisenberg mentioned this pull request Nov 10, 2023

Fix failing workflows #1984

Merged

3 tasks

angelapwen mentioned this pull request Mar 11, 2024

Update default bundle to 2.16.4 #2185

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a fix for python 3.12 #1928

Add a fix for python 3.12 #1928

aeisenberg commented Oct 6, 2023 •

edited

adityasharad left a comment

adityasharad Oct 6, 2023

angelapwen Oct 6, 2023

aeisenberg Oct 6, 2023

aeisenberg commented Oct 6, 2023

criemen commented Oct 6, 2023

aeisenberg commented Oct 6, 2023

criemen commented Oct 6, 2023

aeisenberg commented Oct 6, 2023

criemen commented Oct 6, 2023

aeisenberg commented Oct 6, 2023

github-advanced-security bot commented Oct 6, 2023

angelapwen left a comment

angelapwen Oct 6, 2023

aeisenberg Oct 6, 2023

	Write-Host "FAILURE: Python 3.12+ is not supported. Please install Python 3.11."
	Write-Host "FAILURE: Python 3.12+ is not supported, and Python 3.11 could not be detected on the system. Please install Python 3.11."

	Write-Host "Checking python version"
	Write-Host "Checking Python version"

	- Add a workaround python 3.12, which is not supported in CodeQL CLI version 2.14.6 or earlier. If you are running an analysis on Windows and using python 3.12 or later, the CodeQL Action will switch to running python 3.11. If python 3.11 is not found, then the workflow will fail.
	- Add a workaround for python 3.12, which is not supported in CodeQL CLI version 2.14.6 or earlier. If you are running an analysis on Windows and using python 3.12 or later, the CodeQL Action will switch to running python 3.11. If python 3.11 is not found in this case, then the workflow will fail.

Add a fix for python 3.12 #1928

Add a fix for python 3.12 #1928

Conversation

aeisenberg commented Oct 6, 2023 • edited

Merge / deployment checklist

adityasharad left a comment

Choose a reason for hiding this comment

adityasharad Oct 6, 2023

Choose a reason for hiding this comment

angelapwen Oct 6, 2023

Choose a reason for hiding this comment

aeisenberg Oct 6, 2023

Choose a reason for hiding this comment

aeisenberg commented Oct 6, 2023

criemen commented Oct 6, 2023

aeisenberg commented Oct 6, 2023

criemen commented Oct 6, 2023

aeisenberg commented Oct 6, 2023

criemen commented Oct 6, 2023

aeisenberg commented Oct 6, 2023

github-advanced-security bot commented Oct 6, 2023

angelapwen left a comment

Choose a reason for hiding this comment

angelapwen Oct 6, 2023

Choose a reason for hiding this comment

aeisenberg Oct 6, 2023

Choose a reason for hiding this comment

aeisenberg commented Oct 6, 2023 •

edited