8000 Can non-nil interface fields be considered `nonzero`? · Issue #97 · kr/pretty · GitHub
[go: up one dir, main page]

Skip to content

Can non-nil interface fields be considered nonzero? #97

Open

Description

@ydnar

Hi there, thanks for making this package.

I observed this issue printing a complex data structure with several structs containing interface fields which could be one of many conforming types. A number of those types might be empty structs, where the type is the only relevant information (the zero value is the only value).

If the outer struct with an interface field is printed, the nonzero function returns false because the concrete value of the interface field is zero. An example playground showing this can be found here: https://go.dev/play/p/HjxnCorTQtj

For interface fields, would it be possible to mark the field as nonzero if the field is non-nil, rather than the value of what the field is pointing at?

Thanks!

package main

import (
	"fmt"

	"github.com/kr/pretty"
)

func main() {
	// This should print the zero value for A
	v := &A{Err: nil}
	pretty.Println(v)

	// This will print &main.FormatError{...}
	v.Err = &FormatError{"foo.go", 12}
	pretty.Println(v)

	// This SHOULD print &main.A{Err: main.LogicError{}}, but prints the zero value for A instead.
	v.Err = LogicError{}
	pretty.Println(v)
}

type A struct {
	Err error
}

type FormatError struct {
	File string
	Line int
}

func (err *FormatError) Error() string {
	return fmt.Sprintf("format error: %s:%d", err.File, err.Line)
}

type LogicError struct{}

func (LogicError) Error() string {
	return "logic error"
}

Output

&main.A{}
&main.A{
    Err: &main.FormatError{File:"foo.go", Line:12},
}
&main.A{}

Desired Output

&main.A{}
&main.A{
    Err: &main.FormatError{File:"foo.go", Line:12},
}
&main.A{
    Err: &main.LogicError{},
}

Activity

  1. changed the title [-]False-positives for `nonzero`[/-] [+]Non-nil interface fields are not `nonzero`[/+] on Sep 19, 2023
  2. changed the title [-]Non-nil interface fields are not `nonzero`[/-] [+]Non-nil interface fields should be considered `nonzero`?[/+] on Sep 19, 2023
  3. changed the title [-]Non-nil interface fields should be considered `nonzero`?[/-] [+]Can non-nil interface fields be considered `nonzero`?[/+] on Sep 19, 2023
  4. added a commit that references this issue on Sep 19, 2023
    0880c4e
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions

      0