[インデックス 10145] ファイルの概要

このコミットは、Go言語の標準ライブラリfmtパッケージにおいて、os.Error型の値を適切に処理するための変更を導入しています。特に、fmtパッケージが値を文字列に変換する際の優先順位にos.Errorインターフェースの処理を追加し、将来的にerrorインターフェースが導入された際にgofixツールによる自動修正を容易にすることを目的としています。

コミット

commit 0e81e508bedec7e25aafc5b3939901dbc1d67914
Author: Russ Cox <rsc@golang.org>
Date:   Thu Oct 27 21:20:44 2011 -0700

    fmt: handle os.Error values
    
    Handling os.Error is no different than handling fmt.Stringer
    here, so the code is redundant now, but it will be necessary
    once error goes in.
    
    Adding it now will make gofix fix it.
    
    R=r
    CC=golang-dev
    https://golang.org/cl/5331045

GitHub上でのコミットページへのリンク

https://github.com/golang/go/commit/0e81e508bedec7e25aafc5b3939901dbc1d67914

元コミット内容

このコミットの元のメッセージは以下の通りです。

fmt: handle os.Error values

Handling os.Error is no different than handling fmt.Stringer here, so the code is redundant now, but it will be necessary once error goes in.

Adding it now will make gofix fix it.

R=r CC=golang-dev https://golang.org/cl/5331045

変更の背景

このコミットが行われた2011年10月は、Go言語がまだ活発に開発されており、言語仕様や標準ライブラリが進化していた時期にあたります。特に、エラーハンドリングのメカニズムは重要な変更点の一つでした。

当時のGo言語では、エラーを表すためにos.Errorというインターフェースが広く使われていました。しかし、Go言語の設計思想として、より汎用的なエラー表現を可能にするために、最終的にはerrorという組み込みインターフェース（type error interface { Error() string }）が導入されることになります。

このコミットの背景には、以下の点が挙げられます。

os.Errorからerrorへの移行準備: os.Errorは、その名の通りosパッケージで定義されたインターフェースであり、エラーハンドリングの汎用的なメカニズムとしては不十分でした。より汎用的なerrorインターフェースへの移行が計画されており、このコミットはその移行をスムーズにするための準備段階と位置づけられます。
fmtパッケージの統一的なエラー表示: fmtパッケージは、Goプログラムにおいて様々な型の値を文字列として整形・出力する役割を担っています。エラー値も例外ではなく、ユーザーにとって分かりやすい形で表示される必要があります。このコミットは、os.Error型の値がfmt.Stringerと同様に適切に処理されるようにすることで、エラー表示の一貫性を保とうとしています。
gofixツールの活用: gofixは、Go言語のバージョンアップに伴うAPIの変更や言語仕様の変更に対して、既存のコードを自動的に修正するためのツールです。このコミットメッセージにある「Adding it now will make gofix fix it.」という記述は、os.Errorからerrorへの移行時にgofixがこの変更を検知し、自動的にコードを修正できるように、事前にfmtパッケージにos.Errorの処理ロジックを組み込んでおくという意図を示しています。これにより、開発者が手動で大量のコードを修正する手間を省くことができました。

前提知識の解説

Go言語の`fmt`パッケージ

fmtパッケージは、Go言語におけるフォーマットI/O（入力/出力）を提供する標準ライブラリです。C言語のprintfやscanfに似た機能を提供し、様々な型の値を文字列に変換したり、文字列から値をパースしたりすることができます。

fmtパッケージの主な機能には以下のようなものがあります。

Printf, Sprintf, Fprintf: フォーマット指定子（例: %d, %s, %v）を使って値を整形し、標準出力、文字列、または指定されたio.Writerに出力します。
Print, Println: 値をデフォルトのフォーマットで出力します。
Scanf, Sscanf, Fscanf: フォーマット指定子を使って文字列から値をパースします。

`fmt.Stringer`インターフェース

fmt.Stringerは、Go言語の標準ライブラリfmtパッケージで定義されているインターフェースです。

type Stringer interface {
    String() string
}

このインターフェースを実装する型は、String()というメソッドを持つ必要があります。fmtパッケージの関数（例: fmt.Print, fmt.Sprintf）は、引数として渡された値がStringerインターフェースを実装している場合、そのString()メソッドを呼び出して値を文字列に変換します。これにより、カスタム型を人間が読める形式で出力できるようになります。

`os.Error`インターフェース（旧）

Go言語の初期のバージョンでは、エラーを表すためにos.Errorというインターフェースが使われていました。これはosパッケージで定義されており、String()メソッドを持つという点でfmt.Stringerと似ていました。

// osパッケージで定義されていたインターフェース（概念的な表現）
type Error interface {
    String() string
}

しかし、このos.Errorは、より汎用的なエラーハンドリングのニーズに対応するため、後にGo言語の組み込みインターフェースであるerrorに置き換えられました。

`error`インターフェース（現行）

現在のGo言語では、エラーは組み込みのerrorインターフェースによって表現されます。

type error interface {
    Error() string
}

このインターフェースもError()というメソッドを持ち、エラーの詳細を文字列として返します。os.Errorからerrorへの移行は、Go言語のエラーハンドリングをよりシンプルで一貫性のあるものにするための重要な変更でした。

`gofix`ツール

gofixは、Go言語のツールチェーンに含まれるコマンドラインツールです。Go言語のバージョンアップに伴うAPIの変更や言語仕様の変更に対して、既存のGoソースコードを自動的に修正する機能を提供します。例えば、古いAPI呼び出しを新しいAPI呼び出しに変換したり、非推奨になった構文を修正したりすることができます。

このコミットの文脈では、os.Errorからerrorへの移行時に、gofixがos.Errorを使用しているコードを自動的にerrorを使用するように修正できるように、fmtパッケージがos.Errorを認識し、適切に処理するロジックを事前に組み込むという意図がありました。

技術的詳細

このコミットの技術的な核心は、fmtパッケージが値を文字列に変換する際の内部ロジックに、os.Errorインターフェースの処理を追加した点にあります。

fmtパッケージは、与えられた値を整形する際に、いくつかのルールに基づいてその値を文字列に変換します。その優先順位は通常、以下のようになります（このコミット以前の一般的な理解）。

fmt.Formatterインターフェースの実装
fmt.Stringerインターフェースの実装
その他の型に応じたデフォルトの整形

このコミットは、この優先順位にos.Errorインターフェースの処理を挿入しています。具体的には、fmt.Formatterの次にos.Errorをチェックし、その後にfmt.Stringerをチェックするように変更されました。

コミットメッセージにある「Handling os.Error is no different than handling fmt.Stringer here, so the code is redundant now, but it will be necessary once error goes in.」という記述は、当時のos.ErrorがString()メソッドを持つという点でfmt.Stringerと機能的に重複していることを認めています。しかし、将来的にerrorインターフェースが導入された際に、gofixがos.Errorからerrorへの移行を自動的に処理できるように、この「冗長な」コードをあえて追加していることを示唆しています。

これは、Go言語の開発チームが、言語の進化と既存コードの互換性を両立させるために、gofixのようなツールを積極的に活用していたことを示す良い例です。事前に特定の型（この場合はos.Error）の処理ロジックを組み込んでおくことで、将来の大きな変更（errorインターフェースの導入）に対する準備を進めていたと言えます。

コアとなるコードの変更箇所

このコミットでは、主に以下の2つのファイルが変更されています。

src/pkg/fmt/doc.go
src/pkg/fmt/print.go

`src/pkg/fmt/doc.go`の変更

doc.goファイルは、fmtパッケージのドキュメンテーションコメントを含んでいます。このファイルでは、fmtパッケージが値を文字列に変換する際のルールに関する説明が更新されました。

--- a/src/pkg/fmt/doc.go
+++ b/src/pkg/fmt/doc.go
@@ -89,10 +89,14 @@
 	If an operand implements interface Formatter, that interface
 	can be used for fine control of formatting.
 
-	If an operand implements method String() string that method
+	Next, if an operand implements the error interface, the Error method
 	will be used to convert the object to a string, which will then
-	be formatted as required by the verb (if any). To avoid
-	recursion in cases such as
+	be formatted as required by the verb (if any).
+
+	Finally, if an operand implements method String() string that method
+	will be used to convert the object to a string, which will then
+	be formatted as required by the verb (if any).
+	To avoid recursion in cases such as
 	\t\ttype X int
 	\t\tfunc (x X) String() string { return Sprintf("%d", x) }\
 	cast the value before recurring:

変更点:

String()メソッドを持つStringerインターフェースの前に、「errorインターフェースを実装している場合、Errorメソッドが使用される」という説明が追加されました。
これにより、fmtパッケージが値を文字列に変換する際の優先順位が明確化され、Formatter -> error -> Stringerの順で処理されることが示唆されています。

`src/pkg/fmt/print.go`の変更

print.goファイルは、fmtパッケージの実際の整形ロジックを含んでいます。このファイルでは、handleMethods関数が変更され、os.Error型の値を特別に処理するロジックが追加されました。

--- a/src/pkg/fmt/print.go
+++ b/src/pkg/fmt/print.go
@@ -630,12 +630,23 @@ func (p *pp) handleMethods(verb rune, plus, goSyntax bool, depth int) (wasString
 			return
 		}
 	} else {
-		// Is it a Stringer?
-		if stringer, ok := p.field.(Stringer); ok {
+		// Is it an error or Stringer?
+		// The duplication in the bodies is necessary:
+		// setting wasString and handled and deferring catchPanic
+		// must happen before calling the method.
+		switch v := p.field.(type) {
+		case os.Error:
 			wasString = false
 			handled = true
 			defer p.catchPanic(p.field, verb)
-			p.printField(stringer.String(), verb, plus, false, depth)
+			p.printField(v.String(), verb, plus, false, depth)
+			return
+
+		case Stringer:
+			wasString = false
+			handled = true
+			defer p.catchPanic(p.field, verb)
+			p.printField(v.String(), verb, plus, false, depth)
 			return
 		}
 	}

変更点:

Stringerインターフェースのチェックの前に、switch文が導入され、p.field（整形対象の値）がos.Error型であるかどうかが最初にチェックされるようになりました。
もしos.Error型であれば、そのString()メソッドが呼び出され、結果が整形されます。
このos.Errorの処理ブロックは、既存のStringerの処理ブロックとほぼ同じロジックを含んでいます。コミットメッセージにある「The duplication in the bodies is necessary」というコメントは、wasStringやhandledといったフラグの設定、およびcatchPanicの遅延実行が、メソッド呼び出しの前に確実に行われる必要があるため、コードの重複が避けられないことを説明しています。

コアとなるコードの解説

src/pkg/fmt/print.goのhandleMethods関数は、fmtパッケージが値を整形する際に、その値が特定のインターフェース（Formatter, Stringerなど）を実装しているかどうかをチェックし、それに応じて特別な処理を行うための中心的なロジックを含んでいます。

変更前のコードでは、p.fieldがStringerインターフェースを実装している場合にのみ、そのString()メソッドを呼び出して整形していました。

変更後のコードでは、このロジックがswitch文に置き換えられ、より詳細な型チェックが行われるようになりました。

		switch v := p.field.(type) {
		case os.Error:
			// os.Error型の場合の処理
			wasString = false
			handled = true
			defer p.catchPanic(p.field, verb)
			p.printField(v.String(), verb, plus, false, depth)
			return

		case Stringer:
			// Stringer型の場合の処理
			wasString = false
			handled = true
			defer p.catchPanic(p.field, verb)
			p.printField(v.String(), verb, plus, false, depth)
			return
		}

このswitch文は、p.fieldの動的な型をチェックし、以下の順序で処理を試みます。

case os.Error:: まず、p.fieldがos.Errorインターフェースを実装しているかどうかをチェックします。もし実装していれば、その値はvに型アサーションされ、v.String()が呼び出されてエラーメッセージが取得されます。その後、p.printField関数によってその文字列が整形・出力されます。
case Stringer:: os.Errorでなかった場合、次にStringerインターフェースを実装しているかどうかをチェックします。実装していれば、同様にv.String()が呼び出されて文字列が取得され、整形されます。

この変更により、fmtパッケージはos.Error型の値をStringerよりも優先して処理するようになりました。これは、エラー値が単なる文字列としてではなく、エラーとしての意味合いを持って整形されるべきであるという意図を反映しています。また、前述の通り、将来的なerrorインターフェースへの移行とgofixツールによる自動修正を円滑に進めるための重要なステップでした。

wasString = false, handled = true, defer p.catchPanic(...)といった共通のロジックが各caseブロック内で重複しているのは、defer文がその行が実行された時点で引数を評価するため、p.fieldやverbといった値が正確にキャプチャされるようにするためです。これにより、パニックが発生した場合でも、適切なコンテキストでエラーハンドリングが行われることが保証されます。

参考にした情報源リンク

Go言語の公式ドキュメント
Go言語のソースコード（特にfmtパッケージの歴史的なコミットログ）
Go言語に関する技術ブログやフォーラムの議論（os.Errorからerrorへの移行に関するもの）
GitHubのコミット履歴と差分表示
Go言語のerrorインターフェースの導入に関する議論 (Go issue trackerなど) (関連する可能性のあるissue)
Go言語のos.Errorの歴史に関する情報 (Go Errors: The Design of the Go error interface)
Go言語のStringerインターフェースに関する情報 (Go strings, bytes, runes and characters)
Go言語のgofixに関する情報 (GoFix: A tool for updating Go programs)

[インデックス 10145] ファイルの概要

コミット

commit 0e81e508bedec7e25aafc5b3939901dbc1d67914
Author: Russ Cox <rsc@golang.org>
Date:   Thu Oct 27 21:20:44 2011 -0700

    fmt: handle os.Error values
    
    Handling os.Error is no different than handling fmt.Stringer
    here, so the code is redundant now, but it will be necessary
    once error goes in.
    
    Adding it now will make gofix fix it.
    
    R=r
    CC=golang-dev
    https://golang.org/cl/5331045

GitHub上でのコミットページへのリンク

https://github.com/golang/go/commit/0e81e508bedec7e25aafc5b3939901dbc1d67914

元コミット内容

このコミットの元のメッセージは以下の通りです。

fmt: handle os.Error values

Handling os.Error is no different than handling fmt.Stringer here, so the code is redundant now, but it will be necessary once error goes in.

Adding it now will make gofix fix it.

R=r CC=golang-dev https://golang.org/cl/5331045

変更の背景

このコミットの背景には、以下の点が挙げられます。

os.Errorからerrorへの移行準備: os.Errorは、その名の通りosパッケージで定義されたインターフェースであり、エラーハンドリングの汎用的なメカニズムとしては不十分でした。より汎用的なerrorインターフェースへの移行が計画されており、このコミットはその移行をスムーズにするための準備段階と位置づけられます。
fmtパッケージの統一的なエラー表示: fmtパッケージは、Goプログラムにおいて様々な型の値を文字列として整形・出力する役割を担っています。エラー値も例外ではなく、ユーザーにとって分かりやすい形で表示される必要があります。このコミットは、os.Error型の値がfmt.Stringerと同様に適切に処理されるようにすることで、エラー表示の一貫性を保とうとしています。
gofixツールの活用: gofixは、Go言語のバージョンアップに伴うAPIの変更や言語仕様の変更に対して、既存のコードを自動的に修正するためのツールです。このコミットメッセージにある「Adding it now will make gofix fix it.」という記述は、os.Errorからerrorへの移行時にgofixがこの変更を検知し、自動的にコードを修正できるように、事前にfmtパッケージにos.Errorの処理ロジックを組み込んでおくという意図を示しています。これにより、開発者が手動で大量のコードを修正する手間を省くことができました。

前提知識の解説

Go言語の`fmt`パッケージ

fmtパッケージの主な機能には以下のようなものがあります。

Printf, Sprintf, Fprintf: フォーマット指定子（例: %d, %s, %v）を使って値を整形し、標準出力、文字列、または指定されたio.Writerに出力します。
Print, Println: 値をデフォルトのフォーマットで出力します。
Scanf, Sscanf, Fscanf: フォーマット指定子を使って文字列から値をパースします。

`fmt.Stringer`インターフェース

fmt.Stringerは、Go言語の標準ライブラリfmtパッケージで定義されているインターフェースです。

type Stringer interface {
    String() string
}

`os.Error`インターフェース（旧）

// osパッケージで定義されていたインターフェース（概念的な表現）
type Error interface {
    String() string
}

`error`インターフェース（現行）

現在のGo言語では、エラーは組み込みのerrorインターフェースによって表現されます。

type error interface {
    Error() string
}

`gofix`ツール

技術的詳細

fmt.Formatterインターフェースの実装
fmt.Stringerインターフェースの実装
その他の型に応じたデフォルトの整形

コアとなるコードの変更箇所

このコミットでは、主に以下の2つのファイルが変更されています。

src/pkg/fmt/doc.go
src/pkg/fmt/print.go

`src/pkg/fmt/doc.go`の変更

--- a/src/pkg/fmt/doc.go
+++ b/src/pkg/fmt/doc.go
@@ -89,10 +89,14 @@
 	If an operand implements interface Formatter, that interface
 	can be used for fine control of formatting.
 
-	If an operand implements method String() string that method
+	Next, if an operand implements the error interface, the Error method
 	will be used to convert the object to a string, which will then
-	be formatted as required by the verb (if any). To avoid
-	recursion in cases such as
+	be formatted as required by the verb (if any).
+
+	Finally, if an operand implements method String() string that method
+	will be used to convert the object to a string, which will then
+	be formatted as required by the verb (if any).
+	To avoid recursion in cases such as
 	\t\ttype X int
 	\t\tfunc (x X) String() string { return Sprintf("%d", x) }\
 	cast the value before recurring:

変更点:

String()メソッドを持つStringerインターフェースの前に、「errorインターフェースを実装している場合、Errorメソッドが使用される」という説明が追加されました。
これにより、fmtパッケージが値を文字列に変換する際の優先順位が明確化され、Formatter -> error -> Stringerの順で処理されることが示唆されています。

`src/pkg/fmt/print.go`の変更

--- a/src/pkg/fmt/print.go
+++ b/src/pkg/fmt/print.go
@@ -630,12 +630,23 @@ func (p *pp) handleMethods(verb rune, plus, goSyntax bool, depth int) (wasString
 			return
 		}
 	} else {
-		// Is it a Stringer?
-		if stringer, ok := p.field.(Stringer); ok {
+		// Is it an error or Stringer?
+		// The duplication in the bodies is necessary:
+		// setting wasString and handled and deferring catchPanic
+		// must happen before calling the method.
+		switch v := p.field.(type) {
+		case os.Error:
 			wasString = false
 			handled = true
 			defer p.catchPanic(p.field, verb)
-			p.printField(stringer.String(), verb, plus, false, depth)
+			p.printField(v.String(), verb, plus, false, depth)
+			return
+
+		case Stringer:
+			wasString = false
+			handled = true
+			defer p.catchPanic(p.field, verb)
+			p.printField(v.String(), verb, plus, false, depth)
 			return
 		}
 	}

変更点:

Stringerインターフェースのチェックの前に、switch文が導入され、p.field（整形対象の値）がos.Error型であるかどうかが最初にチェックされるようになりました。
もしos.Error型であれば、そのString()メソッドが呼び出され、結果が整形されます。
このos.Errorの処理ブロックは、既存のStringerの処理ブロックとほぼ同じロジックを含んでいます。コミットメッセージにある「The duplication in the bodies is necessary」というコメントは、wasStringやhandledといったフラグの設定、およびcatchPanicの遅延実行が、メソッド呼び出しの前に確実に行われる必要があるため、コードの重複が避けられないことを説明しています。

コアとなるコードの解説

変更前のコードでは、p.fieldがStringerインターフェースを実装している場合にのみ、そのString()メソッドを呼び出して整形していました。

変更後のコードでは、このロジックがswitch文に置き換えられ、より詳細な型チェックが行われるようになりました。

		switch v := p.field.(type) {
		case os.Error:
			// os.Error型の場合の処理
			wasString = false
			handled = true
			defer p.catchPanic(p.field, verb)
			p.printField(v.String(), verb, plus, false, depth)
			return

		case Stringer:
			// Stringer型の場合の処理
			wasString = false
			handled = true
			defer p.catchPanic(p.field, verb)
			p.printField(v.String(), verb, plus, false, depth)
			return
		}

このswitch文は、p.fieldの動的な型をチェックし、以下の順序で処理を試みます。

case os.Error:: まず、p.fieldがos.Errorインターフェースを実装しているかどうかをチェックします。もし実装していれば、その値はvに型アサーションされ、v.String()が呼び出されてエラーメッセージが取得されます。その後、p.printField関数によってその文字列が整形・出力されます。
case Stringer:: os.Errorでなかった場合、次にStringerインターフェースを実装しているかどうかをチェックします。実装していれば、同様にv.String()が呼び出されて文字列が取得され、整形されます。

参考にした情報源リンク

Go言語の公式ドキュメント
Go言語のソースコード（特にfmtパッケージの歴史的なコミットログ）
Go言語に関する技術ブログやフォーラムの議論（os.Errorからerrorへの移行に関するもの）
GitHubのコミット履歴と差分表示
Go Errors: The Design of the Go error interface
Go strings, bytes, runes and characters
GoFix: A tool for updating Go programs

comemo

[インデックス 10145] ファイルの概要

コミット

GitHub上でのコミットページへのリンク

元コミット内容

変更の背景

前提知識の解説

Go言語の`fmt`パッケージ

`fmt.Stringer`インターフェース

`os.Error`インターフェース（旧）

`error`インターフェース（現行）

`gofix`ツール

技術的詳細

コアとなるコードの変更箇所

`src/pkg/fmt/doc.go`の変更

`src/pkg/fmt/print.go`の変更

コアとなるコードの解説

関連リンク

参考にした情報源リンク

[インデックス 10145] ファイルの概要

コミット

GitHub上でのコミットページへのリンク

元コミット内容

変更の背景

前提知識の解説

Go言語の`fmt`パッケージ

`fmt.Stringer`インターフェース

`os.Error`インターフェース（旧）

`error`インターフェース（現行）

`gofix`ツール

技術的詳細

コアとなるコードの変更箇所

`src/pkg/fmt/doc.go`の変更

`src/pkg/fmt/print.go`の変更

コアとなるコードの解説

関連リンク

参考にした情報源リンク

Keyboard shortcuts

comemo