Wie Projektdaten in einem Skript gesucht werden

Wenn Sie ein Ergebnis freigeben, entweder als Paket oder als Service, und das Ergebnis ein Skriptwerkzeug referenziert, wird das Skriptwerkzeug überprüft, um die im Skript verwendeten Projektdaten zu suchen. Werden die Projektdaten gefunden, werden sie in einen temporären Ordner konsolidiert, der entweder gepackt (falls Sie ein Paket freigeben) oder auf den Server hochgeladen wird (falls Sie einen Service freigeben).

Beim Durchsuchen des Skripts wird jede Zeichenfolge in Anführungszeichen (einfach oder doppelte Anführungszeichen) in einer Python-Variable oder als Argument für eine Funktion getestet, um festzustellen, ob es sich um einen Pfad zu vorhandenen Daten handelt. Daten bedeuten in diesem Fall:

• Ein Layer im Inhaltsverzeichnis (ArcMap oder ArcGlobe)
• Ein Ordner
• Eine Datei
• Ein Geodataset wie z. B. Feature-Class, Shapefile, Geodatabase, Kartendokument (.mxd) oder Layer-Datei (.lyr)

Zu Erläuterungszwecken werden nur Daten berücksichtigt, die als Eingabe für Geoverarbeitungswerkzeuge dienen oder als Pfade auf andere Python-Module verweisen. Ausgabedaten werden ebenfalls konsolidiert, aber nicht als Projektdaten betrachtet.

Immer wenn eine Zeichenfolge in Anführungszeichen im Skript gefunden wird, wird der Test auf vorhandene Daten wie folgt fortgeführt:

1. Verweist die Zeichenfolge auf einen Layer im Inhaltsverzeichnis?
2. Enthält die Zeichenfolge einen absoluten Pfad zu Daten (z. B. "e:\Warehousing\ToolData\SanFrancisco.gdb\streets")?
3. Verweist die Zeichenfolge auf Daten, die sich relativ zum Skriptspeicherort befinden? Der Speicherort des Skripts wird wie folgt definiert:
   • Der Ordner, der das Skript enthält.
   • Wenn das Skript in der Toolbox eingebettet ist, dient der Ordner, der die Toolbox enthält, als Speicherort.
   • Wenn sich das Skript in einer Python-Toolbox befindet, dient der Ordner, der die Python-Toolbox enthält, als Speicherort.

Diese Tests werden in sequenzieller Reihenfolge durchgeführt. Wenn die Tests bestanden wurden und die Daten vorhanden sind, werden sie konsolidiert, mit einer Ausnahme: wenn Sie einen Service freigeben, wird der Datenspeicher des Servers überprüft, um festzustellen, ob sich die Daten im Datenspeicher befinden. Falls sie im Datenspeicher vorhanden sind, erfolgt keine Konsolidierung.

Beispiele

Die unten angegebenen Beispiele basieren auf dieser Ordnerstruktur:

Relative Pfade und Ordner

Die folgende Technik zum Suchen von Daten relativ zum Speicherort des Skripts ist ein allgemeines Muster, das speziell für Services, die für ArcGIS 10.0 erstellt wurden, gilt. Der folgende Skriptcode befindet sich zu Referenzzwecken im oben abgebildeten Ordner Scripts. Der Ordner ToolData enthält die File-Geodatabase SanFrancisco.gdb. In SanFrancisco.gdb befindet sich eine Feature-Class namens Streets. In dem Codebeispiel unten wird der Pfad zum Ordner ToolData relativ zum Speicherort des Skripts konstruiert (der Ordner Scripts).

import arcpy import os import sys
# Get the directory the script lives in.
# Folders will be found relative to this location.
#
scriptPath = sys.path[0]
# Construct paths to ../ToolData/SanFrancisco.gdb/Streets and
#                    ../ToolData/Warehouse.lyr
#
toolDataPath = os.path.join(scriptPath, "..", "ToolData")
streetFeatures = os.path.join(toolDataPath, "SanFrancisco.gdb", "Streets")
streetLyr = os.path.join(toolDataPath, "Warehouse.lyr")

In dem oben angegeben Code wird die Zeichenfolge "ToolData" (ein Argument der Funktion os.path.join) getestet, um festzustellen, ob sie Daten enthält. In diesem Fall gibt es einen Ordner namens ToolData relativ zum Speicherort des Skripts. Dieser Ordner ToolData wird konsolidiert. Sein gesamter Inhalt (mit Ausnahme der Unterordner, wie oben erläutert) wird gepackt oder auf den Server hochgeladen (wenn der Ordner ToolData nicht Bestandteil des Serverdatenspeichers ist).

Beachten Sie, dass Ordnerinhalte kopiert werden, keine individuellen Dateien. In dem oben angegebenen Code wird beispielsweise der Pfad zum Dataset e:/Warehousing/ToolData/SanFrancisco.gdb/Streets generiert. Während der Konsolidierung wird dies nicht isoliert und nur das Dataset Streets kopiert, sondern der gesamte Ordner ToolData wird kopiert.

Absoluter Pfad zum Geodataset

Ein absoluter Pfad beginnt mit einem Laufwerksbuchstaben, beispielsweise e:/, wie im Codebeispiel unten gezeigt.

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

In dem oben angegebenen Code wird das Dataset Streets und alle anderen Daten, von denen es abhängt (wie Beziehungsklassen und Domänen), konsolidiert.

Hybrid-Beispiel

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

In dem oben angegebenen Code wird der gesamte Inhalt des Ordners ToolData konsolidiert. Da der Ordnerinhalt (ohne Unterordner) konsolidiert wird, werden Warehouse.lyr und die von Warehouse.lyr referenzierten Daten ebenfalls konsolidiert.

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

Importieren anderer Python-Module

Ihr Skript kann andere Skripte importieren, die Sie bereitgestellt haben. Der Code unten stellt beispielsweise den Import eines Python-Moduls namens myutils.py dar, das sich im selben Verzeichnis wie das Parent-Skript befindet und eine Routine namens getFIDName enthält: getFIDNameauf der Werkzeugleiste Präsentation.

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

Immer wenn die Anweisung Importieren vorkommt, wird das Skript in der folgenden Reihenfolge gesucht:

• Im selben Ordner wie das Skript. Wenn das Skript in der Toolbox eingebettet ist, wird der Ordner, der die Toolbox enthält, verwendet.
• Der von der Systemvariable PYTHONPATH referenzierte Ordner.
• Ein beliebiger Ordner, der von der Systemvariable PATH referenziert wird.

Eine weitere Vorgehensweise zum Referenzieren von zu importierenden Modulen ist die Verwendung der sys.path.append -Methode. Damit können Sie einen Pfad zu einem Ordner einrichten, der die zu importierenden Skripte enthält.

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

Beachten Sie im oben angegebenen Code, dass die sys.path.append-Methode einen Ordner als Argument erfordert. Da 'e:\Warehousing\Scripts' ein Ordner ist, wird der gesamte Ordnerinhalt konsolidiert. Die Regeln zum Kopieren des Ordnerinhalts gelten hier ebenfalls – alles im Ordner wird kopiert, außer Unterordner, die keine Geodatasets sind.

Werkzeugvalidierungscode

Wenn Sie Erfahrungen mit dem Schreiben von Skriptwerkzeugen haben, können Sie eine eigene Logik zur Werkzeugvalidierung bereitstellen. Clients des Geoverarbeitungs-Service haben nicht die Möglichkeit zur Ausführung Ihrer Werkzeugvalidierungslogik – nur der Server kann dies. Wenn der Client seine Task-Ausführungsanforderung an den Service sendet, wird die Validierungslogik auf dem Server ausgeführt. Falls die Validierungsroutine einen Fehler ergibt, wird die Task-Ausführung gestoppt. Sie können den Service Meldungen zurückgeben lassen, sodass dem Client Meldungen von den Validierungsroutinen angezeigt werden.

Validierungslogik wird mit Python implementiert, und der Validierungscode wird wie jedes andere Python-Skript auf Projektdaten und Module überprüft. So kann die Validierungslogik beispielsweise einen Ordner öffnen (z. B. d:\genehmigte_projektionen), der Projektionsdateien enthält (.prj), um eine Auswahlliste von Raumbezügen zu erstellen, die der Client bei der Ausführung Ihres Werkzeugs verwenden kann. Dieser Ordner ist kein Werkzeugparameter; es handelt sich um Projektdaten, die im Werkzeugvalidierungsskript verwendet werden. Die oben beschriebene Regel gilt auch für Python-Skripte, und folglich wird der Ordner d:\genehmigte_projektionen konsolidiert und auf den Server kopiert (falls er sich nicht bereits im Datenspeicher des Servers befindet).

Umwandeln von Projektdaten und Modulen in Werkzeugparameter

Wie oben beschrieben werden Python-Skripte bei der Freigabe überprüft und dann anhand der im Code gefundenen, in Anführungszeichen gesetzten Zeichenfolgen entschieden, welche Daten das Skript verwendet. Wenn Sie diesen Prozess steuern möchten, können Sie Parameter für alle vom Skript verwendeten Daten und Module erstellen. Das Skriptbeispiel unten verdeutlicht dies – alle Projektdaten und Module wurden hier in Parameter umgewandelt, die an das Skript übergeben werden.

import arcpy import sys import os
inFeatures = arcpy.GetParameterAsText(0)            # Feature Layer projectDataFolder = arcpy.GetParameterAsText(1)     # Folder myPythonModules = arcpy.GetParameterAsText(2)       # Folder
# Append the path to the utility modules to the system path
#  for the duration of this script.
#
sys.path.append(myPythonModules)
import myutils # a Python file within myPythonModules
# Construct a variable to hold the Streets feature class found in the
#  project data folder
#
streetsFeatures = os.path.join(projectDataFolder, "SanFrancisco.gdb", "Streets")

Wenn das Skript wie oben gezeigt Parameter für alle seine Daten verwendet, hat dies mehrere Vorteile:

• Sie haben einen besseren Überblick, welche Daten das Skript benötigt – da es sich um Parameter handelt, können Sie sie im Werkzeugdialogfeld sehen. Sie müssen nicht den Code bearbeiten, um zu bestimmen, welche Daten Sie verwenden.
• Die interne Werkzeugvalidierungslogik wird angewendet – wenn der Parameterwert auf Daten verweist, die nicht vorhanden sind, zeigt das Werkzeugdialogfeld einen Fehler an und kann das Werkzeug nicht zur Erstellung eines Ergebnisses ausführen.
• Um den Speicherort der Daten zurückzusetzen, können Sie im Werkzeugdialogfeld nach dem Speicherort suchen, statt den Speicherort in das Skript einzugeben (was fehleranfällig ist).
• Sobald das Ergebnis als Service freigegeben wird, legt der Service-Editor die Ordner-Parameter auf den Eingabemodus Konstant fest; der Client sieht die Parameter nicht. Beim Veröffentlichen werden die beiden Ordner auf den Server kopiert (falls sie nicht schon im Datenspeicher registriert sind). Wenn der Task auf dem Server ausgeführt wird, empfängt das Skript die Pfade zu den kopierten Ordnern.

Module von Drittanbietern

Drittanbietermodule (alle Module, die nicht Teil der Python-Kerninstallation sind) werden nicht konsolidiert. Sie müssen sicherstellen, dass das Modul vorhanden ist und ordnungsgemäß auf dem Server ausgeführt wird. Dies gilt nicht für die Module numpy oder matplotlib , die mit ArcGIS-Server installiert werden.

Erste Schritte mit Python, ArcPy und Skriptwerkzeugen

Wenn Sie mit Python, ArcPy und Skriptwerkzeugen noch nicht vertraut sind, finden Sie in der Tabelle unten einige Themen, die Ihnen bei den ersten Schritten helfen.