Add support for the .python-version file
#272
Merged
Conversation
This file contains 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
This 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. For now, if both a `runtime.txt` file and a `.python-version` file are present, then the `runtime.txt` file will take precedence. In the future, support for `runtime.txt` will be deprecated (and eventually removed) in favour of the `.python-version` file. We support the following `.python-version` syntax: - Major Python version (e.g. `3.12`, which will then be resolved to the latest Python 3.12). (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.12.6`) - 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 in the future) Since the `.python-version` file (unlike `runtime.txt`) supports specifying just the Python major version, adding support also required: - adding a mapping of major versions to the latest patch releases - explicit handling for EOL/unrecognised major versions - adding the concept of a "requested Python version" vs the resolved Python version (which should hopefully tie in well with use of a manifest in the future) In addition, the "origin" of a Python version now has to be tracked, so that build output can state which file was used, or in the case of invalid version errors, which file needs to be fixed by the user. Closes #6. Closes #9. GUS-W-12151504. GUS-W-11475071.
edmorley
commented
Sep 16, 2024
Malax
approved these changes
Sep 17, 2024
heroku-linguist bot
added a commit
that referenced
this pull request
Sep 17, 2024
## heroku/python ### Added - The Python version can now be configured using a `.python-version` file. Both the `3.X` and `3.X.Y` version forms are supported. ([#272](#272)) ### Changed - pip is now only available during the build, and is longer included in the final app image. ([#264](#264)) - Improved the error messages shown when an end-of-life or unknown Python version is requested. ([#272](#272))
Merged
heroku-linguist bot
added a commit
to heroku/cnb-builder-images
that referenced
this pull request
Sep 17, 2024
## heroku/python ### Added - The Python version can now be configured using a `.python-version` file. Both the `3.X` and `3.X.Y` version forms are supported. ([#272](heroku/buildpacks-python#272)) ### Changed - pip is now only available during the build, and is longer included in the final app image. ([#264](heroku/buildpacks-python#264)) - Improved the error messages shown when an end-of-life or unknown Python version is requested. ([#272](heroku/buildpacks-python#272))
edmorley
added a commit
to heroku/heroku-buildpack-python
that referenced
this pull request
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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This 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.For now, if both a
runtime.txtfile and a.python-versionfile are present, then theruntime.txtfile will take precedence. In the future, support forruntime.txtwill be deprecated (and eventually removed) in favour of the.python-versionfile.We support the following
.python-versionsyntax:3.12, which will then be resolved to the latest Python 3.12). (This form is recommended, since it allows for Python security updates to be pulled in without having to manually bump the version.)3.12.6)#)We don't support the following
.python-versionfeatures:python-(since this form is undocumented and will likely be deprecated in the future)Since the
.python-versionfile (unlikeruntime.txt) supports specifying just the Python major version, adding support also required:In addition, the "origin" of a Python version now has to be tracked, so that build output can state which file was used, or in the case of invalid version errors, which file needs to be fixed by the user.
Closes #6.
Closes #9.
GUS-W-12151504.
GUS-W-11475071.