スクリプト ツールのメッセージについて
スクリプトをスクリプト ツールとして実行した場合、ArcPy は呼び出し元のアプリケーション(ArcMap や ArcCatalog)を完全に認識しています。この結果、ArcPy を使用してメッセージを書き込むと、メッセージが進捗状況ダイアログ ボックス、ツールの結果、および [Python] ウィンドウに自動的に表示されます。また、スクリプト ツールでは、スクリプト ツールの呼び出し元であるモデルまたはスクリプト ツールのいずれからも自作メッセージにアクセスできます。
ツールの実行中に書き込まれるメッセージは、ジオプロセシング関数を使用して取得することができます。これらのメッセージには、次のような情報が含まれています。
- 操作の開始時刻と終了時刻
- 使用されたパラメータ値
- 操作の進行状況に関する一般情報(情報メッセージ)
- 潜在的な問題に関する警告(警告メッセージ)
- ツールの実行を停止させるエラー(エラー メッセージ)
ツールとユーザの間でのやり取りは、すべてメッセージによって行われます。ツールを実行している環境に応じて、メッセージは [結果] ウィンドウ、[Python] ウィンドウ、および進行状況ダイアログ ボックスに表示されます。Python では、これらのメッセージをスクリプトに取り込んだり、照会を行ったり、出力したり、ファイルに書き込んだりすることができます。すべてのメッセージに重要度のプロパティがあり、これは情報、警告、またはエラーのいずれかです。重要度は整数であり、0 = 情報、1 = 警告、2 = エラーです。
重要度 | |
---|---|
情報メッセージ(重要度 = 0) |
情報メッセージは、その名のとおり、実行に関する情報です。問題を示すために使用されることはありません。ツールの進行状況、ツールが開始または完了した時刻、出力データの特性、ツールの結果など、一般的な情報のみが情報メッセージには示されます。 |
警告メッセージ(重要度 = 1) |
警告メッセージは、ツールの実行中に問題につながりかねない状況が発生した場合、または結果がユーザの期待するものとは異なる可能性がある場合に生成されます。たとえば、警告が生成されるのは、すでに座標系が定義されているデータセットで座標系を定義しようとした場合です。警告が返された場合、ツールの実行をキャンセルする、別のパラメータを指定するといったアクションを選択することができます。 |
エラー メッセージ(重要度 = 2) |
エラー メッセージは、ツールの実行を妨げた重大なイベントを示します。1 つ以上のパラメータの値が無効であったり、重要な実行プロセスまたはルーチンが失敗した場合にエラーが発生します。 |
警告メッセージとエラー メッセージの両方に、6 桁の ID コードが付いています。これらの ID コードは文書化されており、その原因と対処法についての追加情報が提供されます。エラーまたは警告のコードが、ツールまたは進行状況のダイアログ ボックス、[Python] ウィンドウ、または [結果] ウィンドウに表示されているときに、これらのコードのリンクをクリックすると、そのメッセージの詳細なヘルプに直接進むことができます。