Skip to content

GH-119496: accept UTF-8 BOM in .pth files #119503

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

Merged
ncoghlan merged 3 commits into from
May 24, 2024
Merged

GH-119496: accept UTF-8 BOM in .pth files #119503

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
77a45b0
Accept UTF-8 BOM in .pth files
ncoghlan May 24, 2024
1c2b313
Update site.py
ncoghlan May 24, 2024
1828c45
Simpliy decode call
ncoghlan May 24, 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
Next Next commit
Accept UTF-8 BOM in .pth files 
`Out-File -Encoding utf8` in Windows Powershell 5.1 emits
UTF-8 with a BOM maker, which the regular `utf-8` codec
decodes incorrectly. `utf-8-sig` accepts a BOM, but also
works correctly without one.
  • Loading branch information
@ncoghlan
ncoghlan authored May 24, 2024
commit 77a45b0e3a7ddabbf3500d7f22a13bfb157b291e
4 changes: 3 additions & 1 deletion Lib/site.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,9 @@ def addpackage(sitedir, name, known_paths):
return

try:
pth_content = pth_content.decode()
# Accept BOM markers in .pth files as we do in source files
# (Windows PowerShell 5.1 makes it hard to emit UTF-8 files without a BOM)
pth_content = pth_content.decode(encoding="utf8-sig")
except UnicodeDecodeError:
# Fallback to locale encoding for backward compatibility.
# We will deprecate this fallback in the future.
Expand Down