Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

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

このコミットは、Go言語のテストスイート内のtest/fixedbugs/bug107.goファイルに対する変更です。具体的には、このテストファイルがos.Error型に依存しないように修正され、代わりにos.FileInfo型を使用するように変更されています。これにより、os.Errorの変更または非推奨化の影響を受けずに、テストの本来の目的（パッケージ名と変数名のシャドウイングに関するコンパイラの挙動のテスト）が維持されるようになります。

コミット

commit a07841e21ebe371f7b9f45cba1e0d1a8090c58fb
Author: Russ Cox <rsc@golang.org>
Date:   Mon Oct 31 17:50:38 2011 -0400

    test: make bug107 os.Error-proof
    
    R=golang-dev, bradfitz
    CC=golang-dev
    https://golang.org/cl/5306087

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

https://github.com/golang/go/commit/a07841e21ebe371f7b9f45cba1e0d1a8090c58fb

元コミット内容

このコミットの目的は、bug107というテストケースをos.Errorの変更に対して堅牢にすることです。具体的には、os.Error型への依存を取り除き、テストが将来のGo言語の変更によって壊れないようにしています。

変更の背景

Go言語の開発初期段階では、APIや言語仕様が頻繁に変更されていました。特にエラーハンドリングのメカニズムは進化を遂げ、初期のos.Errorインターフェースは後に組み込みのerrorインターフェースに統合され、os.Errorは非推奨となりました。

test/fixedbugs/bug107.goは、Goコンパイラがパッケージ名とローカル変数名が同じ場合に、ローカル変数がパッケージ名を「シャドウイング（shadowing）」する挙動を正しく処理するかどうかをテストするためのものです。このテストの元々のバージョンでは、osパッケージからos.Error型をインポートして使用していました。

type _ os.Errorという行は、os.Error型自体を直接使用するわけではなく、単にosパッケージから何らかの型をインポートし、その存在をコンパイラに認識させることで、後続のコードでosという名前がローカル変数としてシャドウイングされるシナリオを確立するために存在していました。

os.Errorが非推奨となり、最終的に削除される可能性があったため、このテストが将来的にコンパイルエラーになることを避ける必要がありました。テストの目的はos.Errorの機能そのものをテストすることではなく、シャドウイングの挙動をテストすることであったため、osパッケージ内の別の型（この場合はos.FileInfo）に置き換えることで、テストの意図を損なわずに将来の互換性を確保することができました。

前提知識の解説

Go言語のエラーハンドリングの変遷 (os.Errorからerrorへ)

Go言語の初期バージョンでは、エラーを表すためにos.Errorというインターフェースがosパッケージ内に定義されていました。これは以下のようなものでした。

package os

type Error interface {
    String() string
}

しかし、Go言語の設計思想として、エラーは言語の基本的な機能として扱われるべきであるという考えから、後にerrorという組み込みインターフェースが導入されました。

type error interface {
    Error() string
}

この変更により、os.Errorは非推奨となり、最終的には削除されました。現在では、Go言語の標準的なエラーハンドリングは、この組み込みのerrorインターフェースを使用します。

os.FileInfoインターフェース

os.FileInfoは、Go言語のosパッケージで定義されているインターフェースで、ファイルやディレクトリに関する情報（名前、サイズ、パーミッション、最終更新時刻など）を提供します。

package os

type FileInfo interface {
    Name() string       // base name of the file
    Size() int64        // length in bytes for regular files; system-dependent for others
    Mode() FileMode     // file mode bits
    ModTime() time.Time // modification time
    IsDir() bool        // abbreviation for Mode().IsDir()
    Sys() interface{}   // underlying data source (can return nil)
}

このインターフェースは、ファイルシステム操作において広く利用されます。

Go言語におけるシャドウイング (Shadowing)

シャドウイングとは、あるスコープ内で宣言された識別子（変数、関数、型など）が、その外側のスコープで宣言された同じ名前の識別子を「隠す」現象を指します。Go言語では、内側のスコープで宣言された識別子が優先され、外側のスコープの識別子にはアクセスできなくなります。

このコミットで関連するbug107.goのテストケースでは、osという名前がパッケージ名と関数の戻り値の変数名として両方で使われています。

package main
import os "os" // osパッケージをインポート

func f() (os int) { // 戻り値の変数名もos
    // In the next line "os" should refer to the result variable, not
    // to the package.
    _ = os // ここでのosは戻り値の変数osを指すべき
}

この場合、func f() (os int)の内部では、戻り値の変数osがosパッケージをシャドウイングします。したがって、_ = osの行では、osはint型の変数として扱われるべきであり、osパッケージへの参照ではないことをコンパイラが正しく認識するかどうかがテストされています。

技術的詳細

このコミットの技術的な詳細は、Go言語のコンパイラの挙動と、テストの堅牢性に関するものです。

test/fixedbugs/bug107.goの元のコードには、type _ os.Errorという行がありました。この行の目的は、osパッケージがインポートされていることを確認し、そのパッケージから何らかの型（この場合はos.Error）を参照することで、osという名前がパッケージとして有効であることをコンパイラに認識させることでした。これにより、後続のfunc f() (os int)内でosというローカル変数が宣言されたときに、コンパイラがパッケージ名とローカル変数名のシャドウイングを正しく処理するかどうかをテストする準備が整います。

os.ErrorがGo言語の進化の過程で非推奨となり、最終的に削除される可能性があったため、このテストが将来的にコンパイルエラーになるリスクがありました。テストの本来の目的はos.Errorの具体的な機能ではなく、osという名前のシャドウイング挙動を検証することでした。

そこで、コミットではtype _ os.Errorをtype _ os.FileInfoに置き換えました。os.FileInfoもosパッケージ内に存在する型であり、os.Errorと同様に、osパッケージが正しくインポートされ、その中の型が参照可能であることを示す役割を果たします。この変更により、テストの意図は完全に維持されつつ、os.Errorの将来的な変更や削除による影響を受けなくなりました。

この修正は、Go言語の標準ライブラリやコンパイラのテストが、言語自体の進化に合わせてどのように保守されているかを示す良い例です。特定のAPIの変更が、そのAPIの機能とは直接関係のないテストに影響を与える可能性がある場合、テストの目的を維持しつつ、依存関係を更新することが重要になります。

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

変更はtest/fixedbugs/bug107.goファイルの一箇所のみです。

--- a/test/fixedbugs/bug107.go
+++ b/test/fixedbugs/bug107.go
@@ -6,7 +6,7 @@
 
  package main
  import os "os"
-type _ os.Error
+type _ os.FileInfo
  func f() (os int) {
  	 // In the next line "os" should refer to the result variable, not
  	 // to the package.

具体的には、以下の行が変更されました。

-type _ os.Error +type _ os.FileInfo

コアとなるコードの解説

変更された行type _ os.Errorとtype _ os.FileInfoは、Go言語の型宣言の一種です。ここで_（ブランク識別子）が型名の代わりに使われているのは、その型を実際に使用する意図はなく、単にその型が存在し、コンパイラがそれを解決できることを確認するためです。

元のコードのtype _ os.Errorは、osパッケージからError型をインポートし、その型が有効であることをコンパイラに認識させていました。これは、osパッケージが正しくインポートされていることを暗黙的に確認し、osという名前がパッケージ名として利用可能であることを保証する役割がありました。

変更後のtype _ os.FileInfoも同様の役割を果たします。os.FileInfoはosパッケージ内に存在する別の型であり、os.Errorが非推奨になった後でも、osパッケージが正しくインポートされ、その中の型が参照可能であることを示すことができます。

この行の真の目的は、その直後の関数f()の定義にあるコメントで説明されています。

 func f() (os int) {
 	 // In the next line "os" should refer to the result variable, not
 	 // to the package.
 	 _ = os
 }

このコメントが示すように、テストの核心は、func f() (os int)という関数シグネチャ内でosという名前が戻り値の変数名として宣言されたときに、その関数スコープ内でosという名前がosパッケージではなく、このローカル変数osを指すことをコンパイラが正しく理解するかどうかを検証することです。

type _ os.Errorやtype _ os.FileInfoの行は、このシャドウイングのシナリオを確立するための「お膳立て」に過ぎません。os.Errorが非推奨になったため、テストの目的を維持しつつ、コンパイルエラーを避けるために、osパッケージ内の別の適切な型であるos.FileInfoに置き換えられたのです。

関連リンク

参考にした情報源リンク

  • Go言語の公式ドキュメント (osパッケージ、errorインターフェースに関する情報)
  • Go言語のシャドウイングに関する一般的な情報
  • このコミットのGitリポジトリ上の情報
  • Go言語のエラーハンドリングの歴史に関する情報 (Go 1.0以前のos.Errorについて)
  • os.FileInfoインターフェースの定義と使用法に関する情報
  • Go言語のテストコードの慣習に関する情報
  • Go言語のブランク識別子 (_) の使用法に関する情報I have generated the comprehensive technical explanation for the commit as requested.