書式 %v のカスタマイズ

今回も小ネタで。

お馴染みの fmt.Printf() 関数などで使われる書式（verb）のうち，今回は %v の出力をカスタマイズすることを考えてみる。

基本型における %v 書式の出力

まずは %v の定義から

Verb Description
%v the value in a default format
when printing structs, the plus flag (%+v) adds field names
%#v a Go-syntax representation of the value

更に基本型については %v は以下の書式と対応している。

Type Default Verb
bool %t
int, int8, … %d
uint, uint8, … %d, %#x if printed with %#v
float32, complex64, … %g
string %s
chan %p
pointer %p

構造体や配列などの複合オブジェクトについては以下のように展開される。

Compound Object Format
struct {field0 field1 ...}
array, slice [elem0 elem1 ...]
maps map[key1:value1 key2:value2 ...]
pointer to above &{}, &[], &map[]

ちょっと試し書きをしてみよう。 たとえば，以下のような構造体とデータを考えてみる。

type Planet struct {
    Name string
    Mass float64
}

var planets = []Planet{
    {Name: "Mercury", Mass: 0.055},
    {Name: "Venus", Mass: 0.815},
    {Name: "Earth", Mass: 1.0},
    {Name: "Mars", Mass: 0.107},
}

この planets を %v を使って出力してみよう。 こんな感じ。

fmt.Printf("%v", planets)
// Output:
// [{Mercury 0.055} {Venus 0.815} {Earth 1} {Mars 0.107}]

fmt.Printf("%+v", planets)
// Output:
// [{Name:Mercury Mass:0.055} {Name:Venus Mass:0.815} {Name:Earth Mass:1} {Name:Mars Mass:0.107}]

fmt.Printf("%#v", planets)
// Output:
// []main.Planet{main.Planet{Name:"Mercury", Mass:0.055}, main.Planet{Name:"Venus", Mass:0.815}, main.Planet{Name:"Earth", Mass:1}, main.Planet{Name:"Mars", Mass:0.107}}

Stringer および GoStringer インタフェース

fmt.Stringer および fmt.GoStringer インタフェースを持つ型であれば %v の出力をカスタマイズできる。 fmt.Stringer および fmt.GoStringer インタフェースの定義は以下の通り。

// *.go is implemented by any value that has a String method,
// which defines the ``native'' format for that value.
// The String method is used to print values passed as an operand
// to any format that accepts a string or to an unformatted printer
// such as Print.
type Stringer interface {
    String() string
}

// GoStringer is implemented by any value that has a GoString method,
// which defines the Go syntax for that value.
// The GoString method is used to print values passed as an operand
// to a %#v format.
type GoStringer interface {
    GoString() string
}

先ほどの Planet 型に fmt.Stringer および fmt.GoStringer インタフェースを組み込んでみよう。

func (p Planet) String() string {
    return fmt.Sprintf("%s (%.3f)", p.Name, p.Mass)
}

func (p Planet) GoString() string {
    return fmt.Sprintf(`main.Planet{Name:%s, Mass:%.3f}`, strconv.Quote(p.Name), p.Mass)
}

これで %v の出力は以下のように変わる。

fmt.Printf("%v", planets)
// Output:
// [Mercury (0.055) Venus (0.815) Earth (1.000) Mars (0.107)]

fmt.Printf("%+v", planets)
// Output:
// [Mercury (0.055) Venus (0.815) Earth (1.000) Mars (0.107)]

fmt.Printf("%#v", planets)
// Output:
// []main.Planet{main.Planet{Name:"Mercury", Mass:0.055}, main.Planet{Name:"Venus", Mass:0.815}, main.Planet{Name:"Earth", Mass:1.000}, main.Planet{Name:"Mars", Mass:0.107}}

%v および %+v が fmt.Stringer に %#v が fmt.GoStringer に対応しているのが分かると思う。

Formatter インタフェース

fmt.Stringer インタフェースを使ったカスタマイズの欠点は %v と %+v を区別できないことだ。 %v と %+v を区別できるよう詳細な操作を行いたいのであれば fmt.Formatter インタフェースを組み込む。 fmt.Formatter インタフェースの定義は以下の通り。

// Formatter is the interface implemented by values with a custom formatter.
// The implementation of Format may call Sprint(f) or Fprint(f) etc.
// to generate its output.
type Formatter interface {
    Format(f State, c rune)
}

更に引数の fmt.State もインタフェース型で以下のように定義されている。

// State represents the printer state passed to custom formatters.
// It provides access to the io.Writer interface plus information about
// the flags and options for the operand's format specifier.
type State interface {
    // Write is the function to call to emit formatted output to be printed.
    Write(b []byte) (n int, err error)
    // Width returns the value of the width option and whether it has been set.
    Width() (wid int, ok bool)
    // Precision returns the value of the precision option and whether it has been set.
    Precision() (prec int, ok bool)

    // Flag reports whether the flag c, a character, has been set.
    Flag(c int) bool
}

つまり自作の Format() メソッド内では State.Write(), State.Width(), State.Precision(), State.Flag() 各メソッドが使える。 これらを使って出力の整形を行えるわけだ（State.Write() は io.Writer インタフェースとマッチしている点にも注目）。

では Planet 型に fmt.Formatter インタフェースを組み込んでみる。 こんな感じでどうだろう。

func (p Planet) Format(s fmt.State, verb rune) {
    switch verb {
    case 'v':
        switch {
        case s.Flag('#'):
            io.Copy(s, strings.NewReader(p.GoString()))
        case s.Flag('+'):
            fmt.Fprintf(s, `{"Name":%s,"Mass":%.3f}`, strconv.Quote(p.Name), p.Mass)
        default:
            io.Copy(s, strings.NewReader(p.String()))
        }
    case 's':
        io.Copy(s, strings.NewReader(p.String()))
    default: //bad verb
        fmt.Fprintf(s, `%%!%c(%s)`, verb, p.GoString())
    }
}

これで %v の出力は以下のように変わる。

fmt.Printf("%v", planets)
// Output:
// [Mercury (0.055) Venus (0.815) Earth (1.000) Mars (0.107)]

fmt.Printf("%+v", planets)
// Output:
// [{"Name":"Mercury","Mass":0.055} {"Name":"Venus","Mass":0.815} {"Name":"Earth","Mass":1.000} {"Name":"Mars","Mass":0.107}]

fmt.Printf("%#v", planets)
// Output:
// []main.Planet{main.Planet{Name:"Mercury", Mass:0.055}, main.Planet{Name:"Venus", Mass:0.815}, main.Planet{Name:"Earth", Mass:1.000}, main.Planet{Name:"Mars", Mass:0.107}}

fmt.Formatter インタフェースを組み込めば細かい制御ができるようになるが，取りうる書式を全て記述しないといけないのが面倒である1。 状況によって使い分けるのがいいだろう。

ブックマーク

参考図書

photo
プログラミング言語Go
アラン・ドノバン (著), ブライアン・カーニハン (著), 柴田芳樹 (著)
丸善出版 2016-06-20 (Release 2021-07-13)
Kindle版
B099928SJD (ASIN)
評価     

Kindle 版出た！ 一部内容が古びてしまったが，この本は Go 言語の教科書と言ってもいいだろう。感想はこちら。

reviewed by Spiegel on 2021-05-22 (powered by PA-APIv5)

  1. 型名（%T）とポインタ値（%p）は fmt.Formatter の制御外になるようだ。 ↩︎