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

このコミットは、Go言語のコードレビューツールであるcodereview.pyにおいて、hgpatchコマンドが見つからない場合に表示されるエラーメッセージを改善するものです。ユーザーがhgpatchをインストールする方法を具体的に案内することで、エラー発生時のユーザー体験を向上させています。

コミット

commit 7dca24ee7e5c0c5acba35a1a0b9a23f1761098e3
Author: Brad Fitzpatrick <bradfitz@golang.org>
Date:   Thu Feb 2 11:53:28 2012 -0800

    codereview: explain how to get hgpatch in error message

    R=golang-dev, rsc
    CC=golang-dev
    https://golang.org/cl/5623045
---
 lib/codereview/codereview.py | 2 +--
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/lib/codereview/codereview.py b/lib/codereview/codereview.py
index fd0b4b4aea..7e9f6ca728 100644
--- a/lib/codereview/codereview.py
+++ b/lib/codereview/codereview.py
@@ -1572,7 +1572,7 @@ def clpatch_or_undo(ui, repo, clname, opts, mode):
 	try:
 		cmd = subprocess.Popen(argv, shell=False, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=None, close_fds=sys.platform != "win32")
 	except:
-		return "hgpatch: " + ExceptionDetail()
+		return "hgpatch: " + ExceptionDetail() + "\nInstall hgpatch with:\n$ go get code.google.com/p/go.codereview/cmd/hgpatch\n"

 	out, err = cmd.communicate(patch)
 	if cmd.returncode != 0 and not opts["ignore_hgpatch_failure"]:`

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

https://github.com/golang/go/commit/7dca24ee7e5c0c5acba35a1a0b9a23f1761098e3

元コミット内容

codereview: explain how to get hgpatch in error message

このコミットは、コードレビューツールにおいて、hgpatchが見つからない場合のエラーメッセージに、hgpatchのインストール方法を追加するものです。

Go言語の初期のコードレビュープロセスでは、Mercurial (hg) をベースとしたパッチ適用ツールであるhgpatchが利用されていました。ユーザーがコードレビューを行う際に、このhgpatchがシステムにインストールされていない場合、ツールはエラーを返していました。しかし、そのエラーメッセージは単に「hgpatchが見つからない」という情報のみで、ユーザーがどのように問題を解決すれば良いのかが不明瞭でした。

このコミットの背景には、ユーザーがエラーに直面した際に、自力で解決できるような具体的なガイダンスを提供し、開発ワークフローの摩擦を減らすという目的があります。特に、Goのエコシステムではgo getコマンドがパッケージの取得・インストールに広く使われていたため、そのコマンドを使ったインストール方法を提示することが、ユーザーにとって最も分かりやすい解決策と考えられました。

前提知識の解説

Go言語のコードレビュープロセスとGerrit

Go言語のプロジェクトでは、初期からGerritというコードレビューシステムが採用されていました。GerritはGitリポジトリと連携し、変更セット（チェンジリスト、CL）を単位としてコードレビューを行います。開発者は変更をGerritにアップロードし、レビューを経てマージされます。

`codereview.py`

codereview.pyは、Goプロジェクトの初期にGerritと連携してコードレビューを支援するために使われていたPythonスクリプトです。ローカルの変更をGerritにアップロードしたり、Gerrit上の変更をローカルに適用したりする機能を提供していました。このスクリプトは、Go言語の公式リポジトリの一部として提供されていました。

`hgpatch`

hgpatchは、Mercurial (hg) のパッチを適用するためのツールです。Go言語の初期のコードレビューシステムでは、Gerritが生成するパッチをローカルに適用するために利用されていました。Goプロジェクトは後にGitに移行しましたが、このコミットが作成された時点ではまだMercurialが使われており、hgpatchはそのワークフローの一部でした。hgpatch自体はGo言語で書かれたコマンドラインツールで、code.google.com/p/go.codereview/cmd/hgpatchというパスで提供されていました。

`subprocess.Popen` (Python)

subprocess.PopenはPythonの標準ライブラリsubprocessモジュールの一部で、新しいプロセスを生成し、その入出力パイプに接続するためのクラスです。これにより、Pythonスクリプトから外部のコマンド（この場合はhgpatch）を実行し、その標準入力、標準出力、標準エラーを制御することができます。

`ExceptionDetail()` (Python)

ExceptionDetail()は、このcodereview.pyスクリプト内で定義されていると思われるヘルパー関数で、現在の例外に関する詳細な情報（例えば、例外のタイプやメッセージ）を文字列として返すものです。これにより、エラー発生時に具体的なエラー内容をユーザーに伝えることができます。

`go get`コマンド

go getはGo言語のツールチェーンに含まれるコマンドで、Goのパッケージやコマンドをリモートリポジトリから取得し、ビルドしてインストールするために使用されます。例えば、go get example.com/path/to/packageと実行すると、指定されたパッケージのソースコードがダウンロードされ、コンパイルされて、実行可能ファイルが$GOPATH/bin（またはGo 1.11以降では$GOBIN）に配置されます。

技術的詳細

このコミットの技術的な変更は、lib/codereview/codereview.pyファイル内のclpatch_or_undo関数にあります。この関数は、Gerritから取得したパッチをローカルに適用する際にhgpatchコマンドを呼び出しています。

元のコードでは、subprocess.Popenを使ってhgpatchコマンドを実行しようとした際に例外（例えば、hgpatchコマンドが見つからないFileNotFoundErrorなど）が発生した場合、単に"hgpatch: " + ExceptionDetail()というエラーメッセージを返していました。これは、hgpatchが見つからないという事実を伝えるものの、ユーザーが次に何をすべきかについての情報が不足していました。

変更後のコードでは、このexceptブロック内で返されるエラーメッセージに、以下の文字列が追加されています。

"\nInstall hgpatch with:\n$ go get code.google.com/p/go.codereview/cmd/hgpatch\n"

これにより、エラーメッセージは以下のような形式になります。

hgpatch: [元の例外の詳細] Install hgpatch with: $ go get code.google.com/p/go.codereview/cmd/hgpatch

この変更により、ユーザーはhgpatchが見つからないというエラーに直面した際に、すぐにgo getコマンドを使ってhgpatchをインストールできることが明確に示されます。これは、エラーメッセージの質を向上させ、ユーザーが問題を迅速に解決できるようにするための典型的な改善例です。

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

--- a/lib/codereview/codereview.py
+++ b/lib/codereview/codereview.py
@@ -1572,7 +1572,7 @@ def clpatch_or_undo(ui, repo, clname, opts, mode):
 	try:
 		cmd = subprocess.Popen(argv, shell=False, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=None, close_fds=sys.platform != "win32")
 	except:
-		return "hgpatch: " + ExceptionDetail()
+		return "hgpatch: " + ExceptionDetail() + "\nInstall hgpatch with:\n$ go get code.google.com/p/go.codereview/cmd/hgpatch\n"

 	out, err = cmd.communicate(patch)
 	if cmd.returncode != 0 and not opts["ignore_hgpatch_failure"]:`

コアとなるコードの解説

変更はlib/codereview/codereview.pyファイルの1574行目で行われています。

変更前:
```
return "hgpatch: " + ExceptionDetail()
```
hgpatchコマンドの実行に失敗した場合（subprocess.Popenが例外を発生させた場合）、"hgpatch: "というプレフィックスと、ExceptionDetail()関数が返す例外の詳細を結合した文字列がエラーメッセージとして返されていました。
変更後:
```
return "hgpatch: " + ExceptionDetail() + "\nInstall hgpatch with:\n$ go get code.google.com/p/go.codereview/cmd/hgpatch\n"
```
変更後も同様に"hgpatch: " + ExceptionDetail()は含まれますが、その後に改行（\n）と、hgpatchのインストール方法を示す具体的な指示（Install hgpatch with:\n$ go get code.google.com/p/go.codereview/cmd/hgpatch\n）が追加されています。

この変更により、ユーザーがhgpatchが見つからないというエラーに遭遇した際に、エラーメッセージ自体が問題解決のための具体的なステップ（go getコマンドの実行）を提示するようになり、ユーザーの利便性が大幅に向上しました。

参考にした情報源リンク

Go言語の公式ドキュメント (go getコマンドの一般的な情報)
Pythonのsubprocessモジュールに関するドキュメント
Gerritコードレビューシステムに関する一般的な知識
Mercurial (hg) およびパッチ適用に関する一般的な知識

comemo