[Python] ウィンドウを初めて開いたときには、次のような画面が表示されます。
左側のセクションがメインの [Python] ウィンドウ プロンプトで、Python コマンドはここで実行されます。右側のセクションはヘルプと構文のウィンドウで、ここにはツールの実行時に実行メッセージが表示され、コードを入力すると現在のツール、関数、またはクラスについてのヘルプが表示されます。
[Python] ウィンドウでツールや他の arcpy 機能を使用するための最初のステップとして、プロンプトに「arcpy.」と入力し、すべての arcpy ツール、関数、およびクラスのドロップダウン リストを表示します。このリストは、ポインターまたはキーボードの上下矢印キーを使用してスクロールできます。追加の文字を入力するたびに、ドロップダウン リストがフィルターされ、入力した文字に一致するツールとメソッドだけが表示されます。たとえば、[Python] ウィンドウに「arcpy.addf」と入力すると、ドロップダウン リストには、これらの文字で始まるツールやメソッドのみが含まれます。If arcpy.AddField_management を下にスクロールするか、クリックした場合、プロンプトで Tab キーを使用すると、完全なツール名が自動検出されます。開き括弧 ( を入力すると、ヘルプと構文のウィンドウに arcpy.AddField_management ツールのヘルプが表示されます。デフォルトでは、最初のパラメーターがハイライト表示されます。
Python では、ツール ラベルの代わりにツール名を使用します。ツール ラベルは [ツール] ダイアログ ボックスの上部か カタログ ウィンドウに表示されます。ツール名は、通常はツール ラベルに似ていますが、スペースが含まれていません。Python には、ツール名とともにツールボックス エイリアスも含まれます。
必要なすべてのパラメーターの入力後に、Enter キーを押してツールを実行します。実行メッセージが [Python] ウィンドウのヘルプ セクションに表示されます。メッセージのテキストは、メッセージのタイプに応じた色で表示されます。次に、デフォルトのテキストの色と意味をまとめます。
| 色 | 意味 |
|---|---|
黒 | 通常の情報提供用メッセージ |
赤 | エラー メッセージ: 結果が作成されませんでした。 |
オレンジ | 警告メッセージ: 期待どおりの結果ではない可能性があります。 |
これらの色を変更する場合は、[Python] ウィンドウのヘルプ セクションを右クリックして、[形式] を選択します。
必須パラメーターとオプション パラメーター
ツール パラメーターには必須とオプションがあります。オプション パラメーターは中括弧 ({ }) で囲まれますが、必須パラメーターには括弧がついていません。
| パラメーターのタイプ | シンボル | 意味 |
|---|---|---|
必須 | 必須パラメーター。コマンドの最初のパラメーターは常に必須パラメーターです。必須パラメーターについては、値の入力が必要です。 | |
オプション | { } | オプション パラメーター。これらのパラメーターは常に必須パラメーターの次に配置されています。オプション パラメーターの値を入力しない場合は、デフォルトの値が計算され、使用されます。パラメーターのデフォルトの値については、ツールのヘルプをご参照ください。 |
ツールには、複数のオプション パラメーターが用意されていることがあります。場合によっては、設定が必要な関心の対象がツールのオプション パラメーターの一部にだけのこともあるでしょう。オプション パラメーターは、次の 3 つの方法で、スキップ (飛ばして移動) することができます。
- オプション パラメーターに、間に何も入れない 2 つの二重引用符 ("") を設定します。
- オプション パラメーターに二重引用符で囲んだシャープ記号 ("#") を設定します。
- 使用するパラメーター名とその値を明示的に指定します（それ以外の名前のパラメーターは無視されます）。
次の例の場合は、[フィールドの追加 (Add Field)] ツールが使用され、先ほどの 3 つの方法で 4 つ目と 5 つ目のパラメーターがデフォルトのままにされています。
# Use empty strings to skip optional parameters
arcpy.AddField_management("c:/data/streets.shp", "Address", "TEXT", "", "", 120)
# Use the # sign to skip optional arguments
arcpy.AddField_management("c:/data/streets.shp", "Address", "TEXT", "#", "#", 120)
# Use the parameter name to bypass unused optional arguments
arcpy.AddField_management("c:/data/streets.shp", "Address", "TEXT", field_length=120)
デフォルト値
- オプション パラメーターにはデフォルトの値があります。オプション パラメーターに、二重引用符で囲んだシャープ記号 (#)、2 つの二重引用符 ("")、2 つの一重引用符 ('')、または Python の None を入力すると、デフォルトのパラメーター値が使用されます。キーワードの場合、デフォルトの値は、リストの最初のキーワードです。デフォルトのパラメーター値については、個々のツールのヘルプをご参照ください。
- 変更の対象であるパラメーターに移動するためにいくつかのオプション パラメーターをスキップしなければならないという状況はよくあります。
[パラメーター] ドロップダウン リスト
ツールによって、特定のパラメーターについて利用できるオプションが認識されると、[Python] ウィンドウにドロップダウン リストが表示されます。[ツール] ダイアログ ボックスと同様、パラメーターが適切な値を識別してフィルターします。たとえば、AddXY_management ツールは、入力フィーチャについてポイント フィーチャクラスまたはレイヤーしか許容しないため、このパラメーターのドロップダウン リストには、利用可能なポイント フィーチャ レイヤーだけが含まれます。同様に DeleteField_management ツールの場合は、入力テーブルに基づいたフィールドのドロップダウン リストが表示されます。
複数値パラメーター
ツール パラメーターでは、パラメーターに応じて 1 つまたは複数の値が許容されます。複数の値が許容される場合は、[Python] リストとしてパラメーター値を指定できます。
[フィールドの削除 (Delete Field)] ツールの場合、削除対象として複数のフィールドが許容されます。フィールドの削除 ツールで複数のフィールドを削除するには、Python リスト内にフィールド名を文字列として入力します。
arcpy.DeleteField_management("c:/base/rivers.shp", ["Type", "Turbidity", "Depth"])
Union_analysis ツールや Intersect_analysis オーバーレイ ツールなど、一部のツールのパラメーターはテーブルのように表現され、複数の行の各行に複数の値が入っていることがあります。Union_analysis の場合、[入力フィーチャ] パラメーターでは、高精度でフィーチャを保存するために使用される優先度のランクがサポートされています。ランクは各入力フィーチャクラスにオプションの値として割り当てられます。1 が最優先とされます。
テーブルのように示されるパラメーターは、バリュー テーブルと呼ばれます。バリュー テーブルは、Python のリストのリストとして入力されます。Union_analysis の入力フィーチャ パラメーターの場合、フィーチャクラス名の後に、値をカンマで区切りながら、ランクを指定します。各フィーチャクラスのランク ペアは上位のリスト内に含まれます (このため、リストのリストと呼ばれます)。次の例は、そのようなリストの作成方法です。各フィーチャクラスについて同じワークスペースを繰り返さなくてもすむよう、ワークスペース環境は設定された状態になっています。
arcpy.env.workspace = "D:/St_Johns/data.mdb/neighborhoods"
input_list = [["east", 1], ["west", 1], ["south", 1], ["north", 2]]
arcpy.Union_analysis(input_list, "D:/base/data.gdb/land_use")
パラメーター規約
一般:
- すべての入力データセットのパラメーター名は、in_ で始まり、出力データセットは out_ で始まります。
- 通常は、入力データセットが最初のパラメーターで、出力データセットが最後の必須パラメーターです。その他の必須パラメーターは入力データセットと出力データセットの間に配置されます。
- オプション パラメーターは常に必須パラメーターの次に配置されます。
[Python] ウィンドウにヘルプを表示
コマンド名の入力後には、いくつかの方法で使用方法とツール固有のヘルプを利用できます。
- プロンプトで、ツール名と開き括弧「arcpy.Buffer_analysis(」を入力します。ツールの使用方法とヘルプ情報がヘルプ セクションに表示されます。
- Python に組み込まれたヘルプ機能を使用して、ヘルプが必要なツール名に移動します。ヘルプが Python のメイン セクションに表示されます。
- ツールの次に Python に組み込まれた関数属性 __doc__ を使用して、ドキュメント文字列を表示します。ヘルプが Python のメイン セクションに表示されます。
>>> arcpy.Buffer_analysis(
>>> help(arcpy.Buffer_analysis)
>>> print arcpy.Buffer_analysis.__doc__