Cómo se encuentran los datos de proyecto en la secuencia de comandos

Cada vez que comparten un resultado, ya sea como un paquete o como un servicio, y el resultado hace referencia a una herramienta de secuencia de comandos, la herramienta de secuencia de comandos se escanea para descubrir todos los datos de proyecto utilizados en la secuencia de comandos. Cuando los datos de proyecto se encuentran, se consolidada en una carpeta temporal que se empaqueta (si está compartiendo un paquete) o carga en el servidor (si está compartiendo un servicio).

Cuando la secuencia de comandos se escanea, todas las cadenas de caracteres citadas (con comillas simples o dobles) utilizadas en una variable de Python o como un argumento para una función se prueban para determinar si es una ruta de acceso a datos que existen. Datos, en este caso, significa

• Una capa en la tabla de contenido (ArcMap o ArcGlobe)
• Una carpeta
• Un archivo
• Un geodataset, como una clase de entidad, archivo de forma, geodatabase, documento de mapa (.mxd) y archivo de capa (.lyr)

Para los fines de debate, solo interesan los datos que se utilizan como entrada para las herramientas de geoprocesamiento o las rutas de acceso que hacen referencia a otros módulos de Python. Los datos de salida es también se consolidan, pero no se consideran datos de proyecto.

Siempre que una cadena de texto citado se encuentre en la secuencia de comandos, la prueba para la existencia de datos se lleva a cabo de la manera siguiente:

1. ¿La cadena de caracteres hace referencia a una capa en la tabla de contenido?
2. ¿La cadena de caracteres contiene una ruta absoluta a los datos (como " e: \Warehousing\ToolData\SanFrancisco. gdb\streets" )?
3. ¿La cadena de caracteres tiene datos de referencia que se pueden encontrar en relación a la ubicación de la secuencia de comandos? La ubicación de la secuencia de comandos se define de la siguiente manera:
   • La carpeta que contiene la secuencia de comandos.
   • Si la secuencia de comandos está integrada en la caja de herramientas, la ubicación es la carpeta que contiene la caja de herramientas.
   • Si la secuencia de comandos se encuentra en una caja de herramientas Python la ubicación es la carpeta que contiene la caja de herramientas Python.

Estas pruebas se desarrollan en orden secuencial. Si la prueba pasa y existen los datos, se consolidarán, con una excepción: si va a compartir un servicio, el data store del servidor se examina para determinar si los datos se encuentran en el data store. Si reside en el almacenamiento de datos, entonces no está consolidada.

Ejemplos

Los siguientes ejemplos se basan en esta estructura de carpetas:

Rutas relativas y carpetas

La siguiente técnica de búsqueda de datos relativos a la ubicación de la secuencia de comandos es un patrón común, especialmente para los servicios que se crearon para ArcGIS 10.0. A modo de referencia, el siguiente código residen en la carpeta secuencia de comandos que se ilustró anteriormente. La carpeta ToolData contiene SanFrancisco. gdb. En SanFrancisco. gdb hay una clase de entidad llamada Calles. En la siguiente muestra de código, la ruta a la carpeta ToolData se construye en relación a la ubicación de la secuencia de comandos (la carpeta Secuencias de comandos ).

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

En el código anterior, la cadena de caracteres "ToolData" (un argumento para la función os.path.join) se prueba para determinar si son datos existentes. En este caso, hay una carpeta llamada ToolData en relación a la ubicación de la secuencia de comandos. Esta carpeta ToolData será consolidada, todo su contenido (con la excepción de las subcarpetas como se describió anteriormente) se empaquetará o cargará en el servidor (a menos que la carpeta ToolData sea parte del almacenamiento de datos del servidor).

Observe que se copian los contenidos de la carpeta, no los archivos individuales. Por ejemplo, en el código anterior, se construye la ruta al dataset e:/Warehousing/ToolData/SanFrancisco. gdb/Streets. El proceso de consolidación no se aísla y solo copia el dataset Calles dataset (copia toda la carpeta ToolData).

Ruta absoluta para un geodataset

Una ruta absoluta comienza con la letra de unidad, como e:/, como se puede ver en la muestra de código que aparece a continuación.

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

En el código anterior, el dataset Calles, y todo el resto de datos de los que depende (como las clases de relación y dominios), se consolidarán.

Ejemplo de híbridos

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

En el código anterior, todo el contenido de la carpeta ToolData se consolida. Puesto que los contenidos de la carpeta (menos la subcarpetas) se consolidan, también se consolidará Warehouse.lyr junto con los datos referenciados por Almacén. lyr.

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

Importar otros módulos de Python

La secuencia de comandos puede importar otras secuencias de comandos que haya desarrollado. Por ejemplo, el código que aparece a continuación muestra cómo importar un módulo de Python denominado myutils.py, que se encuentra en el mismo directorio que la secuencia de comandos principal y contiene una rutina llamada getFIDName.

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

Siempre que importar se encuentra una afirmación, se utiliza el siguiente orden para ubicar la secuencia de comandos:

• La misma carpeta que la secuencia de comandos. Si la secuencia de comandos está integrada en la caja de herramientas, la ubicación es la carpeta que contiene la caja de herramientas.
• La carpeta del sistema al que hace referencia la variable PYTHONPATH .
• Cualquier carpeta al que hace referencia a la la variable PATH del sistema.

Otra técnica para hacer referencia a los módulos que se van a importar es utilizar el método sys.path.append de resultado puede recuperar la salida. Esto le permite establecer una ruta a una carpeta que contiene las secuencias de comandos que necesita importar.

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

En el código anterior, tenga en cuenta que el método sys. path. append requiere una carpeta como un argumento. Dado que ': \Warehousing\Script' es una carpeta, todo el contenido de la carpeta se consolidará. El contenido de la carpeta para copiar las normas también se aplica en este caso (todo lo que haya en la carpeta se copia, excepto las subcarpetas que no son geodatasets).

Código de validación de la herramienta

Si tiene experiencia escribiendo las herramientas de secuencia de comandos, puede proporcionar su propia lógica de validación de la herramienta . Los clientes de servicio de geoprocesamiento no tienen la capacidad de ejecutar su lógica de validación de la herramienta, solamente el servidor tiene esta capacidad. Cuando el cliente envía sus solicitud ejecutar tarea al servicio, su lógica de validación se ejecutará en el servidor. Si las rutinas de validación lanzar un error, la tarea detiene la ejecución. Si devuelve mensajes desde su servicio, el cliente debe recibir mensajes enviados por su rutinas de validación.

La lógica de validación se implementa con Python y su código de validación se escaneará en buscas de datos de proyecto y módulos, al igual que cualquier otra secuencia de comandos de Python. Por ejemplo, su lógica de validación puede abrir una carpeta (por ejemplo,d:\approved_projections) que contiene archivos de proyección (.prj) para generar una lista de elección de referencias espaciales que el cliente puede utilizar cuando se ejecute la herramienta. Esta carpeta no es un parámetro de herramienta; son datos de proyecto que se utilizan en la validación de la herramienta de secuencia de comandos. Las mismas normas que se describieron anteriormente para secuencias de comandos de Python se aplican aquí, y la consecuencia es que la carpeta d: \approved_projections se consolidará y se copiará en el servidor (a no ser que se encuentre en el almacenamiento de datos del servidor).

Crear parámetros de las herramientas de datos de proyecto y módulos

Como se describió anteriormente, sus secuencias de comandos de Python se escanean cuando se comparten, y se toman las decisiones sobre qué datos utiliza la secuencia de comandos basándose en las cadenas de caracteres entrecomilladas encontradas en su código. Si desea tomar el control de este proceso, puede emplear la práctica de crear parámetros para todos los datos y módulos que utiliza la secuencia de comandos. El ejemplo de secuencia de comandos que aparece a continuación muestra idea (todos los datos de proyecto y módulos se convierten en parámetros que se incorporan en la secuencia de comandos.

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

Cuando la secuencia de comandos utiliza parámetros para todos sus datos como se muestra arriba, tienen lugar diversos beneficios:

• Usted es más conscientes de los datos que la secuencia de comandos necesita, puesto que al ser un parámetro, usted puede verlo en el cuadro de diálogo de la herramienta. No es necesario editar el código para determinar qué datos está utilizando.
• La lógica de validación de la herramienta interna se hace cargo: si el el valor de parámetro hace referencia a datos que no existen, el cuadro de diálogo de la herramienta mostrará un error y no se podrá ejecutar la herramienta para crear un resultado.
• Para restablecer la ubicación de los datos, puede buscar la ubicación mediante el cuadro de diálogo de la herramienta en lugar de introducir la ubicación de la secuencia de comandos (que es propenso a errores).
• Cuando el resultado se comparte como un servicio, el Editor de servicio establecerá los parámetros de la carpeta en Modo de entrada de Constante; su cliente nunca ve los parámetros. Cuando publica, los dos carpetas se copiará en el servidor (si no están registradas con el almacenamiento de datos). Cuando se ejecuta la tarea en el servidor, su secuencia de comandos recibirá las rutas de acceso a la copia carpetas.

Módulos de otros fabricantes

Los módulos de terceros (cualquier módulo que no es parte del núcleo de instalación de Python) no se consolidan. Es necesario garantizar que el módulo existe y se ejecuta correctamente en el servidor. Esto no se aplica a los módulos numpy o bien, matplotlib que están instalados en ArcGIS for Server.

Introducción a Python, ArcPy y las herramientas de secuencia de comandos

Si no está familiarizado con Python, Arcpy y las herramientas de secuencia de comandos, la tabla a continuación enumera algunos temas que le ayudarán a empezar.