Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
e348410
Remove Ubuntu 20.04 from workflows due to deprecation from 2025-04-15…
v-aparnajyothi-y Apr 11, 2025
6ed2c67
Fix for Candidate Not Iterable Error (#1082)
v-aparnajyothi-y Apr 17, 2025
5d95bc1
Bump semver and @types/semver (#1091)
dependabot[bot] Apr 22, 2025
30eafe9
Bump prettier from 2.8.8 to 3.5.3 (#1046)
dependabot[bot] Apr 22, 2025
a26af69
Bump ts-jest from 29.1.2 to 29.3.2 (#1081)
dependabot[bot] Apr 24, 2025
5db1cf9
Enhance reading from .python-version (#787)
krystof-k May 21, 2025
5fa0ee6
Bump @actions/tool-cache from 2.0.1 to 2.0.2 (#1095)
dependabot[bot] Jun 18, 2025
e9c40fb
Add support for `pip-version` (#1129)
v-priyagupta108 Jun 20, 2025
1264885
Enhance cache-dependency-path handling to support files outside the w…
v-aparnajyothi-y Jun 25, 2025
532b046
Add Architecture-Specific PATH Management for Python with --user Flag…
v-aparnajyothi-y Jul 3, 2025
88ffd4d
Include python version in PyPy python-version output (#1110)
cdce8p Jul 21, 2025
3c6f142
update documentation (#1156)
v-priya-kinthali Jul 23, 2025
36da51d
Add version parsing from Pipfile (#1067)
aradkdj Jul 24, 2025
03bb615
Bump idna from 2.9 to 3.7 in /__tests__/data (#843)
dependabot[bot] Jul 29, 2025
fbeb884
Bump form-data to fix critical vulnerabilities #182 & #183 (#1163)
v-aparnajyothi-y Jul 30, 2025
9322b3c
Upgrade setuptools to 78.1.1 to fix path traversal vulnerability in P…
v-aparnajyothi-y Aug 4, 2025
f62a0e2
Change missing cache directory error to warning (#1182)
v-aparnajyothi-y Aug 26, 2025
5b668cf
Bump actions/checkout from 4 to 5 (#1181)
dependabot[bot] Aug 26, 2025
65b0712
Clarify pythonLocation behavior for PyPy and GraalPy in environment v…
v-aparnajyothi-y Aug 26, 2025
3d1e2d2
Revert "Enhance cache-dependency-path handling to support files outsi…
v-aparnajyothi-y Aug 28, 2025
e797f83
Upgrade to node 24 (#1164)
salmanmkc Sep 4, 2025
4267e28
Bump urllib3 from 1.26.19 to 2.5.0 in /__tests__/data and document br…
dependabot[bot] Sep 18, 2025
2e3e4b1
Add support for pip-install input (#1201)
v-gowridurgad Sep 26, 2025
18566f8
Improve wording and "fix example" (remove 3.13) on testing against pr…
yarikoptic Oct 14, 2025
bba65e5
Bump typescript from 5.4.2 to 5.9.3 and update docs/advanced-usage.md…
dependabot[bot] Oct 20, 2025
cfd55ca
graalpy: add graalpy early-access and windows builds (#880)
timfel Oct 22, 2025
443da59
Bump actions/publish-action from 0.3.0 to 0.4.0 & Documentation updat…
dependabot[bot] Nov 12, 2025
97aeb3e
Bump requests from 2.32.2 to 2.32.4 in /__tests__/data (#1130)
dependabot[bot] Nov 13, 2025
bfc4944
Bump prettier from 3.5.3 to 3.6.2 (#1234)
dependabot[bot] Nov 18, 2025
83679a8
Bump @types/node from 24.1.0 to 24.9.1 and update macos-13 to macos-1…
dependabot[bot] Nov 24, 2025
4f41a90
Bump urllib3 from 2.5.0 to 2.6.0 in /__tests__/data (#1253)
dependabot[bot] Dec 30, 2025
bfe8cc5
Upgrade @actions dependencies to Node 24 compatible versions (#1259)
salmanmkc Jan 20, 2026
a309ff8
Bump urllib3 from 2.6.0 to 2.6.3 in /__tests__/data (#1264)
dependabot[bot] Jan 22, 2026
918d5f3
Merge tag 'v6.2.0' into sync/upstream-v6.2.0
guptaankit015 Mar 26, 2026
80339e6
chore: rebuild dist and lockfile after upstream sync
guptaankit015 Mar 26, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Enhance reading from .python-version (actions#787)
* Enhance reading from .python-version

* Fix typos

* Fix lint

* Add built files

* Don't use EOL versions in `utils.test.ts`

* Fix Prettier

* Don't use unreleased versions in `utils.test.ts`

* Update versions in `utils.test.ts` again
  • Loading branch information
krystof-k authored May 21, 2025
commit 5db1cf9a59fb97c40a68accab29236f0da7e94db
66 changes: 47 additions & 19 deletions __tests__/utils.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import {
validatePythonVersionFormatForPyPy,
isCacheFeatureAvailable,
getVersionInputFromFile,
getVersionInputFromPlainFile,
getVersionsInputFromPlainFile,
getVersionInputFromTomlFile,
getNextPageUrl,
isGhes,
Expand All @@ -24,10 +24,10 @@ jest.mock('@actions/core');

describe('validatePythonVersionFormatForPyPy', () => {
it.each([
['3.6', true],
['3.7', true],
['3.6.x', false],
['3.7.x', false],
['3.12', true],
['3.13', true],
['3.12.x', false],
['3.13.x', false],
['3.x', false],
['3', false]
])('%s -> %s', (input, expected) => {
Expand Down Expand Up @@ -95,24 +95,52 @@ const tempDir = path.join(
);

describe('Version from file test', () => {
it.each([getVersionInputFromPlainFile, getVersionInputFromFile])(
it.each([getVersionsInputFromPlainFile, getVersionInputFromFile])(
'Version from plain file test',
async _fn => {
await io.mkdirP(tempDir);
const pythonVersionFileName = 'python-version.file';
const pythonVersionFilePath = path.join(tempDir, pythonVersionFileName);
const pythonVersionFileContent = '3.7';
const pythonVersionFileContent = '3.13';
fs.writeFileSync(pythonVersionFilePath, pythonVersionFileContent);
expect(_fn(pythonVersionFilePath)).toEqual([pythonVersionFileContent]);
}
);
it.each([getVersionsInputFromPlainFile, getVersionInputFromFile])(
'Versions from multiline plain file test',
async _fn => {
await io.mkdirP(tempDir);
const pythonVersionFileName = 'python-version.file';
const pythonVersionFilePath = path.join(tempDir, pythonVersionFileName);
const pythonVersionFileContent = '3.13\r\n3.12';
fs.writeFileSync(pythonVersionFilePath, pythonVersionFileContent);
expect(_fn(pythonVersionFilePath)).toEqual(['3.13', '3.12']);
}
);
it.each([getVersionsInputFromPlainFile, getVersionInputFromFile])(
'Version from complex plain file test',
async _fn => {
await io.mkdirP(tempDir);
const pythonVersionFileName = 'python-version.file';
const pythonVersionFilePath = path.join(tempDir, pythonVersionFileName);
const pythonVersionFileContent =
'3.13/envs/virtualenv\r# 3.12\n3.11\r\n3.10\r\n 3.9 \r\n';
fs.writeFileSync(pythonVersionFilePath, pythonVersionFileContent);
expect(_fn(pythonVersionFilePath)).toEqual([
'3.13',
'3.11',
'3.10',
'3.9'
]);
}
);
it.each([getVersionInputFromTomlFile, getVersionInputFromFile])(
'Version from standard pyproject.toml test',
async _fn => {
await io.mkdirP(tempDir);
const pythonVersionFileName = 'pyproject.toml';
const pythonVersionFilePath = path.join(tempDir, pythonVersionFileName);
const pythonVersion = '>=3.7.0';
const pythonVersion = '>=3.13.0';
const pythonVersionFileContent = `[project]\nrequires-python = "${pythonVersion}"`;
fs.writeFileSync(pythonVersionFilePath, pythonVersionFileContent);
expect(_fn(pythonVersionFilePath)).toEqual([pythonVersion]);
Expand All @@ -124,7 +152,7 @@ describe('Version from file test', () => {
await io.mkdirP(tempDir);
const pythonVersionFileName = 'pyproject.toml';
const pythonVersionFilePath = path.join(tempDir, pythonVersionFileName);
const pythonVersion = '>=3.7.0';
const pythonVersion = '>=3.13.0';
const pythonVersionFileContent = `[tool.poetry.dependencies]\npython = "${pythonVersion}"`;
fs.writeFileSync(pythonVersionFilePath, pythonVersionFileContent);
expect(_fn(pythonVersionFilePath)).toEqual([pythonVersion]);
Expand All @@ -145,9 +173,9 @@ describe('Version from file test', () => {
async _fn => {
const toolVersionFileName = '.tool-versions';
const toolVersionFilePath = path.join(tempDir, toolVersionFileName);
const toolVersionContent = 'python 3.9.10\nnodejs 16';
const toolVersionContent = 'python 3.13.2\nnodejs 16';
fs.writeFileSync(toolVersionFilePath, toolVersionContent);
expect(_fn(toolVersionFilePath)).toEqual(['3.9.10']);
expect(_fn(toolVersionFilePath)).toEqual(['3.13.2']);
}
);

Expand All @@ -156,9 +184,9 @@ describe('Version from file test', () => {
async _fn => {
const toolVersionFileName = '.tool-versions';
const toolVersionFilePath = path.join(tempDir, toolVersionFileName);
const toolVersionContent = '# python 3.8\npython 3.9';
const toolVersionContent = '# python 3.13\npython 3.12';
fs.writeFileSync(toolVersionFilePath, toolVersionContent);
expect(_fn(toolVersionFilePath)).toEqual(['3.9']);
expect(_fn(toolVersionFilePath)).toEqual(['3.12']);
}
);

Expand All @@ -167,9 +195,9 @@ describe('Version from file test', () => {
async _fn => {
const toolVersionFileName = '.tool-versions';
const toolVersionFilePath = path.join(tempDir, toolVersionFileName);
const toolVersionContent = ' python 3.10 ';
const toolVersionContent = ' python 3.13 ';
fs.writeFileSync(toolVersionFilePath, toolVersionContent);
expect(_fn(toolVersionFilePath)).toEqual(['3.10']);
expect(_fn(toolVersionFilePath)).toEqual(['3.13']);
}
);

Expand All @@ -178,9 +206,9 @@ describe('Version from file test', () => {
async _fn => {
const toolVersionFileName = '.tool-versions';
const toolVersionFilePath = path.join(tempDir, toolVersionFileName);
const toolVersionContent = 'python v3.9.10';
const toolVersionContent = 'python v3.13.2';
fs.writeFileSync(toolVersionFilePath, toolVersionContent);
expect(_fn(toolVersionFilePath)).toEqual(['3.9.10']);
expect(_fn(toolVersionFilePath)).toEqual(['3.13.2']);
}
);

Expand All @@ -189,9 +217,9 @@ describe('Version from file test', () => {
async _fn => {
const toolVersionFileName = '.tool-versions';
const toolVersionFilePath = path.join(tempDir, toolVersionFileName);
const toolVersionContent = 'python pypy3.10-7.3.14';
const toolVersionContent = 'python pypy3.10-7.3.19';
fs.writeFileSync(toolVersionFilePath, toolVersionContent);
expect(_fn(toolVersionFilePath)).toEqual(['pypy3.10-7.3.14']);
expect(_fn(toolVersionFilePath)).toEqual(['pypy3.10-7.3.19']);
}
);

Expand Down
39 changes: 27 additions & 12 deletions dist/setup/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -96929,7 +96929,7 @@ function cacheDependencies(cache, pythonVersion) {
}
function resolveVersionInputFromDefaultFile() {
const couples = [
['.python-version', utils_1.getVersionInputFromPlainFile]
['.python-version', utils_1.getVersionsInputFromPlainFile]
];
for (const [versionFile, _fn] of couples) {
(0, utils_1.logWarning)(`Neither 'python-version' nor 'python-version-file' inputs were supplied. Attempting to find '${versionFile}' file.`);
Expand Down Expand Up @@ -97066,7 +97066,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", ({ value: true }));
exports.getDownloadFileName = exports.getNextPageUrl = exports.getBinaryDirectory = exports.getVersionInputFromFile = exports.getVersionInputFromToolVersions = exports.getVersionInputFromPlainFile = exports.getVersionInputFromTomlFile = exports.getOSInfo = exports.getLinuxInfo = exports.logWarning = exports.isCacheFeatureAvailable = exports.isGhes = exports.validatePythonVersionFormatForPyPy = exports.writeExactPyPyVersionFile = exports.readExactPyPyVersionFile = exports.getPyPyVersionFromPath = exports.isNightlyKeyword = exports.validateVersion = exports.createSymlinkInFolder = exports.WINDOWS_PLATFORMS = exports.WINDOWS_ARCHS = exports.IS_MAC = exports.IS_LINUX = exports.IS_WINDOWS = void 0;
exports.getDownloadFileName = exports.getNextPageUrl = exports.getBinaryDirectory = exports.getVersionInputFromFile = exports.getVersionInputFromToolVersions = exports.getVersionsInputFromPlainFile = exports.getVersionInputFromTomlFile = exports.getOSInfo = exports.getLinuxInfo = exports.logWarning = exports.isCacheFeatureAvailable = exports.isGhes = exports.validatePythonVersionFormatForPyPy = exports.writeExactPyPyVersionFile = exports.readExactPyPyVersionFile = exports.getPyPyVersionFromPath = exports.isNightlyKeyword = exports.validateVersion = exports.createSymlinkInFolder = exports.WINDOWS_PLATFORMS = exports.WINDOWS_ARCHS = exports.IS_MAC = exports.IS_LINUX = exports.IS_WINDOWS = void 0;
/* eslint no-unsafe-finally: "off" */
const cache = __importStar(__nccwpck_require__(5116));
const core = __importStar(__nccwpck_require__(7484));
Expand Down Expand Up @@ -97247,7 +97247,7 @@ function extractValue(obj, keys) {
* If none is present, returns an empty list.
*/
function getVersionInputFromTomlFile(versionFile) {
core.debug(`Trying to resolve version form ${versionFile}`);
core.debug(`Trying to resolve version from ${versionFile}`);
let pyprojectFile = fs_1.default.readFileSync(versionFile, 'utf8');
// Normalize the line endings in the pyprojectFile
pyprojectFile = pyprojectFile.replace(/\r\n/g, '\n');
Expand Down Expand Up @@ -97280,15 +97280,30 @@ function getVersionInputFromTomlFile(versionFile) {
}
exports.getVersionInputFromTomlFile = getVersionInputFromTomlFile;
/**
* Python version extracted from a plain text file.
*/
function getVersionInputFromPlainFile(versionFile) {
core.debug(`Trying to resolve version form ${versionFile}`);
const version = fs_1.default.readFileSync(versionFile, 'utf8').trim();
core.info(`Resolved ${versionFile} as ${version}`);
return [version];
* Python versions extracted from a plain text file.
* - Resolves multiple versions from multiple lines.
* - Handles pyenv-virtualenv pointers (e.g. `3.10/envs/virtualenv`).
* - Ignores empty lines and lines starting with `#`
* - Trims whitespace.
*/
function getVersionsInputFromPlainFile(versionFile) {
core.debug(`Trying to resolve versions from ${versionFile}`);
const content = fs_1.default.readFileSync(versionFile, 'utf8').trim();
const lines = content.split(/\r\n|\r|\n/);
const versions = lines
.map(line => {
if (line.startsWith('#') || line.trim() === '') {
return undefined;
}
let version = line.trim();
version = version.split('/')[0];
return version;
})
.filter(version => version !== undefined);
core.info(`Resolved ${versionFile} as ${versions.join(', ')}`);
return versions;
}
exports.getVersionInputFromPlainFile = getVersionInputFromPlainFile;
exports.getVersionsInputFromPlainFile = getVersionsInputFromPlainFile;
/**
* Python version extracted from a .tool-versions file.
*/
Expand Down Expand Up @@ -97331,7 +97346,7 @@ function getVersionInputFromFile(versionFile) {
return getVersionInputFromToolVersions(versionFile);
}
else {
return getVersionInputFromPlainFile(versionFile);
return getVersionsInputFromPlainFile(versionFile);
}
}
exports.getVersionInputFromFile = getVersionInputFromFile;
Expand Down
4 changes: 2 additions & 2 deletions src/setup-python.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import {
logWarning,
IS_MAC,
getVersionInputFromFile,
getVersionInputFromPlainFile
getVersionsInputFromPlainFile
} from './utils';

function isPyPyVersion(versionSpec: string) {
Expand All @@ -35,7 +35,7 @@ async function cacheDependencies(cache: string, pythonVersion: string) {

function resolveVersionInputFromDefaultFile(): string[] {
const couples: [string, (versionFile: string) => string[]][] = [
['.python-version', getVersionInputFromPlainFile]
['.python-version', getVersionsInputFromPlainFile]
];
for (const [versionFile, _fn] of couples) {
logWarning(
Expand Down
31 changes: 23 additions & 8 deletions src/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ function extractValue(obj: any, keys: string[]): string | undefined {
* If none is present, returns an empty list.
*/
export function getVersionInputFromTomlFile(versionFile: string): string[] {
core.debug(`Trying to resolve version form ${versionFile}`);
core.debug(`Trying to resolve version from ${versionFile}`);

let pyprojectFile = fs.readFileSync(versionFile, 'utf8');
// Normalize the line endings in the pyprojectFile
Expand Down Expand Up @@ -269,13 +269,28 @@ export function getVersionInputFromTomlFile(versionFile: string): string[] {
}

/**
* Python version extracted from a plain text file.
* Python versions extracted from a plain text file.
* - Resolves multiple versions from multiple lines.
* - Handles pyenv-virtualenv pointers (e.g. `3.10/envs/virtualenv`).
* - Ignores empty lines and lines starting with `#`
* - Trims whitespace.
*/
export function getVersionInputFromPlainFile(versionFile: string): string[] {
core.debug(`Trying to resolve version form ${versionFile}`);
const version = fs.readFileSync(versionFile, 'utf8').trim();
core.info(`Resolved ${versionFile} as ${version}`);
return [version];
export function getVersionsInputFromPlainFile(versionFile: string): string[] {
core.debug(`Trying to resolve versions from ${versionFile}`);
const content = fs.readFileSync(versionFile, 'utf8').trim();
const lines = content.split(/\r\n|\r|\n/);
const versions = lines
.map(line => {
if (line.startsWith('#') || line.trim() === '') {
return undefined;
}
let version: string = line.trim();
version = version.split('/')[0];
return version;
})
.filter(version => version !== undefined) as string[];
core.info(`Resolved ${versionFile} as ${versions.join(', ')}`);
return versions;
}

/**
Expand Down Expand Up @@ -319,7 +334,7 @@ export function getVersionInputFromFile(versionFile: string): string[] {
} else if (versionFile.match('.tool-versions')) {
return getVersionInputFromToolVersions(versionFile);
} else {
return getVersionInputFromPlainFile(versionFile);
return getVersionsInputFromPlainFile(versionFile);
}
}

Expand Down