Add support for the .python-version file#1664
Merged
Conversation
edmorley
force-pushed
the
python-version-file
branch
from
1f42ba7 to
bb32ece
Compare
Malax
approved these changes
Oct 14, 2024
Following on from the recent Python version refactoring, this now adds support for configuring the app's Python version using a `.python-version` file. This file is used by several tools in the Python ecosystem (such as pyenv, `actions/setup-python`, uv), whereas the existing `runtime.txt` file is proprietary to Heroku. This change is the classic Python buildpack equivalent of the Python CNB change here: heroku/buildpacks-python#272 If both a `runtime.txt` file and a `.python-version` file are present, then the `runtime.txt` file will take precedence. However, use of the `.python-version` file is now recommended, since `runtime.txt` will be deprecated in the future. Both the `runtime.txt` file and `.python-version` file take precedence over any Python version specified in a `Pipfile.lock` for Pipenv users. We support the following `.python-version` syntax: - Major Python version (e.g. `3.13`, which will then be resolved to the latest Python 3.13). (This form is recommended, since it allows for Python security updates to be pulled in without having to manually bump the version.) - Exact Python version (e.g. `3.13.0`) - Comments (lines starting with `#`) - Blank lines We don't support the following `.python-version` features: - Specifying multiple Python versions - Prefixing versions with `python-` (since this form is undocumented and will likely be deprecated by pyenv in the future) In addition, the existing `runtime.txt` support has been updated to allow specifying just the major Python version, in order to increase feature parity between the files, and avoid confusion if users try to use the major version only syntax from `.python-version` in their `runtime.txt`. Refs #913. Refs #932. GUS-W-7671453. GUS-W-16821357.
edmorley
force-pushed
the
python-version-file
branch
from
bb32ece to
d3a9e24
Compare
Merged
Member
Author
|
Updated docs: Posted changelog: Updated the Python getting started guide to use |
This was referenced Oct 14, 2024
Member
Author
|
Created entry in the public roadmap: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Following on from the recent Python version refactoring in #1658, this now adds support for configuring the app's Python version using a
.python-versionfile. This file is used by several tools in the Python ecosystem (such as pyenv,actions/setup-python, uv), whereas the existingruntime.txtfile is proprietary to Heroku.This change is the classic Python buildpack equivalent of the Python CNB change here:
heroku/buildpacks-python#272
If both a
runtime.txtfile and a.python-versionfile are present, then theruntime.txtfile will take precedence. However, use of the.python-versionfile is now recommended, sinceruntime.txtwill be deprecated in the future. Both theruntime.txtfile and.python-versionfile take precedence over any Python version specified in aPipfile.lockfor Pipenv users.We support the following
.python-versionsyntax:3.13, which will then be resolved to the latest Python 3.13). (This form is recommended, since it allows for Python security updates to be pulled in without having to manually bump the version.)3.13.0)#)We don't support the following
.python-versionfeatures:python-(since this form is undocumented and will likely be deprecated by pyenv in the future)In addition, the existing
runtime.txtsupport has been updated to allow specifying just the major Python version, in order to increase feature parity between the files, and avoid confusion if users try to use the major version only syntax from.python-versionin theirruntime.txt.Closes #913.
Closes #932.
GUS-W-7671453.
GUS-W-16821357.