Support free threaded Python versions like '3.13t' (#973)

* Support free threaded Python versions like '3.13t'

Python wheels, pyenv, and a number of other tools use 't' in the Python
version number to identify free threaded builds. For example, '3.13t',
'3.14.0a1', '3.14t-dev'.

This PR supports that syntax in `actions/setup-python`, strips the "t",
and adds "-freethreading" to the architecture to select the correct
Python version.

See #771

* Add free threading to advanced usage documentation

* Fix desugaring of `3.13.1t` and add test case.

* Add freethreaded input and fix handling of prerelease versions

* Fix lint

* Add 't' suffix to python-version output

* Use distinct cache key for free threaded Python

* Remove support for syntax like '3.14.0a1'

* Clarify use of 't' suffix

* Improve error message when trying to use free threaded Python versions before 3.13

src/find-python.ts

@@ -35,16 +35,28 @@ export async function useCpythonVersion(
   architecture: string,
   updateEnvironment: boolean,
   checkLatest: boolean,
-  allowPreReleases: boolean
+  allowPreReleases: boolean,
+  freethreaded: boolean
 ): Promise<InstalledVersion> {
   let manifest: tc.IToolRelease[] | null = null;
-  const desugaredVersionSpec = desugarDevVersion(version);
+  const {version: desugaredVersionSpec, freethreaded: versionFreethreaded} =
+    desugarVersion(version);
   let semanticVersionSpec = pythonVersionToSemantic(
     desugaredVersionSpec,
     allowPreReleases
   );
+  if (versionFreethreaded) {
+    // Use the freethreaded version if it was specified in the input, e.g., 3.13t
+    freethreaded = true;
+  }
   core.debug(`Semantic version spec of ${version} is ${semanticVersionSpec}`);
 
+  if (freethreaded) {
+    // Free threaded versions use an architecture suffix like `x64-freethreaded`
+    core.debug(`Using freethreaded version of ${semanticVersionSpec}`);
+    architecture += '-freethreaded';
+  }
+
   if (checkLatest) {
     manifest = await installer.getManifest();
     const resolvedVersion = (
@@ -90,16 +102,22 @@ export async function useCpythonVersion(
 
   if (!installDir) {
     const osInfo = await getOSInfo();
-    throw new Error(
-      [
-        `The version '${version}' with architecture '${architecture}' was not found for ${
-          osInfo
-            ? `${osInfo.osName} ${osInfo.osVersion}`
-            : 'this operating system'
-        }.`,
-        `The list of all available versions can be found here: ${installer.MANIFEST_URL}`
-      ].join(os.EOL)
+    const msg = [
+      `The version '${version}' with architecture '${architecture}' was not found for ${
+        osInfo
+          ? `${osInfo.osName} ${osInfo.osVersion}`
+          : 'this operating system'
+      }.`
+    ];
+    if (freethreaded) {
+      msg.push(
+        `Free threaded versions are only available for Python 3.13.0 and later.`
+      );
+    }
+    msg.push(
+      `The list of all available versions can be found here: ${installer.MANIFEST_URL}`
     );
+    throw new Error(msg.join(os.EOL));
   }
 
   const _binDir = binDir(installDir);
@@ -153,10 +171,38 @@ export async function useCpythonVersion(
   }
 
   const installed = versionFromPath(installDir);
-  core.setOutput('python-version', installed);
+  let pythonVersion = installed;
+  if (freethreaded) {
+    // Add the freethreaded suffix to the version (e.g., 3.13.1t)
+    pythonVersion += 't';
+  }
+  core.setOutput('python-version', pythonVersion);
   core.setOutput('python-path', pythonPath);
 
-  return {impl: 'CPython', version: installed};
+  return {impl: 'CPython', version: pythonVersion};
+}
+
+/* Desugar free threaded and dev versions */
+export function desugarVersion(versionSpec: string) {
+  const {version, freethreaded} = desugarFreeThreadedVersion(versionSpec);
+  return {version: desugarDevVersion(version), freethreaded};
+}
+
+/* Identify freethreaded versions like, 3.13t, 3.13.1t, 3.13t-dev.
+ * Returns the version without the `t` and the architectures suffix, if freethreaded */
+function desugarFreeThreadedVersion(versionSpec: string) {
+  const majorMinor = /^(\d+\.\d+(\.\d+)?)(t)$/;
+  if (majorMinor.test(versionSpec)) {
+    return {version: versionSpec.replace(majorMinor, '$1'), freethreaded: true};
+  }
+  const devVersion = /^(\d+\.\d+)(t)(-dev)$/;
+  if (devVersion.test(versionSpec)) {
+    return {
+      version: versionSpec.replace(devVersion, '$1$3'),
+      freethreaded: true
+    };
+  }
+  return {version: versionSpec, freethreaded: false};
 }
 
 /** Convert versions like `3.8-dev` to a version like `~3.8.0-0`. */

src/setup-python.ts

@@ -92,6 +92,7 @@ async function run() {
     const versions = resolveVersionInput();
     const checkLatest = core.getBooleanInput('check-latest');
     const allowPreReleases = core.getBooleanInput('allow-prereleases');
+    const freethreaded = core.getBooleanInput('freethreaded');
 
     if (versions.length) {
       let pythonVersion = '';
@@ -132,7 +133,8 @@ async function run() {
             arch,
             updateEnvironment,
             checkLatest,
-            allowPreReleases
+            allowPreReleases,
+            freethreaded
           );
           pythonVersion = installed.version;
           core.info(`Successfully set up ${installed.impl} (${pythonVersion})`);