Improve .python-version and runtime.txt error handling#1958
Merged
Conversation
- Improves the error message shown when a `.python-version` file uses an unsupported file encoding. - Improves the error message shown when a `.python-version` or `runtime.txt` file contain an invalid Python version. - Adds support for commented lines in `runtime.txt`, for parity with `.python-version`. - Adjust the metrics so now the raw (unescaped) invalid strings are recorded, for easier debugging. GUS-W-19246790. GUS-W-19280955.
edmorley
force-pushed
the
python-version-file-encoding
branch
from
288b8b6 to
a11743f
Compare
runesoerensen
approved these changes
Nov 12, 2025
Merged
edmorley
added a commit
that referenced
this pull request
Nov 14, 2025
Some further improvements on-top of those made in #1958, based on build error message scenarios seen in Honeycomb. Now, if `.python-version` contains a single ESC control code (which gets categorised as "very short file"), or contains any of the ASCI control codes that result in the file being categorised as "data" (such as NUL), then the "invalid python version" error message variant is shown instead of the "invalid text encoding" variant. In addition, any NULs in the file are substituted with a placeholder to avoid this Bash warning: ``` /tmp/buildpack/lib/python_version.sh: line 104: warning: command substitution: ignored null byte in input ``` See: https://manpages.ubuntu.com/manpages/noble/en/man1/file.1.html GUS-W-20220514.
edmorley
added a commit
that referenced
this pull request
Nov 14, 2025
Some further improvements on-top of those made in #1958, based on build error message scenarios seen in Honeycomb. Now, if `.python-version` contains a single ESC control code (which gets categorised as "very short file"), or contains any of the ASCI control codes that result in the file being categorised as "data" (such as NUL), then the "invalid python version" error message variant is shown instead of the "invalid text encoding" variant. In addition, any NULs in the file are substituted with a placeholder to avoid this Bash warning: ``` /tmp/buildpack/lib/python_version.sh: line 104: warning: command substitution: ignored null byte in input ``` See: https://manpages.ubuntu.com/manpages/noble/en/man1/file.1.html GUS-W-20220514.
edmorley
added a commit
that referenced
this pull request
Nov 14, 2025
…1962) Some further improvements on-top of those made in #1958, based on build error message scenarios seen in Honeycomb. Now, if `.python-version` contains a single ESC control code (which gets categorised as "very short file"), or contains any of the ASCI control codes that result in the file being categorised as "data" (such as NUL), then the "invalid python version" error message variant is shown instead of the "invalid text encoding" variant. In addition, any NULs in the file are substituted with a placeholder to avoid this Bash warning: ``` /tmp/buildpack/lib/python_version.sh: line 104: warning: command substitution: ignored null byte in input ``` See: https://manpages.ubuntu.com/manpages/noble/en/man1/file.1.html GUS-W-20220514.
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.
.python-versionfile uses an unsupported file encoding..python-versionorruntime.txtfile contain an invalid Python version.runtime.txt, for parity with.python-version.GUS-W-19246790.
GUS-W-19280955.