Read git's yes/no and on/off booleans in get_value - #2229
Merged
Byron merged 2 commits intoSep 7, 2026
Conversation
git accepts yes/no and on/off for a boolean as well as true/false
(git_parse_maybe_bool_text in parse.c), and ConfigParser.getboolean on this
class already accepted all of them. _string_to_value handled only true/false,
under a comment claiming to "try boolean values as git uses them", so the two
accessors disagreed about the same file:
value get_value() getboolean() git config --type=bool
yes 'yes' True true
no 'no' False false
on 'on' True true
off 'off' False false
Returning them as strings was worse than merely inexact. "no" and "off" are
non-empty, so a caller testing the result of get_value got True for a value
git reads as false — the inversion is silent, since nothing raises.
_string_to_value now recognises the same spellings getboolean does. A value
that is not a boolean is untouched, so "meld" is still returned as a string,
and numeric values keep their existing behavior.
Not changed here: get_value also diverges on numeric bases and suffixes
("0x10" and "1k" come back as strings, "010" as 10 where git reads octal 8).
Those change the value rather than its type and are worth their own commit.
Validation: test_get_value_reads_git_boolean_spellings covers the ten
spellings and asserts the two accessors agree; it fails on the previous
revision. test/test_config.py passes (40 passed, 2 skipped), ruff check and
ruff format are clean. test/test_repo.py errors on this clone because
init-tests-after-clone.sh has not been run, unchanged by this commit.
Member
|
Thanks, great catch! |
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.
GitConfigParserdisagrees with itself about the same file.getboolean(fromConfigParser) accepts all of git's boolean spellings;get_valuehandled onlytrue/false, under a comment saying it tries "boolean values as git uses them":get_value()getboolean()git config --type=boolyes'yes'Trueno'no'Falseon'on'Trueoff'off'Falsetrue/falseTrue/FalseReturning them as strings is worse than merely inexact:
"no"and"off"are non-empty, sois True for a value git reads as false, and nothing raises.
_string_to_valuenow recognises the same spellingsgetbooleandoes. Non-boolean values are untouched ("meld"stays a string) and numeric values keep their current behaviour.Deliberately not included:
get_valuealso diverges on numeric bases and suffixes —"0x10"and"1k"come back as strings where git reads 16 and 1024, and"010"becomes 10 where git reads octal 8. Those change a value rather than its type, so they belong in their own commit; happy to send that separately.Validation:
test_get_value_reads_git_boolean_spellingscovers the ten spellings and asserts the two accessors agree — it fails on the parent commit.test/test_config.pypasses (40 passed, 2 skipped).ruff checkandruff format --checkclean at the repo's line length.test/test_repo.pyerrors on my clone becauseinit-tests-after-clone.shhas not been run; unchanged by this commit.