Este documento presenta conceptos que son esenciales para entender cómo se crean los add-ins con Python.
Asistente de add-in de Python
Para simplificar el desarrollo de add-ins, se recomienda utilizar el Asistente de add-ins de Python para declarar el tipo de personalización. El Asistente de add-ins de Python reduce el tiempo de desarrollo y posibles errores, puesto que crea los archivos y carpetas necesarios para que el add-in funcione.
Descargue el Asistente de add-ins de Python.
La descarga consiste en un archivo comprimido ZIP (.zip) con todos los archivos necesarios para admitir el asistente. Para usar el asistente, descomprima el contenido en una carpeta y localice el archivo ejecutable denominado addin_assistant.exe en la carpeta bin; haga doble clic en este ejecutable para iniciar el asistente. A continuación, se ofrecen ejemplos de uso del Asistente de add-ins de Python en los temas para crear un add-in.
Estructura de archivos y carpetas
Un add-in es un conjunto de archivos y carpetas empaquetados de forma práctica en un archivo comprimido con la extensión .esriaddin para que tanto los usuarios como la Utilidad para la instalación de add-ins de Esri ArcGIS los identifiquen con facilidad. Por ejemplo, si hace doble clic en un add-in en el Explorador de Windows, en una página Web o en un mensaje de correo electrónico, la utilidad de instalación de add-in instala automáticamente el add-in en su equipo implementándolo en una carpeta conocida.
Los add-ins tienen un archivo config.xml ubicado en el nivel raíz del archivo de add-ins. Este archivo describe al add-in e indica su personalización. El Asistente de add-ins de Python lo crea cuando hace clic en el botón Guardar e incluye toda la información que describe el add-in, como el producto de ArcGIS, títulos, información sobre herramientas, información de ayuda, imágenes y detalles de diseño.
Los add-in también tienen una carpeta de instalación. La finalidad principal de la carpeta de instalación es almacenar el script de Python (la parte activa) del add-in. Por ejemplo, se declara un botón en el archivo de configuración, pero su comportamiento propio se define en el script de Python asociado.
Puede crear carpetas y archivos adicionales en la carpeta de instalación. Resulta útil cuando desea enviar datos como parte de su add-in. Los datos incluyen elementos como archivos de capa, cajas de herramientas y archivos .xml. Para acceder a los datos que se encuentran dentro de la ubicación de instalación, puede sacar partido de la función integrada __file__. Este ejemplo muestra cómo acceder a un archivo de capas de la carpeta de datos ubicada en la carpeta de instalación:
eq_layer = os.path.join(os.path.dirname(__file__), r'data\earth_quakes.lyr')
La mayoría de los tipos de add-in indicados tienen gráficos asociados con ellos. Todos los gráficos introducidos mediante el asistente serán referenciados en el archivo de configuración y se copiarán en la carpeta de imágenes del nivel raíz del archivo.
Este gráfico muestra la estructura de archivos y carpetas de un archivo de add-in (.esriaddin):
makeaddin.py
El archivo de Python makeaddin.py es un script de utilidades creado por el Asistente de add-ins de Python y se usa para empaquetar los archivos y carpetas de la carpeta del proyecto en el archivo de add-in comprimido. Haga doble clic en el archivo para crear el archivo de add-in. Cada vez que efectúe cambios en el add-in, debe ejecutar esta secuencia de comandos para reempaquetar el archivo de add-in con las últimas actualizaciones.
Ubicaciones de carpetas conocidas
Los add-ins se descubren automáticamente cuando se inicia ArcGIS Desktop en una carpeta conocida de una versión por usuario o por escritorio. Por ejemplo:
- Vista/7: C:\Usuarios\<nombre de usuario>\Documentos\ArcGIS\AddIns\Desktop10.1
- XP: C:\Documents and Settings\<nombre de usuario>\Mis documentos\ArcGIS\AddIns\Desktop10.1
Los add-ins se agregan automáticamente y se eliminan con la Utilidad para la instalación de add-ins de Esri ArcGIS y el cuadro de diálogo Administrador de add-ins. El cuadro de diálogo Administrador de add-ins dentro de ArcGIS Desktop también permite agregar sus propias carpetas conocidas, que pueden ser recursos compartidos de red.
Además, los add-in descomprimen automáticamente el contenido de su carpeta de instalación en una carpeta temporal. Por ejemplo:
- Vista/7: C:\Usuarios\<nombre de usuario>\AppData\Local\ESRI\Desktop10.1\AssemblyCache
- XP: C:\Documents and Settings\<nombre de usuario>\Configuración local\Datos de programa\ESRI\Desktop10.1\AssemblyCache
Estos datos son eliminados automáticamente por el marco de add-in cuando este detecta que el add-in ya no está instalado en el sistema.