ArcGIS Help 10.2 - Python スクリプトのパッケージ化

詳細:

コンピュータ上で正常に動作する Python スクリプトツールの大部分は、パッケージ化して別のコンピュータ上で解凍したときに、正常に実行することができます。スクリプトを変更する必要は全くありません。ただし、問題が発生した場合、スクリプトが多くのプロジェクトデータを使用しているか、開発した Python モジュールを import ステートメントを使用してインポートしていることが原因である場合があります。そのような場合、このトピックは、以下について詳しく説明しているため、解決に役立ちます。

スクリプトで使用されるプロジェクトデータがどのように検索されてパッケージに含められるか。
インポートされるモジュールがどのように検索されてパッケージに含められるか。
ツールの整合チェックコードがどのようにパッケージ化されるか。
サードパーティライブラリがどのようにパッケージ化されるか。

Python、ArcPy またはスクリプトツールを使い慣れていない場合は、下記の「Python、ArcPy およびスクリプトツールの概要」にスキップして便利なトピックの一覧をご参照ください。

スクリプトのプロジェクトデータを発見する方法

パッケージまたはサービスのどちらの場合も、結果を共有し、その結果がスクリプトツールを参照する際は必ず、スクリプトで使用されているプロジェクトデータを発見するためにスクリプトツールがスキャンされます。プロジェクトデータが発見されると、一時フォルダに統合され、パッケージ化（パッケージを共有している場合）されるか、サーバにアップロード（サービスを共有している場合）されます。

スクリプトがスキャンされると、Python 変数で使用されるまたは関数への引数として使用されるそれぞれの引用符（一重または二重のいずれか）で囲まれた文字列がテストされ、存在するデータへのパスであるかどうかが確認されます。この場合のデータとは次のものを意味します。

コンテンツウィンドウのレイヤ（ArcMap または ArcGlobe）
フォルダ
ファイル
フィーチャクラス、シェープファイル、ジオデータベース、マップドキュメント（*.mxd）、レイヤファイル（*.lyr）などのジオデータセット

ここでは、ジオプロセシングツールへの入力としてまたは他の Python モジュールを参照するパスとして使用されるデータのみを対象とします。出力データも統合されますが、プロジェクトデータとは見なされません。

スクリプトに引用符で囲まれた文字列が発見されると、データの存在を確認する以下のようなテストが実行されます。

文字列はコンテンツウィンドウのレイヤを参照するか？
文字列にデータへの絶対パス（「e:\Warehousing\ToolData\SanFrancisco.gdb\streets」など）が含まれているか？
文字列はスクリプトの場所からの相対で発見できるデータを参照するか？スクリプトの場所は次のように定義されます。
- スクリプトが格納されているフォルダ。
- スクリプトがツールボックスに埋め込まれている場合、場所はツールボックスが格納されているフォルダになります。
- スクリプトが [Python] ツールボックスにある場合、場所は [Python] ツールボックスが格納されているフォルダになります。

これらのテストは、順次実行されます。テストに適合しデータが存在するとわかると、データは統合されます。ただし、1 つ例外があります。サービスを共有している場合は、サーバのデータストアが調べられ、データがデータストア内に存在するかどうかが判断されます。データがデータストア内に存在する場合、データは統合されません。

注意:

フォルダが統合される場合、フォルダ内のファイルとジオデータセットのみがコピーされ、サブフォルダはコピーされません。ファイルジオデータセット、ラスタ、TIN などの一部のジオデータセットは実際にはフォルダですが、ジオデータセットでもあるため、コピーされます。フォルダにレイヤファイル（*.lyr)またはマップドキュメント（*.mxd）が含まれる場合、レイヤファイルまたはマップドキュメントが参照するすべてのデータも統合され、スクリプトの arcpy.mapping ルーチンが、参照されるデータにアクセスできるようになります。

ヒント:

フォルダの統合では、ツールで使用されることのない大きなデータセットやファイルによってフォルダが雑然とするのを避ける必要があります。これは、パッケージ化やサーバにアップロードするデータのサイズを必要以上に増やさないためです。（サーバのデータストアにあるフォルダはサーバにアップロードされないため、これらのフォルダには当てはまりません。）

例

以下の例は、このフォルダ構造に基づいています。

プロジェクトフォルダの例

相対パスとフォルダ

スクリプトの場所からの相対でデータを発見する以下の方法は一般的なパターンで、特に ArcGIS 10.0 向けに作成されたサービスに適用されます。参照する場合、後に続くスクリプトコードが上記の Scripts フォルダにあります。ToolData フォルダに SanFrancisco.gdb が含まれています。SanFrancisco.gdb の中に、Streets という名前のフィーチャクラスがあります。以下のコードサンプルでは、スクリプトの場所（Scripts フォルダ）からの相対で ToolData フォルダへのパスが作成されます。

import arcpy
import os
import sys

# Get the pathname to this script, then strip off the
#  script file name to yield the containing folder
#
scriptPath = sys.path[0]
thisFolder = os.path.dirname(scriptPath)

# Construct paths to ../ToolData/SanFrancisco.gdb/Streets and
#                    ../ToolData/Warehouse.lyr
#
toolDataPath = os.path.join(thisFolder, "ToolData")
streetFeatures = os.path.join(toolDataPath, "SanFrancisco.gdb", "Streets")
streetLyr = os.path.join(toolDataPath, "Warehouse.lyr")

以下のコードでは、「ToolData」という文字列（os.path.join 関数への引数）がテストされ、存在するデータであるかどうかが確認されます。この場合、スクリプトの場所からの相対位置に ToolData という名前のフォルダがあります。この ToolData フォルダが統合されます。そのすべてのコンテンツ（上記で説明したように、サブフォルダは除く）がパッケージ化またはサーバにアップロードされます（ToolData フォルダがサーバのデータストアの一部である場合を除く）。

個々のファイルがコピーされるのではなく、フォルダのコンテンツがコピーされることに注意してください。たとえば、上記のコードで、データセット e:/Warehousing/ToolData/SanFrancisco.gdb/Streets へのパスが作成されるとします。統合処理では、Streets データセットのみを分離してコピーするわけではありません。ToolData フォルダ全体がコピーされます。

ジオデータセットへの絶対パス

以下のコードサンプルに示すように、絶対パスは、e:/ などのドライブ文字から始まるパスです。

import arcpy
import os

streetFeatures = 'e:/Warehousing/ToolData/SanFrancisco.gdb/Streets'

上記のコードでは、Streets データセットとそれが依存する他のすべてのデータ（リレーションシップクラス、ドメインなど）が統合されます。

ハイブリッドの例

import arcpy
import os

toolDataPath = r'e:\Warehousing\ToolData'
warehouseLyr = os.path.join(toolDataPath, "Warehouse.lyr")

上記のコードでは、ToolData フォルダ全体のコンテンツが統合されます。フォルダのコンテンツ（サブフォルダは除く）が統合されるため、Warehouse.lyr も、Warehouse.lyr が参照するデータとともに統合されます。

スラッシュとバックスラッシュ

Windows の表記規則では、パスの区切り文字としてバックスラッシュ（円記号）（\）を使用します。UNIX システムではスラッシュ（/）を使用します。

注意:

ArcGIS ではどちらを使用してもかまいません。スラッシュであっても、バックスラッシュであっても、該当するオペレーティングシステムの表記法に変換されます。

スクリプトでのバックスラッシュ

UNIX 関連のプログラミング言語や C 言語（Python など）では、バックスラッシュ（\）はエスケープ文字と見なされます。たとえば、\t はタブを表します。パスにはバックスラッシュが含まれるので、バックスラッシュがエスケープ文字として使用されないようにする必要があります。最も簡単なのは、次のように r ディレクティブを使用して、パスを Python の未処理文字列に変換する方法です。これは、バックスラッシュを無視するよう Python に指示する方法です。

thePath = r"E:\data\telluride\newdata.gdb\slopes"

パス指定の詳細

他の Python モジュールのインポート

スクリプトが、開発した他のスクリプトをインポートする場合があります。たとえば、以下のコードでは、myutils.py という名前の Python モジュールのインポートを示しています。このモジュールは、親スクリプトと同じディレクトリにあり、getFIDName という名前のルーチンを含んでいます。

import arcpy
import myutils
inFeatures = arcpy.GetParameterAsText(0)
inFID = myutils.getFIDName(inFeatures)

import ステートメントが使用されると必ず、以下の順序でスクリプトが特定されます。

スクリプトと同じフォルダ。スクリプトがツールボックスに埋め込まれている場合、ツールボックスが格納されているフォルダが使用されます。
システムの PYTHONPATH 変数が参照するフォルダ。
システムの PATH 変数が参照するフォルダ。

インポートするスクリプトがこれらのフォルダのいずれかの中にある場合、スクリプトは統合されます。スキャン処理は再帰的です。上記で説明したすべてのルールを使用して、インポートされたスクリプトもスキャンされてプロジェクトデータとインポートがないか確認されます。

インポートするモジュールを参照する方法として、sys.path.append メソッドの使用もあります。この方法を使用すると、インポートする必要のあるスクリプトを格納するフォルダにパスを設定できます。

import arcpy
import sys
import os

# Append the path to the utility modules to the system path
#  for the duration of this script.
#
myPythonModules = r'e:\Warehousing\Scripts'
sys.path.append(myPythonModules)
import myutils # a Python file within myPythonModules

上記のコードでは、sys.path.append メソッドには引数としてフォルダが必要であることに注意してください。'e:\Warehousing\Scripts' はフォルダであるため、フォルダ全体のコンテンツが統合されます。ここでも、フォルダのコンテンツをコピーするためのルールが適用されます。ジオデータセットでないサブフォルダを除く、フォルダ内のすべてがコピーされます。

注意:

フォルダ内の Python スクリプトをスキャン対象として、プロジェクトデータやインポート済みモジュールが検索されることはありません。

ツールの整合チェックコード

スクリプトツールの作成経験がある場合は、ユーザ独自のツールの整合チェックのロジックを指定してもかまいません。整合チェックロジックは、Python を使用して実装されます。整合チェックコードは、他のすべての Python スクリプトと同様に、プロジェクトデータとモジュールについてスキャンされます。たとえば、整合チェックロジックは、投影情報ファイル（*.prj）を含むフォルダ（d:\approved_projections など）を開き、ユーザがツールを実行するときに選択可能な空間参照の選択リストを構築します。このフォルダはツールパラメータではなく、ツールの整合チェックスクリプト内で使用されるプロジェクトデータです。Python スクリプトについて上記で説明されたルールと同じルールが、ここでも適用されます。その結果、d:\approved_projections フォルダが統合され、サーバのデータストアにそれがなければ、サーバにコピーされます。

サードパーティライブラリ

サードパーティモジュール（コア Python インストールの一部でないモジュール）は、統合されません。サードパーティモジュールは、パッケージを解凍したコンピュータ上に必ずインストールする必要があります。必要なサードパーティモジュールを指定するツールとパッケージについてのドキュメントを提供する必要があります。これは、ArcGIS for Desktop と共にインストールされる numpy モジュールまたは matplotlib モジュールには適用されません。

Python、ArcPy およびスクリプトツールの概要

Python、ArcPy およびスクリプトツールを使い慣れていない方は、下の表に記載した、使用開始にあたって参考になるトピックをご参照ください。

ヘルプトピック	コンテンツ
カスタムツール作成の概要	独自のプロセシングツール作成の基本概要
Python とは ArcPy とは	Python および ArcPy の入門トピック。これらのトピックでは、Python および ArcPy サイトパッケージの詳細を説明しています。
Python でのツールの作成の概要スクリプトツールとは	Python を使用したカスタムスクリプトツール作成の入門トピック。
スクリプトツールパラメータの設定	このトピックでは、スクリプトツールパラメータの定義方法を詳しく説明しているため、スクリプトツール作成プロセスを学習した後に参照する機会が多くなります。

Python スクリプトのパッケージ化

スクリプトのプロジェクト データを発見する方法

例