Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump python app #2639

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Bump python app #2639

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
088812e
use current setup-python v5
sicheste Nov 29, 2024
22eabc2
use Python 3.13
sicheste Nov 29, 2024
b14b473
Use Python 3.12.
sicheste Dec 8, 2024
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
6 changes: 3 additions & 3 deletions ci/python-app.yml
View file
Open in desktop
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍🏻

  • consistent meta-data and values
  • versions are stable and current

Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ jobs:

steps:
- uses: actions/checkout@v4
- name: Set up Python 3.10
uses: actions/setup-python@v3
- name: Set up Python 3.13
uses: actions/setup-python@v5
with:
python-version: "3.10"
python-version: "3.13"

This comment was marked as resolved.

Sign in to view

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Regarding the variables:
I've checked some other files. Have not seen that it was done like this somehwere. For example the android, ant and maven templates are using the version number in the step name and for the version requirement. But always explicitly written. So yes, technically a considerable idea, but have not seen that it is done somewhere else like this.

Using Python 3.12 instead of 3.13 makes sense and I have changed.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
python-version: "3.13"
python-version: "3.x"

https://devguide.python.org/versions/#supported-versions
Testing on the latest version of Python may catch new language incompatibilities before most users notice them.

Copy link

@reactive-firewall reactive-firewall Dec 8, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Plea for Pinning an exact version

I'll also re-iterate what I previously marked knitpicky as it now directly applies to this, see below:

Consider Python 3.12 might be more appropriate than 3.13 for GHA

Tip

knit-picky or out-of-scope:
Looks like version 3.12 will be the cached version (while 3.13 is the
latest it will probably be slower for some GitHub Actions)
see actions/runner-images#10636
and note the cached versions for python.

Should still work though; Just slightly slower.

In conclusion; pick one (exactly one):

  • 3.12 - for tuned value based on GitHub Action's runners.
  • 3.13 - the latest available version of Python as per your link; "Should still work though; Just slightly slower" due to not being cached.
  • any other less current value in the form defined by the actions/setup-pythonv@5 (3.9.20|3.10|3.11) (included for completeness)
  • any invalid version - fall-back to GHA image default installed version. (included for completeness)

Important

This is not to say your rational is wrong, (only the suggested implementation is sub-optimal)

To also implement checking for the latest version please refer to this guide

or as code:

# Rest of config is unchanged
  - uses: actions/setup-python@v5
    with:
      # Version range or exact version of Python or PyPy to use, using SemVer's version range syntax. Reads from .python-version if unset.
      python-version: '3.13'
      # Check every time for updates? 
      check-latest: true

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the idea using a cached Python version by default. So I switched to 3.12.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In python-publish it is given with 3.x. So would not be the first template when setting it to .x here.

Copy link

@reactive-firewall reactive-firewall Dec 9, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In python-publish it is given with 3.x. So would not be the first template when setting it to .x here.

Oops 🙊

My oversight; Correction: it is a runtime error, not a syntax error. I'll remove the incorrect and confusing phrasing from my previous comment.

For those curious, my full rational,

TL;DR

This gave me pause, at first, as you are quite correct, many (e.g. python-publish, and even the GitHub guides use 3.x all over, and only sometimes do they document why). After some digging all I could find was:

name: Python package

on: [push]

jobs:
  build:

    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4
      - name: Set up Python
        # This is the version of the action for setting up Python, not the Python version.
        uses: actions/setup-python@v5
        with:
          # Semantic version range syntax or exact version of a Python version
          python-version: '3.x'
          # Optional - x64 or x86 architecture, defaults to x64
          architecture: 'x64'
      # You can test your matrix by printing the current Python version
      - name: Display Python version
        run: python -c "import sys; print(sys.version)"

which makes sense if you are familiar with Semantic Version range syntax which boils down to almost the same thing as I expected (e.g. PEP-440 and the current Python packaging version spec)
The notable difference is 3.x is invalid as a Semantic Version but is considered a local version x of version with Major 3

so I checked the code which documents the same thing, (albeit without the example placeholder of 3.x). So I wanted to see what it did with the version, and deep inside the massive dist/index.js of the python-setup action is a function resolveVersionInput() to resolve the input range that would essentially return ['3.x'], from there it is used by the run() function to attempt to download it via the function useCpythonVersion (because 3.x will not match other cases like 'PyPy' etc.) there it finally is parsed (and unless python3.x cpython is already installed, will fail and fall-back on a default of void 0 (e.g. None version), if there is a python3.x installed on the GHA image is most likely the documented default of 3.12) resulting eventually in a harmless runtime-error, and reporting the actually installed version via the output python-version (same name as input) which would currently be 3.12.

In conclusion: 3.x is still not advised, as omitting the value would be preferred to achieve the same behavior;
the original 3.13 should work;
and I still recommend the cached 3.12.

Informative references

Summary

In summary: This topic has been thoroughly explored now, I agree with @cclauss that just using the latest stable would be a fine alternative, but not better than the other already mentioned options.

@sicheste 3.12 for leveraging caching in GHAs, looks good, 👍🏻

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the long analysis and explanation.

So, now someone can merge it :)

- name: Install dependencies
run: |
python -m pip install --upgrade pip
Expand Down
Loading