README
¶
Python's repr() for Go 
This package attempts to represent Go values in a form that can be used almost directly in Go source code.
Unfortunately, some values (such as pointers to basic types) can not be represented directly in Go.
These values will be represented as &<value>. eg. &23
Example
type test struct {
S string
I int
A []int
}
func main() {
repr.Print(&test{
S: "String",
I: 123,
A: []int{1, 2, 3},
})
}
Outputs
&main.test{S: "String", I: 123, A: []int{1, 2, 3}}
Why repr and not pp?
pp is designed for printing coloured output to consoles, with (seemingly?) no way to disable this. If you don't want coloured output (eg. for use in diffs, logs, etc.) repr is for you.
Why repr and not go-spew?
Repr deliberately contains much less metadata about values. It is designed to (generally) be copyable directly into source code.
Compare go-spew:
(parser.expression) (len=1 cap=1) {
(parser.alternative) (len=1 cap=1) {
([]interface {}) (len=1 cap=1) {
(*parser.repitition)(0xc82000b220)({
expression: (parser.expression) (len=2 cap=2) {
(parser.alternative) (len=1 cap=1) {
([]interface {}) (len=1 cap=1) {
(parser.str) (len=1) "a"
}
},
(parser.alternative) (len=1 cap=1) {
([]interface {}) (len=1 cap=1) {
(*parser.self)(0x593ef0)({
})
}
}
}
})
}
}
}
To repr:
parser.expression{
parser.alternative{
[]interface {}{
&parser.repitition{
expression: parser.expression{
parser.alternative{
[]interface {}{
parser.str("a"),
},
},
parser.alternative{
[]interface {}{
&parser.self{ },
},
},
},
},
},
},
}
Documentation
¶
Overview ¶
Package repr attempts to represent Go values in a form that can be copy-and-pasted into source code directly.
Some values (such as pointers to basic types) can not be represented directly in Go. These values will be output as `&<value>`. eg. `&23`
Index ¶
- Variables
- func Print(vs ...any)
- func Println(vs ...any)
- func String(v any, options ...Option) string
- type Option
- func AlwaysIncludeType() Option
- func ExplicitTypes(ok bool) Option
- func Hide[T any]() Option
- func HideField(name string) Option
- func IgnoreGoStringer() Option
- func IgnorePrivate() Option
- func Indent(indent string) Option
- func NoIndent() Option
- func OmitEmpty(omitEmpty bool) Option
- func OmitZero(omitZero bool) Option
- func ScalarLiterals() Option
- type Printer
Constants ¶
This section is empty.
Variables ¶
var Default = New(os.Stdout, Indent(" "))
Default prints to os.Stdout with two space indentation.
Functions ¶
Types ¶
type Option ¶
type Option func(o *Printer)
An Option modifies the default behaviour of a Printer.
func AlwaysIncludeType ¶
func AlwaysIncludeType() Option
AlwaysIncludeType always includes explicit type information for each item.
func ExplicitTypes ¶
ExplicitTypes adds explicit typing to slice and map struct values that would normally be inferred by Go.
func HideField ¶ added in v0.5.0
HideField excludes fields of structs that match the given name from representation.
func IgnoreGoStringer ¶
func IgnoreGoStringer() Option
IgnoreGoStringer disables use of the .GoString() method.
func IgnorePrivate ¶ added in v0.3.0
func IgnorePrivate() Option
IgnorePrivate disables private field members from output.
func OmitEmpty ¶
OmitEmpty sets whether empty field members should be omitted from output.
Empty field members are either the zero type, or zero-length maps and slices.
func OmitZero ¶ added in v0.5.0
OmitZero sets whether zero field members should be omitted from output.
Field members are considered zero if they have an IsZero method that returns true, or if reflect.Value.IsZero returns true. Empty maps and slices are not zero.
func ScalarLiterals ¶ added in v0.3.0
func ScalarLiterals() Option
ScalarLiterals forces the use of literals for scalars, rather than a string representation if available.
For example, `time.Hour` will be printed as `time.Duration(3600000000000)` rather than `time.Duration(1h0m0s)`.
Source Files