Skip to content

section: return a zero-value Key for empty names #395

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
unknwon merged 2 commits into from
Nov 11, 2026
Merged

section: return a zero-value Key for empty names #395

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b1df377
section: return a zero-value Key for empty names
team-humaki Sep 17, 2026
df65545
Keep SetValue on the detached Key("") out of KeysHash
unknwon Nov 11, 2026
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
5 changes: 4 additions & 1 deletion key.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -840,5 +840,8 @@ func (k *Key) SetValue(v string) {
}

k.value = v
k.s.keysHash[k.name] = v
// The Key Section.Key returns for an empty name isn't in the section.
if k.name != "" {
k.s.keysHash[k.name] = v
}
}
11 changes: 8 additions & 3 deletions section.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,12 +163,17 @@ func (s *Section) HasValue(value string) bool {
}

// Key assumes named Key exists in section and returns a zero-value when not.
// For an empty name, the returned Key is not part of the section, so setting
// its value changes nothing in the section.
func (s *Section) Key(name string) *Key {
key, err := s.GetKey(name)
if err != nil {
// It's OK here because the only possible error is empty key name,
// but if it's empty, this piece of code won't be executed.
key, _ = s.NewKey(name, "")
key, err = s.NewKey(name, "")
if err != nil {
// NewKey rejects empty names. Still honor the zero-value
// contract so Key("") is not nil.
return newKey(s, name, "")
}
return key
}
return key
Expand Down
13 changes: 13 additions & 0 deletions section_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,19 @@ func TestSection_Key(t *testing.T) {
assert.Equal(t, "404", k.Name())
})

t.Run("empty key name", func(t *testing.T) {
k := f.Section("").Key("")
require.NotNil(t, k)
assert.Equal(t, "", k.Name())
assert.Equal(t, "", k.Value())
assert.False(t, f.Section("").HasKey(""))

before := f.Section("").KeysHash()
k.SetValue("x")
assert.Equal(t, before, f.Section("").KeysHash())
assert.False(t, f.Section("").HasKey(""))
})

t.Run("key exists in parent section", func(t *testing.T) {
k, err := f.Section("parent").NewKey("AGE", "18")
require.NoError(t, err)
Expand Down