Packen von Python-Skripten

Dive-in:

Die Mehrheit der Python-Skriptwerkzeuge, die erfolgreich auf Ihrem Computer ausgeführt werden, können gepackt und nach dem Entpacken auf einem anderen Computer erfolgreich ausgeführt werden. Sie müssen das Skript nicht ändern oder anpassen. Falls jedoch Probleme auftreten, kann es daran liegen, dass das Skript viele Projektdaten verwendet oder Import-Anweisungen einsetzt, um die von Ihnen entwickelten Python-Module zu importieren. In diesem Fall finden Sie dieses Thema wahrscheinlich hilfreich, da es folgende Details erläutert:

1. Wie Projektdaten in einem Skript gesucht und in ein Paket aufgenommen werden.
2. Wie importierte Module gesucht und in ein Paket aufgenommen werden.
3. Wie Werkzeugvalidierungscode gepackt wird.
4. Wie Bibliotheken von Drittanbietern gepackt werden.

Wenn Sie mit Python, ArcPy oder Skriptwerkzeugen nicht vertraut sind, finden Sie im Abschnitt Erste Schritte mit Python, ArcPy und Skriptwerkzeugen weiter unten eine Liste hilfreicher Themen.

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.

Hinweis:

Wenn Ordner konsolidiert werden, werden nur die im Ordner vorhandenen Dateien und Geodatasets kopiert, nicht jedoch die enthaltenen Unterordner. Einige Geodatasets, wie z. B. File-Geodatabases, Raster und TINs sind technisch gesehen Ordner; sie sind jedoch auch Geodatasets und werden daher kopiert. Wenn der Ordner Layer-Dateien (.lyr) oder Kartendokumente (.mxd) enthält, werden alle von der Layer-Datei oder dem Kartendokument referenzierten Daten ebenfalls konsolidiert, sodass die arcpy.mapping-Routinen im Skript Zugriff auf die referenzierten Daten erhalten.

Tipp:

Aufgrund der Art und Weise, wie Ordner konsolidiert werden, sollten Sie die Ordner nicht unnötig mit großen Datasets und Dateien füllen, die nicht vom Werkzeug verwendet werden. Dadurch wird die Datenmenge, die gepackt oder auf den Server hochgeladen werden soll, unnötig vergrößert. (Dies gilt nicht für Ordner, die sich im Datenspeicher des Servers befinden, da diese Ordner nicht auf den Server hochgeladen werden.)

Beispiele

Die unten angegebenen Beispiele basieren auf dieser Ordnerstruktur:

Beispiel-Projektordner

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 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")

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.

Schrägstriche und umgekehrte Schrägstriche

Unter Windows wird ein umgekehrter Schrägstrich (\) als Trennzeichen in Pfaden verwendet. In UNIX-Systemen wird hingegen ein Schrägstrich (/) verwendet.

Hinweis:

In ArcGIS ist es egal, ob Sie einen Schrägstrich oder einen umgekehrten Schrägstrich in Ihrem Pfad verwenden. ArcGIS konvertiert diese immer in die entsprechende Betriebssystemkonvention.

Umgekehrter Schrägstrich bei Skripten

Programmiersprachen, deren Wurzeln in den Programmiersprachen UNIX und C liegen, z. B. Python, behandeln den umgekehrten Schrägstrich (\) als Escape-Zeichen. Beispielsweise stellt \t einen Tabulator dar. Da Pfade umgekehrte Schrägstriche enthalten können, müssen Sie verhindern, dass umgekehrte Schrägstriche als Escape-Zeichen interpretiert werden. Die einfachste Möglichkeit hierzu ist das Konvertieren von Pfaden in Python-Raw-Strings mit der Direktive r, wie unten dargestellt. Hiermit wird Python angewiesen, umgekehrte Schrägstriche zu ignorieren.

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

Weitere Informationen zum Festlegen von Pfaden

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:

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

Immer wenn die Anweisung import 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.

Wenn sich das zu importierende Skript in einem dieser Ordner befindet, wird das Skript konsolidiert. Der Suchvorgang erfolgt rekursiv – das importierte Skript wird ebenfalls auf Projektdaten überprüft, und diese werden anhand der oben beschriebenen Regeln importiert.

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.

Hinweis:

Python-Skripte im Ordner werden nicht auf Projektdaten oder importierte Module überprüft.

Werkzeugvalidierungscode

Wenn Sie Erfahrungen mit dem Schreiben von Skriptwerkzeugen haben, können Sie eine eigene Logik zur Werkzeugvalidierung bereitstellen. 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 Benutzer bei der Ausführung Ihres Werkzeugs wählen können. 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).

Bibliotheken von Drittanbietern

Drittanbietermodule (alle Module, die nicht Teil der Python-Kerninstallation sind) werden nicht konsolidiert. Stellen Sie sicher, dass das Modul auf dem Computer installiert wird, auf dem das Paket entpackt wird. Sie sollten Dokumentation für Ihr Werkzeug und Paket bereitstellen, in der angegeben ist, welche Drittanbietermodule erforderlich sind. Dies gilt nicht für die Module numpy und matplotlib, die mit ArcGIS for Desktop 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.

Hilfethema	Inhalt
Kurzer Überblick über das Erstellen von benutzerdefinierten Werkzeugen	Grundlegende Konzepte beim Erstellen eigener Geoverarbeitungswerkzeuge
Was ist Python? Was ist ArcPy?	Einführung in Python und ArcPy. Von diesen Themen gelangen Sie zu ausführlicheren Themen über Python und das ArcPy-Site-Paket.
Kurzer Überblick über das Erstellen von Werkzeugen in Python Was ist ein Skriptwerkzeug?	Einführung in das Erstellen von benutzerdefinierten Skriptwerkzeugen mit Python.
Festlegen von Parametern für Skriptwerkzeuge	Nachdem Sie sich mit dem Erstellen von Skriptwerkzeugen vertraut gemacht haben, wird häufig auf dieses Thema verwiesen, da es ausführlich erläutert, wie Sie Skriptwerkzeug-Parameter definieren.