add support for python-version-file #336

adilosa · 2022-02-10T20:02:54Z

Description:
Support for a python-version-file input to read files such as .python-version, similar to setup-node and setup-ruby.

Since python-version has a default of '3.x' it is always specified - and altering that would be a breaking change - here python-version-file overrides python-version. This is opposite to actions/setup-node.

Related issue:
Fixes #291

Check list:

Mark if documentation changes are required. (README was updated)
Mark if tests were added or updated to cover the changes.

lukasz-mitka

I would expect different approach - specify python-version: 'file' to use file as version source.

.github/workflows/test-python.yml

action.yml

adilosa · 2022-03-01T23:56:26Z

I think the presence of the python-version-file is enough of a signal to use the file, without also having to set an additional magic value to python-version. This also keeps it more consistent with the other actions/setup-node and actions/setup-ruby actions.

lukasz-mitka · 2022-03-02T14:20:42Z

I think the presence of the python-version-file is enough of a signal to use the file, without also having to set an additional magic value to python-version. This also keeps it more consistent with the other actions/setup-node and actions/setup-ruby actions.

Ok, I see what you are trying to achieve.

actions/setup-node uses conflict resolution which is missing here https://github.com/actions/setup-node/blob/main/src/main.ts#L80
Also python-version-file should have description that it's inferior to python-version.

Ruby has a nice 'default to file' if version is unspecified which could be handy, but should be a separate PR https://github.com/ruby/setup-ruby/blob/master/action.yml#L9

adilosa · 2022-03-04T01:59:59Z

actions/setup-node uses conflict resolution which is missing here https://github.com/actions/setup-node/blob/main/src/main.ts#L80

Right - I tried that at first, and would have kept it since I was mostly copying that code anyway. But we can't do that here because python-version has a default of '3.x' specified. This means the variable is literally always set and cannot be unset, so a conflict would always happen when python-version-file is specified. Not a huge fan of this, but as stated in the PR comment altering it would be a breaking change.

Also python-version-file should have description that it's inferior to python-version.

Yep, agreed. I'll update that.

Ruby has a nice 'default to file' if version is unspecified which could be handy, but should be a separate PR https://github.com/ruby/setup-ruby/blob/master/action.yml#L9

Also agreed. If it weren't for python-version having a default specified, this would make more sense IMO and be more consistent. Unfortunately will have to be another PR and probably major version increase I suspect.

dsame · 2022-04-19T06:24:55Z

@adilosa Hi Andrew, can you please clarify the current status of the PR? Do you want me to help you with it? Namely i can resolve the conflicts with the fork of your branch - should i?

adilosa · 2022-04-19T23:03:32Z

Hi, I think it's just waiting on review. It seems to have gotten out of date in the meantime.

* upstream/main: (33 commits) Fix virtual-env toolcache links Updated @actions/cache (actions#382) ci(workflow): add 'npm' cache for actions/setup-node in .github/workflows (actions#379) Cache hit output (actions#373) Add pyton-version to setup PyPy output (actions#365) Rework pipenv caching test (actions#375) Update README.md to fix setup-python version in example (actions#368) dist fix (actions#367) Cache on ghes (actions#363) Update dist Use `\n` instead of `os.EOL` Update dist Initialise pyproject.toml Build and format Remove console.log Remove unused file Reduce test matrix Parse values from poetry Release Add more tests ...

adilosa · 2022-04-19T23:06:02Z

I've updated it with the latest upstream changes and rebuilt so there's no longer a merge conflict. Lmk if there's anything else.

dmitry-shibanov · 2022-04-20T09:54:45Z

src/setup-python.ts

@@ -21,6 +22,27 @@ async function cacheDependencies(cache: string, pythonVersion: string) {
  await cacheDistributor.restoreCache();
 }

+function resolveVersionInput(): string {


I think python-version input should take precedence over the python-version-file. It should be similar to this one https://github.com/actions/setup-node/blob/main/src/main.ts#L66-L97

Right, yes, but as noted this would be a breaking change due to the YAML default of python-version: '3.x'. This is a difference from setup-node. It means python-version is always specified and it cannot be unspecified. So, by the setup-node logic, python-version-file would never be used no matter what the user does.

If we wanted to remove the problematic default and require the user to specify at least one of version or version-file, like setup-node does, then the action would start crashing for existing setups who relied on that default. I would guess that's most of them.

I agree that setup-node makes more sense, and parity between the setup-* actions is desirable. I think to do that we'd have to bump major version and document the difference and config migration step. I'm not sure what the procedure is for such changes here, is that what you'd go with?

You're right. The action has default value for the python-version input, that is why it won't be empty string. I think we can rely on python-version-file with precedence.

@dmitry-shibanov @adilosa I would say it might be better to introduce breaking change (and do a major release) to align with setup-node and setup-ruby actions.
With current solution setup-python would end up in minority and potentially confuse users.

It means python-version is always specified

@adilosa i have a rather cumbersome idea how to make the python-version high priority without breaking the existing builds

replace "default value" and for input with some string like "default" or "not-set"

Handle that string by code, resolving to the the "3.x" python version

As a result:

if you have python-version set to some meaningful value - use it as version despite of python-version-file

if you have python-version set to the "default" value and python-version-file is not set - use "3.x"

if you have python-version set to the "default" value and python-version-file is set - use python-version-file

Did not i miss something?

If it comes down to it, I'd be in favor of just doing a major version update and getting setup-python in sync with the other setup- actions.

If it comes down to it, I'd be in favor of just doing a major version update and getting setup-python in sync with the other setup- actions.

Hello @brcrista , so as we all seem to agree to make breaking change and bump major version, please confirm your approve, and either @adilosa or me will complete this piece of work.

Thanks @dsame, sounds good to me.

@adilosa will you make the breaking change?

sounds good - I've updated the PR with the new changes. it should be like the other setup- actions now, which is nice.

dmitry-shibanov · 2022-04-20T09:56:04Z

Hello @adilosa. Could you please add unit tests for the python-version-file input.

vsafonkin · 2022-04-20T09:39:00Z

.github/workflows/test-python.yml

+    - name: Checkout
+      uses: actions/checkout@v2


It will be better to use action/checkout@v3

Sure. This comes from the other tests in this file which all use v2, should I still update this one? or all of them?

All of them, I believe

vsafonkin · 2022-04-20T10:06:22Z

src/setup-python.ts

+function resolveVersionInput(): string {
+  let version = core.getInput('python-version');
+  const versionFileInput = core.getInput('python-version-file');
+
+  if (versionFileInput) {
+    const versionFilePath = path.join(
+      process.env.GITHUB_WORKSPACE!,
+      versionFileInput
+    );
+    if (!fs.existsSync(versionFilePath)) {
+      throw new Error(
+        `The specified node version file at: ${versionFilePath} does not exist`
+      );
+    }
+    version = fs.readFileSync(versionFilePath, 'utf8');
+    core.info(`Resolved ${versionFileInput} as ${version}`);
+  }
+
+  return version;
+}


Does it make sense to use a similar approach from setup-node action? I mean, python-version input has a higher priority than python-version-file input.
@dmitry-shibanov, what do you think about it?

Suggested change

function resolveVersionInput(): string {

let version = core.getInput('python-version');

const versionFileInput = core.getInput('python-version-file');

if (versionFileInput) {

const versionFilePath = path.join(

process.env.GITHUB_WORKSPACE!,

versionFileInput

);

if (!fs.existsSync(versionFilePath)) {

throw new Error(

`The specified node version file at: ${versionFilePath} does not exist`

);

}

version = fs.readFileSync(versionFilePath, 'utf8');

core.info(`Resolved ${versionFileInput} as ${version}`);

}

return version;

}

function resolveVersionInput(): string {

let version = core.getInput('python-version');

const versionFileInput = core.getInput('python-version-file');

if (version && versionFileInput) {

core.warning(

'Both python-version and python-version-file inputs are specified, only python-version will be used'

);

}

if (version) {

return version;

}

...

}

Dimitry mentioned the same, I replied in that thread :)

#336 (comment)

* python-version overrides python-version-file, like setup-node * checks '.python-version' by default if nothing else specified

vsafonkin · 2022-05-18T08:04:03Z

Hi @adilosa, could you please revert the changes in README? It will be better to update the action's documentation after release of the new major version, because it can take some time after merging this PR.

adilosa · 2022-05-20T01:45:22Z

Yep, no problem. I've reverted the README change

adilosa · 2022-05-26T22:53:36Z

resolved the merge conflict. LGTM!

vsafonkin · 2022-05-31T08:57:53Z

Hi @adilosa, could you please update your branch from main to fix poetry cache test?

* upstream/main: Fix output for prerelease version of poetry (actions#409) Update zeit/ncc to vercel/ncc (actions#393) Change PyPy version to rebuild cache

adilosa · 2022-06-02T04:55:25Z

@vsafonkin yep, should be updated now

vsafonkin · 2022-06-02T06:58:42Z

@adilosa, could you please rebuild javascript files?

adilosa · 2022-06-02T07:06:23Z

@vsafonkin updated. I had rerun the build already, but apparently I needed to update the installed dependencies as well.

vsafonkin · 2022-06-02T14:40:09Z

@adilosa, thank you for your contribution! We will release a new major version of setup-python action next week.

plazum · 2022-06-13T15:03:27Z

Oh no!
I'm sad.
I indeed rely on the default 3.x. And you killed it. And all the workflow runs after I updated the use of this action fail.
Well, I know it's my fault for not reading the change logs or something.
But I still think it's good to keep a default selection, so you can use this action in an elegant way.

add support for python-version-file

5d2a353

lukasz-mitka reviewed Feb 28, 2022

View reviewed changes

.github/workflows/test-python.yml Outdated Show resolved Hide resolved

action.yml Outdated Show resolved Hide resolved

Update action.yml

5f05e1d

adilosa closed this Apr 19, 2022

adilosa force-pushed the main branch from 5f05e1d to 4a33d3c Compare April 19, 2022 22:59

adilosa reopened this Apr 19, 2022

adilosa force-pushed the main branch from 91290bd to 5f05e1d Compare April 19, 2022 23:04

adilosa requested a review from a team April 19, 2022 23:04

marko-zivic-93 approved these changes Apr 20, 2022

View reviewed changes

dmitry-shibanov reviewed Apr 20, 2022

View reviewed changes

vsafonkin reviewed Apr 20, 2022

View reviewed changes

dmitry-shibanov approved these changes Apr 20, 2022

View reviewed changes

brcrista approved these changes May 10, 2022

View reviewed changes

vsafonkin approved these changes May 11, 2022

View reviewed changes

marko-zivic-93 approved these changes May 11, 2022

View reviewed changes

adilosa added 6 commits May 16, 2022 19:37

Merge branch 'actions:main' into main

dbfda6e

update to v4, remove python-version default

abfae9a

* python-version overrides python-version-file, like setup-node * checks '.python-version' by default if nothing else specified

update tests, update to checkout@v3

e30cfd0

update build

bce43cf

appease the linter

c38a07e

remove old test for default python version

74e704b

adilosa added 2 commits May 19, 2022 18:43

Merge branch 'actions:main' into main

a6063fd

revert readme changes

0139695

vsafonkin approved these changes May 23, 2022

View reviewed changes

marko-zivic-93 approved these changes May 23, 2022

View reviewed changes

Merge branch 'main' into main

0669e36

Merge remote-tracking branch 'upstream/main'

59e9c1d

* upstream/main: Fix output for prerelease version of poetry (actions#409) Update zeit/ncc to vercel/ncc (actions#393) Change PyPy version to rebuild cache

update build

76b3fbd

vsafonkin merged commit 53e1529 into actions:main Jun 2, 2022

machikoyasuda mentioned this pull request Jun 8, 2022

chore(deps): bump actions/setup-python from 3 to 4 cal-itp/benefits#652

Merged

This was referenced Jun 13, 2022

Under v4, not specifying a python-version results in a failure to run #433

Closed

Bump actions/setup-python from 3 to 4 globus/globus-sdk-python#579

Merged

mayeut mentioned this pull request Jun 13, 2022

Update GitHub Action examples pypa/cibuildwheel#1135

Merged

fregante mentioned this pull request Oct 25, 2022

Support reading the version from from runtime.txt #530

Closed

dmitry-shibanov mentioned this pull request Nov 21, 2022

pythonLocation no longer being set in v4 #537

Closed

5 tasks

stefafafan mentioned this pull request Dec 6, 2022

Suggestion: perl-version-file input support? shogo82148/actions-setup-perl#1359

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add support for python-version-file #336

add support for python-version-file #336

adilosa commented Feb 10, 2022

lukasz-mitka left a comment

adilosa commented Mar 1, 2022

lukasz-mitka commented Mar 2, 2022

adilosa commented Mar 4, 2022

dsame commented Apr 19, 2022

adilosa commented Apr 19, 2022

adilosa commented Apr 19, 2022

dmitry-shibanov Apr 20, 2022

adilosa Apr 20, 2022

dmitry-shibanov Apr 20, 2022

lukasz-mitka Apr 21, 2022

dsame Apr 28, 2022

brcrista Apr 28, 2022

dsame May 6, 2022

brcrista May 10, 2022

dsame May 16, 2022

adilosa May 17, 2022

dmitry-shibanov commented Apr 20, 2022

vsafonkin Apr 20, 2022

adilosa Apr 20, 2022

vsafonkin Apr 21, 2022

vsafonkin Apr 20, 2022 •

edited

Loading

adilosa Apr 20, 2022

vsafonkin commented May 18, 2022 •

edited

Loading

adilosa commented May 20, 2022

adilosa commented May 26, 2022

vsafonkin commented May 31, 2022

adilosa commented Jun 2, 2022

vsafonkin commented Jun 2, 2022

adilosa commented Jun 2, 2022 •

edited

Loading

vsafonkin commented Jun 2, 2022

plazum commented Jun 13, 2022 •

edited

Loading

add support for python-version-file #336

add support for python-version-file #336

Conversation

adilosa commented Feb 10, 2022

lukasz-mitka left a comment

Choose a reason for hiding this comment

adilosa commented Mar 1, 2022

lukasz-mitka commented Mar 2, 2022

adilosa commented Mar 4, 2022

dsame commented Apr 19, 2022

adilosa commented Apr 19, 2022

adilosa commented Apr 19, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dmitry-shibanov commented Apr 20, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vsafonkin Apr 20, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vsafonkin commented May 18, 2022 • edited Loading

adilosa commented May 20, 2022

adilosa commented May 26, 2022

vsafonkin commented May 31, 2022

adilosa commented Jun 2, 2022

vsafonkin commented Jun 2, 2022

adilosa commented Jun 2, 2022 • edited Loading

vsafonkin commented Jun 2, 2022

plazum commented Jun 13, 2022 • edited Loading

vsafonkin Apr 20, 2022 •

edited

Loading

vsafonkin commented May 18, 2022 •

edited

Loading

adilosa commented Jun 2, 2022 •

edited

Loading

plazum commented Jun 13, 2022 •

edited

Loading