FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

fix: skip a UTF-8 BOM when reading config files by geek-alpha · Pull Request #2249 · gitpython-developers/GitPython · GitHub

  1. gitpython-developers
  2. GitPython

Repository navigation

fix: skip a UTF-8 BOM when reading config files #2249

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
Byron merged 1 commit into from
Sep 21, 2026
Conversation 1 Commits 1 Checks 47 Files changed
Merged

fix: skip a UTF-8 BOM when reading config files #2249

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension .py  (2) All 1 file type selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
9 changes: 7 additions & 2 deletions git/config.py
Show comments
View file
Open in desktop
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
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -550,9 +550,14 @@ def parse_value(value: str) -> str:

while True:
# We assume to read binary!
line = fp.readline().decode(defenc)
if not line:
raw_line = fp.readline()
if not raw_line:
break
if lineno == 0 and raw_line.startswith(b"\xef\xbb\xbf"):
# A UTF-8 BOM is not part of the content. git skips it, so a
# config file written by a Windows editor still parses.
raw_line = raw_line[3:]
line = raw_line.decode(defenc)
lineno = lineno + 1
# Comment or blank line?
if line.strip() == "" or self.re_comment.match(line):
Expand Down
11 changes: 11 additions & 0 deletions test/test_config.py
Show comments
View file
Open in desktop
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
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -354,6 +354,17 @@ def test_comment_backslash_does_not_continue_value(self, rw_dir):
with GitConfigParser(config_path) as config:
self.assertEqual(config.get_value("a", "x"), "two")

def test_utf8_bom_is_skipped_like_git(self):
"""git skips a UTF-8 BOM at the start of a config file, so one written by
a Windows editor still parses. Expectations are what
`git config -f <file> --list` prints on git 2.47.3."""
content = b"\xef\xbb\xbf[core]\n\tbare = true\n"
config_file = io.BytesIO(content)
config_file.name = "bom.config"
config = GitConfigParser(config_file)
config.read()
self.assertIs(config.get_value("core", "bare"), True)

def test_config_value_with_trailing_new_line(self):
config_content = b'[section-header]\nkey:"value\n"'
config_file = io.BytesIO(config_content)
Expand Down
Loading
Back | FazBrowse Home | New Git URL